org.ow2.bonita.facade
Interface QueryDefinitionAPI

public interface QueryDefinitionAPI

Getters on the workflow definition data for:

• packages
• processes
• activities
• participants

As indicated by its prefix: Query, this interface could be seen as complementary to the QueryRuntimeAPI interface.
This interface deals with the static part of the data managed by the wokflow.

Workflow data can be retrieved with both entities ids or names.

See Also:

Hook

Method Summary

org.ow2.bonita.facade.def.majorElement.DataFieldDefinition	getActivityDataField(org.ow2.bonita.facade.uuid.ActivityDefinitionUUID activityDefinitionUUID, java.lang.String dataFieldId) Returns the DataField definition that has been defined as local to the given activity.
java.util.Set<org.ow2.bonita.facade.def.majorElement.DataFieldDefinition>	getActivityDataFields(org.ow2.bonita.facade.uuid.ActivityDefinitionUUID activityDefinitionUUID) Returns the set of dataField definitions that have been defined as local to the given activity for the given activityDefinition UUID.
org.ow2.bonita.facade.def.majorElement.PackageDefinition	getLastPackage(java.lang.String packageId) Returns the last deployed package for the specified package id.
org.ow2.bonita.facade.def.majorElement.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.
org.ow2.bonita.facade.def.majorElement.PackageDefinition	getPackage(org.ow2.bonita.facade.uuid.PackageDefinitionUUID packageDefinitionUUID) Returns the package definition for the specified packageDefintion UUID.
org.ow2.bonita.facade.def.majorElement.PackageDefinition	getPackage(java.lang.String packageId, java.lang.String version) Returns the package definition for the specified package id and package version.
org.ow2.bonita.facade.def.majorElement.ProcessDefinition	getPackageProcess(org.ow2.bonita.facade.uuid.PackageDefinitionUUID packageDefinitionUUID, java.lang.String processId) Returns the process definition for the specified packageDefinition UUID and process Id.
java.util.Set<org.ow2.bonita.facade.def.majorElement.ProcessDefinition>	getPackageProcesses(org.ow2.bonita.facade.uuid.PackageDefinitionUUID packageDefinitionUUID) Returns the set of definition information of all processes within the specified deployed package.
java.util.Set<org.ow2.bonita.facade.def.majorElement.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<org.ow2.bonita.facade.def.majorElement.PackageDefinition>	getPackages() Returns the set of definition informations for all packages that have ever been deployed.
java.util.Set<org.ow2.bonita.facade.def.majorElement.PackageDefinition>	getPackages(org.ow2.bonita.facade.def.majorElement.PackageDefinition.PackageState state) Returns the set of definition informations for all packages having the given state.
java.util.Set<org.ow2.bonita.facade.def.majorElement.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<org.ow2.bonita.facade.def.majorElement.PackageDefinition>	getPackages(java.lang.String packageId, org.ow2.bonita.facade.def.majorElement.PackageDefinition.PackageState state) Returns the set of definition informations for packages with the given state and the given package Id.
org.ow2.bonita.facade.def.majorElement.ProcessDefinition	getProcess(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID) Returns the process definition for the specified processDefinition UUID.
org.ow2.bonita.facade.def.majorElement.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<org.ow2.bonita.facade.def.majorElement.ActivityDefinition>	getProcessActivities(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID) Returns the set of definitions for process activities of the specified processDefinition UUID.
org.ow2.bonita.facade.def.majorElement.ActivityDefinition	getProcessActivity(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID, java.lang.String activityId) Returns the definition for process activity of the specified process and activity Id.
org.ow2.bonita.facade.uuid.ActivityDefinitionUUID	getProcessActivityId(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID, java.lang.String activityName) Returns the activity Id for the specified processDefinition UUID and activity name.
org.ow2.bonita.facade.def.majorElement.DataFieldDefinition	getProcessDataField(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID, java.lang.String dataFieldId) Returns the DataField definition defined within the specified processDefinition UUID for the given dataField Id
java.util.Set<org.ow2.bonita.facade.def.majorElement.DataFieldDefinition>	getProcessDataFields(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID) Returns the set of dataField definitions defined within the given processDefinition UUID.
java.util.Set<org.ow2.bonita.facade.def.majorElement.ProcessDefinition>	getProcesses() Returns the set of definition information of all deployed processes.
java.util.Set<org.ow2.bonita.facade.def.majorElement.ProcessDefinition>	getProcesses(org.ow2.bonita.facade.def.majorElement.ProcessDefinition.ProcessState processState) Returns the set of definition informations for the processes with the specified process state.
java.util.Set<org.ow2.bonita.facade.def.majorElement.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<org.ow2.bonita.facade.def.majorElement.ProcessDefinition>	getProcesses(java.lang.String processId, org.ow2.bonita.facade.def.majorElement.ProcessDefinition.ProcessState processState) Returns the set of definition informations for the processes with the specified processId and process state.
java.util.Set<org.ow2.bonita.facade.def.majorElement.ProcessDefinition>	getProcesses(java.lang.String processId, java.lang.String processVersion) Returns the set of the process definition for the specified processId and process version.
org.ow2.bonita.facade.def.majorElement.ParticipantDefinition	getProcessParticipant(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID, java.lang.String participantId) Returns the participant definition for the specified processDefinition UUID and participant Id.
org.ow2.bonita.facade.uuid.ParticipantDefinitionUUID	getProcessParticipantId(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID, java.lang.String participantName) Returns the participantDefinition UUID for the specified processDefinition UUID and participant name.
java.util.Set<org.ow2.bonita.facade.def.majorElement.ParticipantDefinition>	getProcessParticipants(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID) Returns the set of participant definitions for the specified processDefinition UUID.

