|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Provides transactional caching and persistence services for process instances. This includes process instances, workflow relevant data, activity instances, work items; also attributes for process instance, activity instance, and work items.
Field Summary | |
static java.lang.String |
SERVICE_NAME
|
Method Summary | |
ActivityInstance |
createActivityInstance(java.lang.String processDefinitionId,
java.lang.String processInstanceId,
java.lang.String activityDefinitionId,
java.lang.String activityName,
JoinInstance join,
java.lang.String blockActivityInstanceId,
PersistentIterator blockActivityIterator,
int priority,
int state,
java.lang.String[] participants)
Returns the specified activity instance. |
AttributeInstance |
createActivityInstanceAttribute(java.lang.String processInstanceId,
java.lang.String activityInstanceId,
java.lang.String attributeName,
int attributeType,
java.lang.Object attributeValue)
Creates an activity instance attribute. |
ProcessInstance |
createProcessInstance(java.lang.String processDefinitionId,
java.lang.String parentActivityInstanceId,
java.lang.String processInstanceName,
int priority,
int state,
java.util.Date createdDate,
java.util.Date startedDate,
java.lang.String[] participants)
Creates a new process instance for the given process definition. |
AttributeInstance |
createProcessInstanceAttribute(java.lang.String processInstanceId,
java.lang.String attributeName,
int attributeType,
java.lang.Object attributeValue)
Creates a process instance attribute. |
WorkItem |
createWorkItem(java.lang.String processDefinitionId,
java.lang.String processInstanceId,
java.lang.String activityInstanceId,
int toolIndex,
int state,
java.lang.String performer,
java.lang.String participant)
Creates a work item. |
AttributeInstance |
createWorkItemAttribute(java.lang.String processInstanceId,
java.lang.String workItemId,
java.lang.String attributeName,
int attributeType,
java.lang.Object attributeValue)
Creates a work item attribute. |
int |
deleteAuditEntries(WMFilter filter)
Deletes the audit entries matching user specified criteria. |
void |
deleteProcessInstance(java.lang.String processInstanceId)
Permanently deletes the specified process instance. |
ActivityInstance |
findActivityInstance(java.lang.String activityInstanceId)
Reads the specified activity instance. |
ActivityInstance |
findActivityInstance(java.lang.String processInstanceId,
java.lang.String activityDefinitionId,
java.lang.String blockActivityInstanceId)
Reads the specified activity instance. |
AttributeInstance |
findActivityInstanceAttribute(java.lang.String processInstanceId,
java.lang.String activityInstanceId,
java.lang.String attributeName)
Reads the specified activity attribute value. |
AttributeInstance[] |
findActivityInstanceAttributes(java.lang.String processDefinitionId,
java.lang.String processInstanceId,
java.lang.String activityDefinitionId,
java.lang.String activityInstanceId,
WMFilter filter,
java.lang.String attributeName,
boolean countFlag)
Reads a set of activity instance attributes. |
ActivityInstance[] |
findActivityInstances(java.lang.String processDefinitionId,
java.lang.String activityDefinitionId,
WMFilter filter,
boolean countFlag)
Reads a list of activity instances. |
WMAAuditEntry[] |
findAuditEntries(WMFilter filter)
Finds the audit entries matching user specified criteria. |
ProcessInstance |
findProcessInstance(java.lang.String processInstanceId)
Gets the specified process instance. |
AttributeInstance |
findProcessInstanceAttribute(java.lang.String processInstanceId,
java.lang.String attributeName)
Reads the specified process attribute value. |
AttributeInstance[] |
findProcessInstanceAttributes(java.lang.String processDefinitionId,
java.lang.String processInstanceId,
WMFilter filter,
java.lang.String attrName,
boolean countFlag)
Reads a list of process instance attributes. |
ProcessInstance[] |
findProcessInstances(java.lang.String processDefinitionId,
WMFilter filter,
boolean countFlag)
Retrieves a list of process instances. |
WorkItem |
findWorkItem(java.lang.String processInstanceId,
java.lang.String workItemId)
Reads the specified work item. |
AttributeInstance |
findWorkItemAttribute(java.lang.String processInstanceId,
java.lang.String workItemId,
java.lang.String attributeName)
Reads the specified work item attribute value. |
AttributeInstance[] |
findWorkItemAttributes(java.lang.String processInstanceId,
java.lang.String workItemId,
WMFilter filter,
boolean countFlag)
Reads a set of work item attributes. |
WorkItem[] |
findWorkItems(WMFilter filter,
boolean countFlag)
Reads a set of work items. |
void |
purge()
Purges all data from the instance repository. |
Methods inherited from interface org.obe.spi.WorkflowService |
exit, getServiceManager, getServiceName, init |
Field Detail |
public static final java.lang.String SERVICE_NAME
Method Detail |
public void purge() throws RepositoryException
RepositoryException
public ProcessInstance createProcessInstance(java.lang.String processDefinitionId, java.lang.String parentActivityInstanceId, java.lang.String processInstanceName, int priority, int state, java.util.Date createdDate, java.util.Date startedDate, java.lang.String[] participants) throws RepositoryException
processDefinitionId
- The process definition ID.parentActivityInstanceId
- The ID of the parent activity instance,
if any.processInstanceName
- The name of the process instance.priority
- Process instance priority.state
- The instance state, one of the integer values defined in
WMProcessInstanceState
.createdDate
- The creation date/time of the instance.startedDate
- The 'started' date/time for the instance. Should be
null
unless the state
parameter is
WMProcessInstanceState.OPEN_RUNNING
.participants
- The list of process participants.
RepositoryException
- Workflow client exception.public ProcessInstance findProcessInstance(java.lang.String processInstanceId) throws RepositoryException
processInstanceId
- The process instance id
RepositoryException
- Workflow client exceptionpublic ProcessInstance[] findProcessInstances(java.lang.String processDefinitionId, WMFilter filter, boolean countFlag) throws RepositoryException
processDefinitionId
- The process definition Id, can be
null>/code> to select from instances of any process definition.filter
- A Filter specification.
- Returns:
- An array of matching process instances.
- Throws:
RepositoryException
public void deleteProcessInstance(java.lang.String processInstanceId) throws RepositoryException
processInstanceId
- The ID of the process instance to delete.
RepositoryException
public AttributeInstance createProcessInstanceAttribute(java.lang.String processInstanceId, java.lang.String attributeName, int attributeType, java.lang.Object attributeValue) throws RepositoryException
processInstanceId
- The process instance idattributeName
- The attribute nameattributeType
- The attribute typeattributeValue
- The attribute value
RepositoryException
- Workflow client exceptionpublic AttributeInstance findProcessInstanceAttribute(java.lang.String processInstanceId, java.lang.String attributeName) throws RepositoryException
processInstanceId
- The process instance idattributeName
- The attribute name
RepositoryException
- Workflow client exceptionpublic AttributeInstance[] findProcessInstanceAttributes(java.lang.String processDefinitionId, java.lang.String processInstanceId, WMFilter filter, java.lang.String attrName, boolean countFlag) throws RepositoryException
processDefinitionId
- The process definition id, can be
null
.processInstanceId
- The process instance id, can be
null
.filter
- The filter, can be null
.attrName
- The attribute name, can be null
.countFlag
- True to return count value
RepositoryException
- Workflow client exceptionpublic ActivityInstance createActivityInstance(java.lang.String processDefinitionId, java.lang.String processInstanceId, java.lang.String activityDefinitionId, java.lang.String activityName, JoinInstance join, java.lang.String blockActivityInstanceId, PersistentIterator blockActivityIterator, int priority, int state, java.lang.String[] participants) throws RepositoryException
processDefinitionId
- The process definition id.processInstanceId
- The process instance id.activityDefinitionId
- The activity definition id.activityName
- The name of the activity.join
- The activity's join (can be null
).blockActivityInstanceId
- The block activity instance ID, or
null
if the activity is not defined within an activity set.blockActivityIterator
- An iterator for the block activity owned by
the instance (can be null
).priority
- Activity priority.state
- Activity state, one of the integer values defined in
WMActivityInstanceState
.participants
- The list of participants for this activity.
RepositoryException
- Workflow client exception.public ActivityInstance findActivityInstance(java.lang.String activityInstanceId) throws RepositoryException
activityInstanceId
- The activity instance id.
RepositoryException
- Workflow client exception.public ActivityInstance findActivityInstance(java.lang.String processInstanceId, java.lang.String activityDefinitionId, java.lang.String blockActivityInstanceId) throws RepositoryException
processInstanceId
- The process instance id.activityDefinitionId
- The activity definition id.blockActivityInstanceId
- The ID of the block activity instance to
which the activity instance belongs.
RepositoryException
- Workflow client exception.public ActivityInstance[] findActivityInstances(java.lang.String processDefinitionId, java.lang.String activityDefinitionId, WMFilter filter, boolean countFlag) throws RepositoryException
processDefinitionId
- The process definition ID, can be
null
.filter
- A Filter specification.
RepositoryException
public AttributeInstance createActivityInstanceAttribute(java.lang.String processInstanceId, java.lang.String activityInstanceId, java.lang.String attributeName, int attributeType, java.lang.Object attributeValue) throws RepositoryException
processInstanceId
- The process instance idactivityInstanceId
- The activity instance idattributeName
- The attribute nameattributeType
- The attribute typeattributeValue
- The attribute value
RepositoryException
- Workflow client exceptionpublic AttributeInstance findActivityInstanceAttribute(java.lang.String processInstanceId, java.lang.String activityInstanceId, java.lang.String attributeName) throws RepositoryException
processInstanceId
- The process instance id.activityInstanceId
- The activity instance id.attributeName
- The attribute name.
RepositoryException
- Workflow client exception.public AttributeInstance[] findActivityInstanceAttributes(java.lang.String processDefinitionId, java.lang.String processInstanceId, java.lang.String activityDefinitionId, java.lang.String activityInstanceId, WMFilter filter, java.lang.String attributeName, boolean countFlag) throws RepositoryException
processInstanceId
- The ID of the process instance.activityInstanceId
- The ID of the activity instance.filter
- A Filter specification.
RepositoryException
public WorkItem createWorkItem(java.lang.String processDefinitionId, java.lang.String processInstanceId, java.lang.String activityInstanceId, int toolIndex, int state, java.lang.String performer, java.lang.String participant) throws RepositoryException
processDefinitionId
- The process definition id.processInstanceId
- The process instance id.activityInstanceId
- The activity instance id.toolIndex
- The ID of the associated tool.state
- The work item state, one of the integer values defined in
WMWorkItemState
.participant
- The name of the participant to whom the work item is
assigned.
RepositoryException
public WorkItem findWorkItem(java.lang.String processInstanceId, java.lang.String workItemId) throws RepositoryException
processInstanceId
- The process instance id.workItemId
- The work item id.
RepositoryException
- Workflow client exceptionpublic WorkItem[] findWorkItems(WMFilter filter, boolean countFlag) throws RepositoryException
filter
- A Filter specification.
RepositoryException
public AttributeInstance createWorkItemAttribute(java.lang.String processInstanceId, java.lang.String workItemId, java.lang.String attributeName, int attributeType, java.lang.Object attributeValue) throws RepositoryException
processInstanceId
- The process instance idworkItemId
- The work item idattributeName
- The attribute nameattributeType
- The attribute typeattributeValue
- The attribute value
RepositoryException
- Workflow client exceptionpublic AttributeInstance findWorkItemAttribute(java.lang.String processInstanceId, java.lang.String workItemId, java.lang.String attributeName) throws RepositoryException
processInstanceId
- The process instance idworkItemId
- The work item idattributeName
- The attribute name
RepositoryException
- Workflow client exceptionpublic AttributeInstance[] findWorkItemAttributes(java.lang.String processInstanceId, java.lang.String workItemId, WMFilter filter, boolean countFlag) throws RepositoryException
filter
- A Filter specification.
RepositoryException
- Workflow client exceptionpublic WMAAuditEntry[] findAuditEntries(WMFilter filter) throws RepositoryException
filter
- Filter criteria.
RepositoryException
- If the filter type is unsupported.public int deleteAuditEntries(WMFilter filter) throws RepositoryException
filter
- Filter criteria.
RepositoryException
- If the filter type is unsupported.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |