Package ch.ivyteam.ivy.workflow.signal
Interface IBpmSignalReceivers
-
public interface IBpmSignalReceivers
Query Signal receivers.
Signal Starts (IStartSignalEventElement
) or tasks of User Task elements that have attached Signal Boundary Event elements (ITaskBoundarySignalEventReceiver
)- Since:
- 6.1.0
- API:
- This is a public API.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description List<IStartSignalEventElement>
all()
Get all StartSignalEventElements.List<IStartSignalEventElement>
contains(String part)
Get all StartSignalEventElements but filtered for their signalCodePattern containing a given part.StartSignalEventElementQuery
createStartSignalQuery()
Deprecated, for removal: This API element is subject to removal in a future version.This API will be removed with 9.2, please useall()
,matches(SignalCode)
orcontains(String)
instead.TaskBoundarySignalEventReceiverQuery
createTaskBoundaryQuery()
Query for waiting signal boundaries (ITaskBoundarySignalEventReceiver
).List<IStartSignalEventElement>
matches(SignalCode pattern)
Get all StartSignalEventElements but filtered for a given SignalCode pattern.
-
-
-
Method Detail
-
createTaskBoundaryQuery
TaskBoundarySignalEventReceiverQuery createTaskBoundaryQuery()
Query for waiting signal boundaries (
Example: Get waiting signal boundary events whose signal code pattern starts with "admin:quit:%".ITaskBoundarySignalEventReceiver
).
import ch.ivyteam.ivy.workflow.signal.ITaskBoundarySignalEventReceiver; List<ITaskBoundarySignalEventReceiver> signalBoundaries = ivy.wf.signals().receivers().createTaskBoundaryQuery().where().signalCodePattern().isLike("admin:quit:%").executor().results();
- Returns:
- a query that can be executed
- See Also:
ITaskBoundarySignalEventReceiver
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
all
List<IStartSignalEventElement> all()
Get all StartSignalEventElements.- Returns:
- list of all StartSignalEventElements
- Since:
- 8.0.11
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
matches
List<IStartSignalEventElement> matches(SignalCode pattern)
Get all StartSignalEventElements but filtered for a given SignalCode pattern.- Returns:
- a list of StartSignalEventElements
- Since:
- 8.0.11
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
contains
List<IStartSignalEventElement> contains(String part)
Get all StartSignalEventElements but filtered for their signalCodePattern containing a given part.- Returns:
- a list of StartSignalEventElements
- Since:
- 8.0.11
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
createStartSignalQuery
@Deprecated(since="8.0.11", forRemoval=true) StartSignalEventElementQuery createStartSignalQuery()
Deprecated, for removal: This API element is subject to removal in a future version.This API will be removed with 9.2, please useall()
,matches(SignalCode)
orcontains(String)
instead.Query for signal starts (
Example: Get waiting Signal start elements whose signal pattern is equal to "user:created".IStartSignalEventElement
).
import ch.ivyteam.ivy.workflow.signal.IStartSignalEventElement; List<IStartSignalEventElement> signalStarts = ivy.wf.signals().receivers().createStartSignalQuery().where().signalCodePattern().isEqual("user:created").executor().results();
- Returns:
- a query that can be executed
- See Also:
IStartSignalEventElement
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
-