|
||||||||||
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. |
PackageDefinition |
getLastPackage(java.lang.String packageId)
Returns the last deployed package for the specified package id. |
ProcessDefinition |
getLastProcess(java.lang.String packageId,
java.lang.String processId)
Return process definition of the last deployed process for the specified package id and process id. |
PackageDefinition |
getPackage(PackageDefinitionUUID packageDefinitionUUID)
Returns the package definition for the specified packageDefintion UUID. |
PackageDefinition |
getPackage(java.lang.String packageId,
java.lang.String version)
Returns the package definition for the specified package id and package version. |
ProcessDefinition |
getPackageProcess(PackageDefinitionUUID packageDefinitionUUID,
java.lang.String processId)
Returns the process definition for the specified packageDefinition UUID and process Id. |
java.util.Set<ProcessDefinition> |
getPackageProcesses(PackageDefinitionUUID packageDefinitionUUID)
Returns the set of definition information of all processes within the specified deployed package. |
java.util.Set<ProcessDefinition> |
getPackageProcesses(java.lang.String packageId,
java.lang.String processId)
Returns the set of definition informations for the process with the specified process id as specified in the xpdl file. |
java.util.Set<PackageDefinition> |
getPackages()
Returns the set of definition informations for all packages that have ever been deployed. |
java.util.Set<PackageDefinition> |
getPackages(PackageDefinition.PackageState state)
Returns the set of definition informations for all packages having the given state. |
java.util.Set<PackageDefinition> |
getPackages(java.lang.String packageId)
Returns the set of definition informations on all versions of packages with the specified package Id that have ever been deployed. |
java.util.Set<PackageDefinition> |
getPackages(java.lang.String packageId,
PackageDefinition.PackageState state)
Returns the set of definition informations for packages with the given state and the given package Id. |
ProcessDefinition |
getProcess(ProcessDefinitionUUID processDefinitionUUID)
Returns the process definition for the specified processDefinition UUID. |
ProcessDefinition |
getProcess(java.lang.String packageId,
java.lang.String processId,
java.lang.String processVersion)
Return the process definition for the specified packageId, 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.util.Set<ProcessDefinition> |
getProcesses(java.lang.String processId,
java.lang.String processVersion)
Returns the set of the process definition for the specified processId and process version. |
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<PackageDefinition> getPackages()
getPackages
in interface RemoteQueryDefinitionAPI
BonitaInternalException
- if an exception occurs.java.util.Set<PackageDefinition> getPackages(java.lang.String packageId)
getPackages
in interface RemoteQueryDefinitionAPI
packageId
- the package Id (as specified in the XPDL file).
BonitaInternalException
- if an exception occurs.PackageDefinition getPackage(PackageDefinitionUUID packageDefinitionUUID) throws PackageNotFoundException
getPackage
in interface RemoteQueryDefinitionAPI
packageDefinitionUUID
- the package processDefinitionUUID.
PackageNotFoundException
- if package does not exist
BonitaInternalException
- if an exception occurs.PackageDefinition getPackage(java.lang.String packageId, java.lang.String version) throws PackageNotFoundException
getPackage
in interface RemoteQueryDefinitionAPI
processId
- the package id.version
- the package version
ProcessNotFoundException
- if the package does not exist
BonitaInternalException
- if an exception occurs.
PackageNotFoundException
java.util.Set<PackageDefinition> getPackages(PackageDefinition.PackageState state)
getPackages
in interface RemoteQueryDefinitionAPI
state
- the state of the package.
BonitaInternalException
- if an exception occurs.java.util.Set<PackageDefinition> getPackages(java.lang.String packageId, PackageDefinition.PackageState state) throws PackageNotFoundException
getPackages
in interface RemoteQueryDefinitionAPI
state
- the state of the package.packageId
- the package Id.
PackageNotFoundException
- if package does not exist.
BonitaInternalException
- if an exception occurs.java.util.Set<ProcessDefinition> getPackageProcesses(PackageDefinitionUUID packageDefinitionUUID) throws PackageNotFoundException
getPackageProcesses
in interface RemoteQueryDefinitionAPI
packageDefinitionUUID
- the packageDefinition UUID.
PackageNotFoundException
- if package does not exist.
BonitaInternalException
- if an exception occurs.ProcessDefinition getPackageProcess(PackageDefinitionUUID packageDefinitionUUID, java.lang.String processId) throws PackageNotFoundException, ProcessNotFoundException
getPackageProcess
in interface RemoteQueryDefinitionAPI
packageDefinitionUUID
- the UUID of the packageDefinition
processId
- the process Id.
PackageNotFoundException
- if package does not exist
ProcessNotFoundException
- if process with id processId does not exist in package
BonitaInternalException
- if an exception occurs.java.util.Set<ProcessDefinition> getProcesses()
getProcesses
in interface RemoteQueryDefinitionAPI
BonitaInternalException
- if an exception occurs.java.util.Set<ProcessDefinition> getPackageProcesses(java.lang.String packageId, java.lang.String processId)
getPackageProcesses
in interface RemoteQueryDefinitionAPI
BonitaInternalException
- if an exception occurs.java.util.Set<ProcessDefinition> getProcesses(java.lang.String processId)
getProcesses
in interface RemoteQueryDefinitionAPI
BonitaInternalException
- if an exception occurs.ProcessDefinition getProcess(ProcessDefinitionUUID processDefinitionUUID) throws ProcessNotFoundException
getProcess
in interface RemoteQueryDefinitionAPI
processDefinitionUUID
- the process UUID.
ProcessNotFoundException
- if the process with the given UUID does not exist.
BonitaInternalException
- if an exception occurs.java.util.Set<ProcessDefinition> getProcesses(java.lang.String processId, java.lang.String processVersion)
getProcesses
in interface RemoteQueryDefinitionAPI
processId
- the process id.processVersion
- the process version.
BonitaInternalException
- if an exception occurs.ProcessDefinition getProcess(java.lang.String packageId, java.lang.String processId, java.lang.String processVersion) throws ProcessNotFoundException
getProcess
in interface RemoteQueryDefinitionAPI
packageId
- the packageId.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)
getProcesses
in interface RemoteQueryDefinitionAPI
processState
- the state
of the process.
BonitaInternalException
- if an exception occurs.java.util.Set<ProcessDefinition> getProcesses(java.lang.String processId, ProcessDefinition.ProcessState processState)
getProcesses
in interface RemoteQueryDefinitionAPI
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
getProcessDataFields
in interface RemoteQueryDefinitionAPI
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
getProcessDataField
in interface RemoteQueryDefinitionAPI
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
getProcessParticipants
in interface RemoteQueryDefinitionAPI
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
getProcessParticipant
in interface RemoteQueryDefinitionAPI
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
getProcessActivities
in interface RemoteQueryDefinitionAPI
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
getProcessActivity
in interface RemoteQueryDefinitionAPI
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
getActivityDataField
in interface RemoteQueryDefinitionAPI
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
getActivityDataFields
in interface RemoteQueryDefinitionAPI
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
getProcessActivityId
in interface RemoteQueryDefinitionAPI
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
getProcessParticipantId
in interface RemoteQueryDefinitionAPI
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.PackageDefinition getLastPackage(java.lang.String packageId) throws PackageNotFoundException
getLastPackage
in interface RemoteQueryDefinitionAPI
packageId
- the package id as specified in the XPDL file.
PackageNotFoundException
- if the package with the given id does not exist
BonitaInternalException
- if an exception occurs.ProcessDefinition getLastProcess(java.lang.String packageId, java.lang.String processId) throws ProcessNotFoundException
getLastProcess
in interface RemoteQueryDefinitionAPI
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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |