oracle.bpm.services.instancemanagement.model
Interface IInstanceContextConfiguration

All Superinterfaces:

java.io.Serializable

public interface IInstanceContextConfiguration
extends java.io.Serializable

An IInstanceContextConfiguration implementation provides the way to specify which process instances details, such as process and project data objects, open activities, etc., will be retrieved in the response of a Migration or Grab context creation.

In order to create an instance, the following idiom should be used:

     InstanceContextConfiguration.Builder builder
                                 = new InstanceContextConfiguration.Builder();

     // specify which process instance details
     // should be included in the response
     builder.includeOpenActivities().includeProjectDataObjects();
     builder.includeProcessDataObjects();

     final IInstanceContextConfiguration configuration = builder.build();
  

See Also:

IInstanceQueryService, IGrabInstanceContext, InstanceContextConfiguration.Builder

Method Summary

java.lang.Boolean	includeActivityInstanceAttributes() Returns true if the configuration specifies to include IVariableItem objects representing activity attributes of a process instance.
java.lang.Boolean	includeChildren() Returns true if the configuration specifies to include IGrabInstanceContext children objects.
java.lang.Boolean	includeCorrelationKeys() Returns true if the configuration specifies to include ICorrelationKeyItem objects representing process instance correlation keys.
java.lang.Boolean	includeLargeDocuments()
java.lang.Boolean	includeOpenActivities() Returns true if the configuration specifies to include IOpenActivityInfo objects representing open activities of a process instance.
java.lang.Boolean	includeOpenActivityContainers() Returns true if the configuration specifies to include IOpenActivityInfo objects representing container open activities of a process instance, such as BPMN sub-process activities.
java.lang.Boolean	includeProcessDataObjects() Returns true if the configuration specifies to include IVariableItem objects representing process data objects.
java.lang.Boolean	includeProcessInstanceAttributes() Returns true if the configuration specifies to include IVariableItem objects representing process instance attributes.
java.lang.Boolean	includeProjectDataObjects() Returns true if the configuration specifies to include IVariableItem objects representing project data objects.

Method Detail

includeProcessDataObjects

java.lang.Boolean includeProcessDataObjects()

Returns true if the configuration specifies to include IVariableItem objects representing process data objects.

Returns:

true if the configuration specifies to include IVariableItem objects representing process data objects.

includeProjectDataObjects

java.lang.Boolean includeProjectDataObjects()

Returns true if the configuration specifies to include IVariableItem objects representing project data objects.

Returns:

true if the configuration specifies to include IVariableItem objects representing project data objects.

includeCorrelationKeys

java.lang.Boolean includeCorrelationKeys()

Returns true if the configuration specifies to include ICorrelationKeyItem objects representing process instance correlation keys.

Returns:

true if the configuration specifies to include ICorrelationKeyItem objects representing process instance correlation keys.

includeProcessInstanceAttributes

java.lang.Boolean includeProcessInstanceAttributes()

Returns true if the configuration specifies to include IVariableItem objects representing process instance attributes.

Returns:

true if the configuration specifies to include IVariableItem objects representing process instance attributes.

includeOpenActivities

java.lang.Boolean includeOpenActivities()

Returns true if the configuration specifies to include IOpenActivityInfo objects representing open activities of a process instance.

Returns:

true if the configuration specifies to include IOpenActivityInfo objects representing open activities of a process instance.

includeChildren

java.lang.Boolean includeChildren()

Returns true if the configuration specifies to include IGrabInstanceContext children objects.

Returns:

true if the configuration specifies to include IGrabInstanceContext children objects.

includeActivityInstanceAttributes

java.lang.Boolean includeActivityInstanceAttributes()

Returns true if the configuration specifies to include IVariableItem objects representing activity attributes of a process instance.

Returns:

true if the configuration specifies to include IVariableItem objects representing activity attributes of a process instance.

includeOpenActivityContainers

java.lang.Boolean includeOpenActivityContainers()

Returns true if the configuration specifies to include IOpenActivityInfo objects representing container open activities of a process instance, such as BPMN sub-process activities.

Returns:

true if the configuration specifies to include IOpenActivityInfo objects representing container open activities of a process instance, such as BPMN sub-process activities.

includeLargeDocuments

java.lang.Boolean includeLargeDocuments()