Method Detail

getPackages

java.util.Set<org.ow2.bonita.facade.def.majorElement.PackageDefinition> getPackages()

Returns the set of definition informations for all packages that have ever been deployed.

Returns:

a set of PackageDefinition in unspecified order.

Throws:

BonitaInternalException - if an exception occurs.

getPackages

java.util.Set<org.ow2.bonita.facade.def.majorElement.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.

Parameters:

packageId - the package Id (as specified in the XPDL file).

Returns:

a set of PackageDefinition in unspecified order with specified packageId.

Throws:

BonitaInternalException - if an exception occurs.

getPackage

org.ow2.bonita.facade.def.majorElement.PackageDefinition getPackage(org.ow2.bonita.facade.uuid.PackageDefinitionUUID packageDefinitionUUID)
                                                                    throws PackageNotFoundException

Returns the package definition for the specified packageDefintion UUID.

Parameters:

packageDefinitionUUID - the package processDefinitionUUID.

Returns:

a packageDefinition interface for the specified packageDefintion UUID.

Throws:

PackageNotFoundException - if package does not exist

BonitaInternalException - if an exception occurs.

getPackage

org.ow2.bonita.facade.def.majorElement.PackageDefinition getPackage(java.lang.String packageId,
                                                                    java.lang.String version)
                                                                    throws PackageNotFoundException

Returns the package definition for the specified package id and package version.

Parameters:

processId - the package id.

version - the package version

Returns:

the package definition for the specified package id and package version.

Throws:

ProcessNotFoundException - if the package does not exist

BonitaInternalException - if an exception occurs.

PackageNotFoundException

getPackages

java.util.Set<org.ow2.bonita.facade.def.majorElement.PackageDefinition> getPackages(org.ow2.bonita.facade.def.majorElement.PackageDefinition.PackageState state)

Returns the set of definition informations for all packages having the given state.

Parameters:

state - the state of the package.

Returns:

the (unordered) set of PackageDefinition for all packages having the given state.

Throws:

BonitaInternalException - if an exception occurs.

getPackages

java.util.Set<org.ow2.bonita.facade.def.majorElement.PackageDefinition> getPackages(java.lang.String packageId,
                                                                                    org.ow2.bonita.facade.def.majorElement.PackageDefinition.PackageState state)
                                                                                    throws PackageNotFoundException

