org.eclipse.stardust.engine.api.model
Interface Activity

All Superinterfaces:
EventAware, ModelElement, Serializable

public interface Activity
extends ModelElement, EventAware

The client view of a workflow activity.

An activity is a piece of work, which will be processed by a combination of resource (specified by participant assignment) and/or computer applications (specified by application assignment), forming one logical step in the realization of the process.

Version:
$Revision$
Author:
ubirkemeyer

Nested Class Summary
static class Activity.GatewayType
          Enumeration of gateway types.
 
Method Summary
 List<ApplicationContext> getAllApplicationContexts()
          Gets all interactive application contexts available for this activity.
 Set<QualityAssuranceCode> getAllQualityAssuranceCodes()
          Returns a set of defined QA codes which can be used during QA performed on activity instances for that activity.
 Application getApplication()
          Gets the noninteractive application executed by this activity, if any
 ApplicationContext getApplicationContext(String id)
          Gets the specified application context.
 ModelParticipant getDefaultPerformer()
          Gets the participant assigned as a performer to the activity in the workflow model.
 String getDefaultPerformerID()
          Deprecated. Superseded by getDefaultPerformer(). The old behavior was to silently resolve conditional performers if possible and return the ID of the resolved participant. Migration to the new API probably requires testing for ConditionalPerformer and a call to ConditionalPerformer.getResolvedPerformer() instead.
 String getDefaultPerformerName()
          Deprecated. Superseded by getDefaultPerformer(). The old behavior was to silently resolve conditional performers if possible and return the name of the resolved participant. Migration to the new API probably requires testing for ConditionalPerformer and a call to ConditionalPerformer.getResolvedPerformer() instead.
 int getDefaultQualityAssuranceProbability()
          Returns the quality assurance probability.
 String getImplementationProcessDefinitionId()
          Gets the id of the process definition this activity will start as subprocess.
 ImplementationType getImplementationType()
          Gets the implementation type of this activity.
 Activity.GatewayType getJoinType()
          Gets the flow join type for this activity.
 String getProcessDefinitionId()
          Gets the id of the process definition containing this activity.
 String getQualifiedImplementationProcessDefinitionId()
          Gets the qualified id of the process definition this activity will start as subprocess.
 String getQualityAssuranceFormula()
          Returns the quality assurance formula, written in script language (e.g.
 ModelParticipant getQualityAssurancePerformer()
          Returns the currently assigned quality assurance performer.
 org.eclipse.stardust.engine.api.model.Reference getReference()
          Retrieves a reference to an external application or process definition.
 long getRuntimeElementOID()
          Gets the runtime OID of the model element.
 Activity.GatewayType getSplitType()
          Gets the flow split type for this activity.
 boolean isAbortable()
          Checks if this activity can be aborted.
 boolean isInteractive()
          Checks if this activity is interactive.
 boolean isQualityAssuranceEnabled()
          Returns true is quality assurance is enabled for this activity.
 
Methods inherited from interface org.eclipse.stardust.engine.api.model.ModelElement
getAllAttributes, getAttribute, getDescription, getElementOID, getId, getModelOID, getName, getNamespace, getPartitionId, getPartitionOID, getQualifiedId
 
Methods inherited from interface org.eclipse.stardust.engine.api.model.EventAware
getAllEventHandlers, getEventHandler
 

Method Detail

getJoinType

Activity.GatewayType getJoinType()
Gets the flow join type for this activity.

Null if there is no join.


getSplitType

Activity.GatewayType getSplitType()
Gets the flow split type for this activity.

Null if there is no split.


isQualityAssuranceEnabled

boolean isQualityAssuranceEnabled()
Returns true is quality assurance is enabled for this activity.


getQualityAssurancePerformer

ModelParticipant getQualityAssurancePerformer()
Returns the currently assigned quality assurance performer. Can be null if quality assurance is disabled.


getDefaultQualityAssuranceProbability

int getDefaultQualityAssuranceProbability()
Returns the quality assurance probability.


getQualityAssuranceFormula

String getQualityAssuranceFormula()
Returns the quality assurance formula, written in script language (e.g. java script)


getAllQualityAssuranceCodes

Set<QualityAssuranceCode> getAllQualityAssuranceCodes()
Returns a set of defined QA codes which can be used during QA performed on activity instances for that activity.


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()

getImplementationType

ImplementationType getImplementationType()
Gets the implementation type of this activity.

Returns:
the implementation type.

isAbortable

boolean isAbortable()
Checks if this activity can be aborted.

Returns:
true if the activity can be aborted.

isInteractive

boolean isInteractive()
Checks if this activity is interactive.

Returns:
true if the activity is manual or executes an interactive application.

getProcessDefinitionId

String getProcessDefinitionId()
Gets the id of the process definition containing this activity.

Returns:
the id of the containing process definition.

getApplication

Application getApplication()
Gets the noninteractive application executed by this activity, if any

Returns:
the noninteractive application executed by this activity, or null if there is no application to be executed.

getAllApplicationContexts

List<ApplicationContext> getAllApplicationContexts()
Gets all interactive application contexts available for this activity.

Returns:
a List of ApplicationContext objects.

getApplicationContext

ApplicationContext getApplicationContext(String id)
Gets the specified application context.

Parameters:
id - the ID of the application context (possible IDs include PredefinedConstants.DEFAULT_CONTEXT, PredefinedConstants.ENGINE_CONTEXT and PredefinedConstants.APPLICATION_CONTEXT)
Returns:
the application context or null if no application context with the specified id was found.

getDefaultPerformer

ModelParticipant getDefaultPerformer()
Gets the participant assigned as a performer to the activity in the workflow model.

If the activity is not interactive or no default performer is assigned, null is returned.

Returns:
The default performer as defined in the model.

getDefaultPerformerID

String getDefaultPerformerID()
Deprecated. Superseded by getDefaultPerformer(). The old behavior was to silently resolve conditional performers if possible and return the ID of the resolved participant. Migration to the new API probably requires testing for ConditionalPerformer and a call to ConditionalPerformer.getResolvedPerformer() instead.

Gets the ID of the role or organization assigned as a performer to the activity in the workflow model.

If no performer or a conditional performer is assigned, null is returned.


getDefaultPerformerName

String getDefaultPerformerName()
Deprecated. Superseded by getDefaultPerformer(). The old behavior was to silently resolve conditional performers if possible and return the name of the resolved participant. Migration to the new API probably requires testing for ConditionalPerformer and a call to ConditionalPerformer.getResolvedPerformer() instead.

Gets the name of the role or organization assigned as a performer to the activity in the workflow model.

If no performer or a conditional performer is assigned, null is returned.


getReference

org.eclipse.stardust.engine.api.model.Reference getReference()
Retrieves a reference to an external application or process definition.

Returns:
the reference

getImplementationProcessDefinitionId

String getImplementationProcessDefinitionId()
Gets the id of the process definition this activity will start as subprocess.

Returns:
the id of the process definition

getQualifiedImplementationProcessDefinitionId

String getQualifiedImplementationProcessDefinitionId()
Gets the qualified id of the process definition this activity will start as subprocess.

Returns:
the qualified id of the process definition in the form '{}'


Copyright © 2017 Eclipse Stardust. All Rights Reserved.