Package ch.ivyteam.ivy.workflow
Interface IIntermediateEventElement
public interface IIntermediateEventElement
Intermediate event element
- Since:
- 30.01.2008
- API:
- This is a public API.
-
Method Summary
Modifier and TypeMethodDescriptionfindIntermediateEvents
(IPropertyFilter<IntermediateEventProperty> filter, List<PropertyOrder<IntermediateEventProperty>> order, int startIndex, int count, boolean returnAllCount) Gets the intermediate events that were created by this intermediate event elementReturns the descriptionlong
getId()
Deprecated, for removal: This API element is subject to removal in a future version.Gets the class name of the intermediate event bean of the intermediate event elementDeprecated, for removal: This API element is subject to removal in a future version.getName()
Returns the intermediate event element nameGets the process element id of the intermediate event elementGets the process model versionGets the task start of this intermediate event elementboolean
Deprecated, for removal: This API element is subject to removal in a future version.not longer persistent (if engine is restarted, the event bean is started again)void
setIntermediateEventBeanEnabled
(boolean enabled) Deprecated, for removal: This API element is subject to removal in a future version.not longer persistent (if engine is restarted, the event bean is started again)
-
Method Details
-
getIntermediateEventBeanClassName
String getIntermediateEventBeanClassName()Gets the class name of the intermediate event bean of the intermediate event element- Returns:
- intermediate event bean class name
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
- Security:
- SESSION OWNS IntermediateEventElementReadEventBeanClassName PERMISSION OR OWNS IntermediateEventElementReadEventBeanClassName@SYSTEM PERMISSION
-
getIntermediateEventBeanConfiguration
Deprecated, for removal: This API element is subject to removal in a future version.usegetConfiguration()
insteadGets the configuration string for the intermediate event bean of the intermediate event element- Returns:
- configuration string
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
- Security:
- SESSION OWNS IntermediateEventElementReadEventBeanConfiguration PERMISSION OR OWNS IntermediateEventElementReadEventBeanConfiguration@SYSTEM PERMISSION
-
getConfiguration
- API:
- This public API is available in Java.
- Security:
- SESSION OWNS IntermediateEventElementReadEventBeanConfiguration PERMISSION OR OWNS IntermediateEventElementReadEventBeanConfiguration@SYSTEM PERMISSION
-
isIntermediateEventBeanEnabled
Deprecated, for removal: This API element is subject to removal in a future version.not longer persistent (if engine is restarted, the event bean is started again)Is this intermediate event bean enabled to fire- Returns:
- true if it is enabled to start
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
- Security:
- SESSION OWNS IntermediateEventElementReadEventBeanEnabled PERMISSION OR OWNS IntermediateEventElementReadEventBeanEnabled@SYSTEM PERMISSION
-
setIntermediateEventBeanEnabled
Deprecated, for removal: This API element is subject to removal in a future version.not longer persistent (if engine is restarted, the event bean is started again)Sets the enable state of this intermediate event bean.- If given
enabled
isfalse
and the bean is in service stateServiceState.RUNNING
, then the bean is stopped and the service state isServiceState.STOPPED
after this call. - If given
enabled
istrue
, the bean is in service stateServiceState.STOPPED
and theIActivity.getActivityState()
isActivityState.ACTIVE
, then the bean is started and the service state isServiceState.RUNNING
after this call.
- Parameters:
enabled
- true to set enable, false to set disabled- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
- Security:
- SESSION OWNS IntermediateEventElementWriteEventBeanEnabled PERMISSION OR OWNS IntermediateEventElementWriteEventBeanEnabled@SYSTEM PERMISSION
- If given
-
getProcessModelVersion
IWorkflowProcessModelVersion getProcessModelVersion()Gets the process model version- Returns:
- process model version
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
getId
Deprecated, for removal: This API element is subject to removal in a future version.Gets the identifier of the intermediate event element- Returns:
- identifier
- API:
- This public API is available in Java.
-
getProcessElementId
String getProcessElementId()Gets the process element id of the intermediate event element- Returns:
- process element id
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
getTaskStart
ITaskStart getTaskStart()Gets the task start of this intermediate event element- Returns:
- task start of this process start
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
getName
String getName()Returns the intermediate event element name- Returns:
- name of process start
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
getDescription
String getDescription()Returns the description- Returns:
- description
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
findIntermediateEvents
IQueryResult<IIntermediateEvent> findIntermediateEvents(IPropertyFilter<IntermediateEventProperty> filter, List<PropertyOrder<IntermediateEventProperty>> order, int startIndex, int count, boolean returnAllCount) Gets the intermediate events that were created by this intermediate event element- Parameters:
filter
- a filter to filter the returned intermediate events. Maybe null.order
- an order to order the returned intermediate events. Maybe null.startIndex
- the index of the first intermediate events of all intermediate events that is returned in the resultcount
- the number of intermediate events to return in the resultreturnAllCount
- if true the query result methodIQueryResult.getAllCount()
returns the overall intermediate events that have been found, if false it returns -1- Returns:
- a query result with the intermediate events
- Throws:
PersistencyException
- if persistency exception fails- API:
- This public API is available in Java.
- Security:
- SESSION OWNS IntermediateEventReadAll PERMISSION OR OWNS IntermediateEventReadAll@SYSTEM PERMISSION
-
getConfiguration()
instead