Returns the set of definition informations for packages with the given state and the given package Id.

Parameters:

state - the state of the package.

packageId - the package Id.

Returns:

a set of PackageDefinition for packages with the given state and the given package Id.

Throws:

PackageNotFoundException - if package does not exist.

BonitaInternalException - if an exception occurs.

getPackageProcesses

java.util.Set<org.ow2.bonita.facade.def.majorElement.ProcessDefinition> getPackageProcesses(org.ow2.bonita.facade.uuid.PackageDefinitionUUID packageDefinitionUUID)
                                                                                            throws PackageNotFoundException

Returns the set of definition information of all processes within the specified deployed package.

Parameters:

packageDefinitionUUID - the packageDefinition UUID.

Returns:

set of ProcessDefinition of all the processes within the specified deployed package.

Throws:

PackageNotFoundException - if package does not exist.

BonitaInternalException - if an exception occurs.

getPackageProcess

org.ow2.bonita.facade.def.majorElement.ProcessDefinition getPackageProcess(org.ow2.bonita.facade.uuid.PackageDefinitionUUID packageDefinitionUUID,
                                                                           java.lang.String processId)
                                                                           throws PackageNotFoundException,
                                                                                  ProcessNotFoundException

Returns the process definition for the specified packageDefinition UUID and process Id.

Parameters:

packageDefinitionUUID - the UUID of the packageDefinition

processId - the process Id.

Returns:

the process definition for the specified packageDefinition UUID and process Id.

Throws:

PackageNotFoundException - if package does not exist

ProcessNotFoundException - if process with id processId does not exist in package

BonitaInternalException - if an exception occurs.

getProcesses

java.util.Set<org.ow2.bonita.facade.def.majorElement.ProcessDefinition> getProcesses()

Returns the set of definition information of all deployed processes.

Returns:

set of ProcessDefinition of all deployed processes.

Throws:

BonitaInternalException - if an exception occurs.

getPackageProcesses

java.util.Set<org.ow2.bonita.facade.def.majorElement.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. These process informations are searched into the current recorded informations and into the archived informations. A process with a given processId could have been deployed and undeployed several times.

Returns:

set of ProcessDefinition of the specified process processId.

Throws:

BonitaInternalException - if an exception occurs.

getProcesses

java.util.Set<org.ow2.bonita.facade.def.majorElement.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. These process informations are searched into the current recorded informations and into the archived informations. A process with a given processId could have been deployed and undeployed several times in different packages.

Returns:

set of ProcessDefinition of the specified process processId.

Throws:

BonitaInternalException - if an exception occurs.

getProcess

org.ow2.bonita.facade.def.majorElement.ProcessDefinition getProcess(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID)
                                                                    throws ProcessNotFoundException

Returns the process definition for the specified processDefinition UUID.

Parameters:

processDefinitionUUID - the process UUID.

Returns:

the ProcessDefinition interface for the specified processDefinition UUID.

Throws:

ProcessNotFoundException - if the process with the given UUID does not exist.

BonitaInternalException - if an exception occurs.

getProcesses

java.util.Set<org.ow2.bonita.facade.def.majorElement.ProcessDefinition> getProcesses(java.lang.String processId,
                                                                                     java.lang.String processVersion)

Returns the set of the process definition for the specified processId and process version.

Parameters:

processId - the process id.

processVersion - the process version.

Returns:

the set of process definition for the specified processId and process version.

Throws:

BonitaInternalException - if an exception occurs.

getProcess

org.ow2.bonita.facade.def.majorElement.ProcessDefinition getProcess(java.lang.String packageId,
                                                                    java.lang.String processId,
                                                                    java.lang.String processVersion)
                                                                    throws ProcessNotFoundException

Return the process definition for the specified packageId, processId and process version.

Parameters:

packageId - the packageId.

processId - the processId.

processVersion - the process version.

Returns:

the process definition for the specified packageId, processId and process version.

Throws:

ProcessNotFoundException - if the process with the given parameters does not exist.

BonitaInternalException - if an exception occurs.

getProcesses

