|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface QueryDefinitionAPI
Getters on the workflow definition data for:
QueryRuntimeAPI
interface.
Hook
Method Summary | |
---|---|
DataFieldDefinition |
getActivityDataField(ActivityDefinitionUUID activityDefinitionUUID,
java.lang.String dataFieldId)
Returns the DataField definition that has been defined as local to the given activity. |
java.util.Set<DataFieldDefinition> |
getActivityDataFields(ActivityDefinitionUUID activityDefinitionUUID)
Returns the set of dataField definitions that have been defined as local to the given activity for the given activityDefinition UUID. |
ProcessDefinition |
getLastProcess(java.lang.String processId)
Return process definition of the last deployed process for the specified package id and process id. |
ProcessDefinition |
getProcess(ProcessDefinitionUUID processDefinitionUUID)
Returns the process definition for the specified processDefinition UUID. |
ProcessDefinition |
getProcess(java.lang.String processId,
java.lang.String processVersion)
Return the process definition for the specified processId and process version. |
java.util.Set<ActivityDefinition> |
getProcessActivities(ProcessDefinitionUUID processDefinitionUUID)
Returns the set of definitions for process activities of the specified processDefinition UUID. |
ActivityDefinition |
getProcessActivity(ProcessDefinitionUUID processDefinitionUUID,
java.lang.String activityId)
Returns the definition for process activity of the specified process and activity Id. |
ActivityDefinitionUUID |
getProcessActivityId(ProcessDefinitionUUID processDefinitionUUID,
java.lang.String activityName)
Returns the activity Id for the specified processDefinition UUID and activity name. |
DataFieldDefinition |
getProcessDataField(ProcessDefinitionUUID processDefinitionUUID,
java.lang.String dataFieldId)
Returns the DataField definition defined within the specified processDefinition UUID for the given dataField Id |
java.util.Set<DataFieldDefinition> |
getProcessDataFields(ProcessDefinitionUUID processDefinitionUUID)
Returns the set of dataField definitions defined within the given processDefinition UUID. |
java.util.Set<ProcessDefinition> |
getProcesses()
Returns the set of definition information of all deployed processes. |
java.util.Set<ProcessDefinition> |
getProcesses(ProcessDefinition.ProcessState processState)
Returns the set of definition informations for the processes with the specified process state. |
java.util.Set<ProcessDefinition> |
getProcesses(java.lang.String processId)
Returns the set of definition informations for the process with the specified process id as specified in xpdl files. |
java.util.Set<ProcessDefinition> |
getProcesses(java.lang.String processId,
ProcessDefinition.ProcessState processState)
Returns the set of definition informations for the processes with the specified processId and process state. |
java.lang.String |
getProcessMetaData(ProcessDefinitionUUID uuid,
java.lang.String key)
Obtains the value of a process meta data. |
ParticipantDefinition |
getProcessParticipant(ProcessDefinitionUUID processDefinitionUUID,
java.lang.String participantId)
Returns the participant definition for the specified processDefinition UUID and participant Id. |
ParticipantDefinitionUUID |
getProcessParticipantId(ProcessDefinitionUUID processDefinitionUUID,
java.lang.String participantName)
Returns the participantDefinition UUID for the specified processDefinition UUID and participant name. |
java.util.Set<ParticipantDefinition> |
getProcessParticipants(ProcessDefinitionUUID processDefinitionUUID)
Returns the set of participant definitions for the specified processDefinition UUID. |
Method Detail |
---|
java.util.Set<ProcessDefinition> getProcesses()
BonitaInternalException
- if an exception occurs.java.util.Set<ProcessDefinition> getProcesses(java.lang.String processId)
BonitaInternalException
- if an exception occurs.ProcessDefinition getProcess(ProcessDefinitionUUID processDefinitionUUID) throws ProcessNotFoundException
processDefinitionUUID
- the process UUID.
ProcessNotFoundException
- if the process with the given UUID does not exist.
BonitaInternalException
- if an exception occurs.ProcessDefinition getProcess(java.lang.String processId, java.lang.String processVersion) throws ProcessNotFoundException
processId
- the processId.processVersion
- the process version.
ProcessNotFoundException
- if the process with the given parameters does not exist.
BonitaInternalException
- if an exception occurs.java.util.Set<ProcessDefinition> getProcesses(ProcessDefinition.ProcessState processState)
processState
- the state
of the process.
BonitaInternalException
- if an exception occurs.java.util.Set<ProcessDefinition> getProcesses(java.lang.String processId, ProcessDefinition.ProcessState processState)
processId
- the Id of the process.processState
- the state
of the process.
BonitaInternalException
- if an exception occurs.java.util.Set<DataFieldDefinition> getProcessDataFields(ProcessDefinitionUUID processDefinitionUUID) throws ProcessNotFoundException
processDefinitionUUID
- the processDefinition UUID.
ProcessNotFoundException
- if no process exists with the given processDefinition UUID.
BonitaInternalException
- if an exception occurs.DataFieldDefinition getProcessDataField(ProcessDefinitionUUID processDefinitionUUID, java.lang.String dataFieldId) throws ProcessNotFoundException, DataFieldNotFoundException
processDefinitionUUID
- the processDefinition UUID.dataFieldId
- the dataField id as specified in the XPDL file.
ProcessNotFoundException
- if the process with the given processDefinition UUID does not exist.
DataFieldNotFoundException
- if the dataField does not exist in process.
BonitaInternalException
- if an exception occurs.java.util.Set<ParticipantDefinition> getProcessParticipants(ProcessDefinitionUUID processDefinitionUUID) throws ProcessNotFoundException
processDefinitionUUID
- the processDefinition UUID.
ProcessNotFoundException
- if no process exists with the given processDefinition UUID.
BonitaInternalException
- if an exception occurs.ParticipantDefinition getProcessParticipant(ProcessDefinitionUUID processDefinitionUUID, java.lang.String participantId) throws ProcessNotFoundException, ParticipantNotFoundException
processDefinitionUUID
- the processDefinition UUID.participantId
- the participant id as specified in the XPDL file.
ProcessNotFoundException
- if the process with the given processDefinition UUID does not exist.
ParticipantNotFoundException
- if the participant does not exist in process.
BonitaInternalException
- if an exception occurs.java.util.Set<ActivityDefinition> getProcessActivities(ProcessDefinitionUUID processDefinitionUUID) throws ProcessNotFoundException
processDefinitionUUID
- the process UUID.
ProcessNotFoundException
- if the process with the given processDefinition UUID does not exist.
BonitaInternalException
- if an exception occurs.ActivityDefinition getProcessActivity(ProcessDefinitionUUID processDefinitionUUID, java.lang.String activityId) throws ProcessNotFoundException, ActivityNotFoundException
processDefinitionUUID
- the process UUID.activityId
- the activity id as specified in the XPDL file.
ProcessNotFoundException
- if the process with the given UUID does not exist.
ActivityNotFoundException
- if the activity with the given id does not exist in the process.
BonitaInternalException
- if an exception occurs.DataFieldDefinition getActivityDataField(ActivityDefinitionUUID activityDefinitionUUID, java.lang.String dataFieldId) throws ActivityDefNotFoundException, DataFieldNotFoundException
activityDefinitionUUID
- the ActivityDefinition UUID.dataFieldId
- the dataField id as specified in the XPDL file.
ActivityNotFoundException
- if the activity with the given activityDefinition UUID does not exist.
DataFieldNotFoundException
- if the dataField does not exist within the activity.
BonitaInternalException
- if an exception occurs.
ActivityDefNotFoundException
java.util.Set<DataFieldDefinition> getActivityDataFields(ActivityDefinitionUUID activityDefinitionUUID) throws ActivityDefNotFoundException
activityDefinitionUUID
- the activityDefinition UUID.
ActivityDefNotFoundException
- if no activity exists with the given activityDefinition UUID.
BonitaInternalException
- if an exception occurs.ActivityDefinitionUUID getProcessActivityId(ProcessDefinitionUUID processDefinitionUUID, java.lang.String activityName) throws ProcessNotFoundException
processDefinitionUUID
- the process UUID.activityName
- the activity name as specified in the XPDL file
(value of Name attribute within the Activity element).
ProcessNotFoundException
- if the process with the given UUID does not exist.
BonitaInternalException
- if an exception occurs.ParticipantDefinitionUUID getProcessParticipantId(ProcessDefinitionUUID processDefinitionUUID, java.lang.String participantName) throws ProcessNotFoundException
processDefinitionUUID
- the processDefinition UUID.participantName
- the participant name as specified in the XPDL file.
ProcessNotFoundException
- if the process with the given UUID does not exist
BonitaInternalException
- if an exception occurs.ProcessDefinition getLastProcess(java.lang.String processId) throws ProcessNotFoundException
packageId
- the package id as specified in the XPDL file.processId
- the process id as specified in the XPDL file.
ProcessNotFoundException
- if the process with the given package id and process id does not exist.
BonitaInternalException
- if an exception occurs.java.lang.String getProcessMetaData(ProcessDefinitionUUID uuid, java.lang.String key) throws ProcessNotFoundException
uuid
- the process definition UUIDkey
- the key of the meta data
ProcessNotFoundException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |