org.eclipse.stardust.engine.api.model

Interface Trigger

All Superinterfaces:

ModelElement, Serializable

public interface Trigger
extends ModelElement

A client side view of a process trigger.

A trigger is responsible for starting the process instance corresponding to the process definition containing the trigger.

Version:

$Revision$

Author:

ubirkemeyer

Method Summary

Methods

Modifier and Type	Method and Description
AccessPoint	getAccessPoint(String id) Gets an AccessPointBean with the specified name.
List<AccessPoint>	getAllAccessPoints() Gets all access points for the trigger.
Map	getAllAttributes() Gets all the attributes defined for the trigger.
List<ParameterMapping>	getAllParameterMappings() Gets all parameter mappings for the trigger.
ProcessDefinition	getProcessDefinition() Gets the process definition containing this trigger.
long	getRuntimeElementOID() Gets the runtime OID of the model element.
String	getType() Gets the type of trigger.
boolean	isSynchronous() Gets whether the trigger is synchronous or asynchronous.

Methods inherited from interface org.eclipse.stardust.engine.api.model.ModelElement

getAttribute, getDescription, getElementOID, getId, getModelOID, getName, getNamespace, getPartitionId, getPartitionOID, getQualifiedId

Method Detail

getRuntimeElementOID

long getRuntimeElementOID()

Gets the runtime OID of the model element.

Contrary to the element OID, runtime element OIDs are guaranteed to be stable over model versions for model elements of same type and identical fully qualified IDs.

The fully qualified ID of a model element consists of the concatenation of the fully qualified element ID of its parent element, if existent, and the element ID.

Returns:

the runtime model element OID

See Also:

ModelElement.getElementOID()

getProcessDefinition

ProcessDefinition getProcessDefinition()

Gets the process definition containing this trigger.

Returns:

the triggered process definition

getType

String getType()

Gets the type of trigger.

Returns:

the ID of the trigger type.

isSynchronous

boolean isSynchronous()

Gets whether the trigger is synchronous or asynchronous.

Returns:

true if the triggered process instance is started synchronous.

getAllAttributes

Map getAllAttributes()

Gets all the attributes defined for the trigger.

Specified by:

getAllAttributes in interface ModelElement

Returns:

a Map with all the trigger's attributes.

getAllAccessPoints

List<AccessPoint> getAllAccessPoints()

Gets all access points for the trigger.

Returns:

a List of AccessPoint objects.

getAccessPoint

AccessPoint getAccessPoint(String id)

Gets an AccessPointBean with the specified name.

Parameters:

id - the ID of the access point.

Returns:

the corresponding AccessPoint.

getAllParameterMappings

List<ParameterMapping> getAllParameterMappings()

Gets all parameter mappings for the trigger.

Returns:

a List of ParameterMapping objects.