java.util.Set<org.ow2.bonita.facade.def.majorElement.ProcessDefinition> getProcesses(org.ow2.bonita.facade.def.majorElement.ProcessDefinition.ProcessState processState)

Returns the set of definition informations for the processes with the specified process state.

Parameters:

processState - the state of the process.

Returns:

the set of ProcessDefinition for the processes with the specified process state.

Throws:

BonitaInternalException - if an exception occurs.

getProcesses

java.util.Set<org.ow2.bonita.facade.def.majorElement.ProcessDefinition> getProcesses(java.lang.String processId,
                                                                                     org.ow2.bonita.facade.def.majorElement.ProcessDefinition.ProcessState processState)

Returns the set of definition informations for the processes with the specified processId and process state.

Parameters:

processId - the Id of the process.

processState - the state of the process.

Returns:

the set of ProcessDefinition for the processes with the specified processId and process state.

Throws:

BonitaInternalException - if an exception occurs.

getProcessDataFields

java.util.Set<org.ow2.bonita.facade.def.majorElement.DataFieldDefinition> getProcessDataFields(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID)
                                                                                               throws ProcessNotFoundException

Returns the set of dataField definitions defined within the given processDefinition UUID.

Parameters:

processDefinitionUUID - the processDefinition UUID.

Returns:

the set of DataFieldDefinition for the specified processDefinition UUID.

Throws:

ProcessNotFoundException - if no process exists with the given processDefinition UUID.

BonitaInternalException - if an exception occurs.

getProcessDataField

org.ow2.bonita.facade.def.majorElement.DataFieldDefinition getProcessDataField(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID,
                                                                               java.lang.String dataFieldId)
                                                                               throws ProcessNotFoundException,
                                                                                      DataFieldNotFoundException

Returns the DataField definition defined within the specified processDefinition UUID for the given dataField Id

Parameters:

processDefinitionUUID - the processDefinition UUID.

dataFieldId - the dataField id as specified in the XPDL file.

Returns:

the DataFieldDefinition for the specified processDefinition UUID and dataField Id.

Throws:

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.

getProcessParticipants

java.util.Set<org.ow2.bonita.facade.def.majorElement.ParticipantDefinition> getProcessParticipants(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID)
                                                                                                   throws ProcessNotFoundException

Returns the set of participant definitions for the specified processDefinition UUID.

Parameters:

processDefinitionUUID - the processDefinition UUID.

Returns:

the set of ParticipantDefinition for the specified processDefinition UUID.

Throws:

ProcessNotFoundException - if no process exists with the given processDefinition UUID.

BonitaInternalException - if an exception occurs.

getProcessParticipant

org.ow2.bonita.facade.def.majorElement.ParticipantDefinition getProcessParticipant(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID,
                                                                                   java.lang.String participantId)
                                                                                   throws ProcessNotFoundException,
                                                                                          ParticipantNotFoundException

Returns the participant definition for the specified processDefinition UUID and participant Id.

Parameters:

processDefinitionUUID - the processDefinition UUID.

participantId - the participant id as specified in the XPDL file.

Returns:

the ParticipantDefinition for the specified processDefinition UUID and participant participantId.

Throws:

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.

getProcessActivities

java.util.Set<org.ow2.bonita.facade.def.majorElement.ActivityDefinition> getProcessActivities(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID)
                                                                                              throws ProcessNotFoundException

Returns the set of definitions for process activities of the specified processDefinition UUID.

Parameters:

processDefinitionUUID - the process UUID.

Returns:

the set of ActivityDefinition for the specified processDefinition UUID.

Throws:

ProcessNotFoundException - if the process with the given processDefinition UUID does not exist.

BonitaInternalException - if an exception occurs.

getProcessActivity

org.ow2.bonita.facade.def.majorElement.ActivityDefinition getProcessActivity(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID,
                                                                             java.lang.String activityId)
                                                                             throws ProcessNotFoundException,
                                                                                    ActivityNotFoundException

Returns the definition for process activity of the specified process and activity Id.

Parameters:

processDefinitionUUID - the process UUID.

activityId - the activity id as specified in the XPDL file.

Returns:

the ActivityDefinition for the specified processDefinition UUID and activity id (as specified in the XPDL file).

Throws:

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.

getActivityDataField

org.ow2.bonita.facade.def.majorElement.DataFieldDefinition getActivityDataField(org.ow2.bonita.facade.uuid.ActivityDefinitionUUID activityDefinitionUUID,
                                                                                java.lang.String dataFieldId)
                                                                                throws ActivityDefNotFoundException,
                                                                                       DataFieldNotFoundException

Returns the DataField definition that has been defined as local to the given activity. for the given activityDefinition UUID and dataField Id.

Parameters:

activityDefinitionUUID - the ActivityDefinition UUID.

dataFieldId - the dataField id as specified in the XPDL file.

Returns:

the DataFieldDefinition for the specified activityDefinition UUID and dataField Id.

Throws:

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

getActivityDataFields

java.util.Set<org.ow2.bonita.facade.def.majorElement.DataFieldDefinition> getActivityDataFields(org.ow2.bonita.facade.uuid.ActivityDefinitionUUID activityDefinitionUUID)
                                                                                                throws ActivityDefNotFoundException

Returns the set of dataField definitions that have been defined as local to the given activity for the given activityDefinition UUID.

Parameters:

activityDefinitionUUID - the activityDefinition UUID.

Returns:

the set of DataFieldDefinition for the specified activityDefinition UUID.

Throws:

ActivityDefNotFoundException - if no activity exists with the given activityDefinition UUID.

BonitaInternalException - if an exception occurs.

getProcessActivityId

org.ow2.bonita.facade.uuid.ActivityDefinitionUUID getProcessActivityId(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID,
                                                                       java.lang.String activityName)
                                                                       throws ProcessNotFoundException

Returns the activity Id for the specified processDefinition UUID and activity name. Id and Name of an activity are both defined into the XPDL file within Activity element (value of Id and Name attributes for XPDL Activity element).

Parameters:

processDefinitionUUID - the process UUID.

activityName - the activity name as specified in the XPDL file (value of Name attribute within the Activity element).

Returns:

the activity UUID for the specified process UUID and activity name.

Throws:

ProcessNotFoundException - if the process with the given UUID does not exist.

BonitaInternalException - if an exception occurs.

getProcessParticipantId

org.ow2.bonita.facade.uuid.ParticipantDefinitionUUID getProcessParticipantId(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID,
                                                                             java.lang.String participantName)
                                                                             throws ProcessNotFoundException

Returns the participantDefinition UUID for the specified processDefinition UUID and participant name.

Parameters:

processDefinitionUUID - the processDefinition UUID.

participantName - the participant name as specified in the XPDL file.

Returns:

the participantDefinition UUID for the specified processDefinition UUID and participant name.

Throws:

ProcessNotFoundException - if the process with the given UUID does not exist

BonitaInternalException - if an exception occurs.

getLastPackage

org.ow2.bonita.facade.def.majorElement.PackageDefinition getLastPackage(java.lang.String packageId)
                                                                        throws PackageNotFoundException

Returns the last deployed package for the specified package id.
Version of the package has been changed at each package deployment.

Parameters:

packageId - the package id as specified in the XPDL file.

Returns:

the last deployed package for the specified package id.

Throws:

PackageNotFoundException - if the package with the given id does not exist

BonitaInternalException - if an exception occurs.

getLastProcess

org.ow2.bonita.facade.def.majorElement.ProcessDefinition getLastProcess(java.lang.String packageId,
                                                                        java.lang.String processId)
                                                                        throws ProcessNotFoundException

Return process definition of the last deployed process for the specified package id and process id.

Parameters:

packageId - the package id as specified in the XPDL file.

processId - the process id as specified in the XPDL file.

Returns:

the process definition of the last deployed process for the specified package id and process id.

Throws:

ProcessNotFoundException - if the process with the given package id and process id does not exist.

BonitaInternalException - if an exception occurs.