org.ow2.bonita.facade
Interface QueryDefinitionAPI


public interface QueryDefinitionAPI

Getters on the workflow definition data for:

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
 PackageDef getLastPackage(java.lang.String packageId)
          Return the last deployed package for the specified package id.
 ProcessDef getLastProcess(java.lang.String processId)
          Return the last deployed process for the specified process id.
 PackageDef getPackage(org.ow2.bonita.facade.uuid.PackageDefinitionUUID packageDefinitionUUID)
          Returns the package definition for the specified package.
 ProcessDef getPackageProcess(org.ow2.bonita.facade.uuid.PackageDefinitionUUID packageDefinitionUUID, java.lang.String processId)
           
 java.util.Set<ProcessDef> 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<PackageDef> getPackages()
          Returns the set of definition informations for all deployed packages.
 java.util.Set<PackageDef> getPackages(PackageDef.PackageState state)
           
 java.util.Set<PackageDef> getPackages(java.lang.String packageId)
          Returns the set of definition informations for all deployed packages for the specified package.
 java.util.Set<PackageDef> getPackages(java.lang.String packageId, PackageDef.PackageState state)
           
 ProcessDef getProcess(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID)
          Returns the process definition for the specified process UUID.
 java.util.Set<ActivityDef> getProcessActivities(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID)
          Returns the set of definition for process activities of the specified process UUID.
 ActivityDef getProcessActivity(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID, java.lang.String activityId)
          Returns the definition for process activity of the specified process.
 org.ow2.bonita.facade.uuid.ActivityDefinitionUUID getProcessActivityId(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID, java.lang.String activityName)
          Returns the activity UUID for the specified process UUID and activity name.
 java.util.Set<ProcessDef> getProcesses()
          Returns the set of definition information of all deployed processes.
 java.util.Set<ProcessDef> getProcesses(ProcessDef.ProcessState processState)
           
 java.util.Set<ProcessDef> getProcesses(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<ProcessDef> getProcesses(java.lang.String processId, ProcessDef.ProcessState processState)
           
 ParticipantDef getProcessParticipant(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID, java.lang.String participantId)
          Returns the participant definition for the specified process UUID.
 org.ow2.bonita.facade.uuid.ParticipantDefinitionUUID getProcessParticipantId(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID, java.lang.String participantName)
          Returns the participant UUID for the specified process UUID and participant name.
 java.util.Set<ParticipantDef> getProcessParticipants(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID)
          Returns the set of participant definitions for the specified process and deployment.
 

Method Detail

getPackages

java.util.Set<PackageDef> getPackages()
Returns the set of definition informations for all deployed packages.

Returns:
a set of PackageDef in unspecified order that have been deployed.
Throws:
BonitaInternalException - if an exception occurs.

getPackages

java.util.Set<PackageDef> getPackages(java.lang.String packageId)
Returns the set of definition informations for all deployed packages for the specified package.

Parameters:
packageId - the package Id as specified in the xpdl file.
Returns:
a set of PackageDef in unspecified order that have been deployed for the package with specified packageId.
Throws:
BonitaInternalException - if an exception occurs.

getPackage

PackageDef getPackage(org.ow2.bonita.facade.uuid.PackageDefinitionUUID packageDefinitionUUID)
Returns the package definition for the specified package.

Parameters:
packageDefinitionUUID - the package processDefinitionUUID.
Returns:
a packageDef interface.
Throws:
BonitaInternalException - if an exception occurs.

getPackages

java.util.Set<PackageDef> getPackages(PackageDef.PackageState state)

getPackages

java.util.Set<PackageDef> getPackages(java.lang.String packageId,
                                      PackageDef.PackageState state)

getPackageProcesses

java.util.Set<ProcessDef> getPackageProcesses(org.ow2.bonita.facade.uuid.PackageDefinitionUUID packageDefinitionUUID)
Returns the set of definition information of all processes within the specified deployed package.

Parameters:
packageDefinitionUUID - the package UUID.
Returns:
set of ProcessDef of all the processes within the specified deployed package.
Throws:
BonitaInternalException - if an exception occurs.

getPackageProcess

ProcessDef getPackageProcess(org.ow2.bonita.facade.uuid.PackageDefinitionUUID packageDefinitionUUID,
                             java.lang.String processId)

getProcesses

java.util.Set<ProcessDef> getProcesses()
Returns the set of definition information of all deployed processes.

Returns:
set of ProcessDef of all deployed processes.
Throws:
BonitaInternalException - if an exception occurs.

getProcesses

java.util.Set<ProcessDef> getProcesses(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 ProcessDef of the specified process processId.
Throws:
BonitaInternalException - if an exception occurs.

getProcess

ProcessDef getProcess(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID)
Returns the process definition for the specified process UUID.

Parameters:
processDefinitionUUID - the process UUID.
Returns:
the ProcessDef interface for the specified process UUID.
Throws:
BonitaInternalException - if an exception occurs.

getProcesses

java.util.Set<ProcessDef> getProcesses(ProcessDef.ProcessState processState)

getProcesses

java.util.Set<ProcessDef> getProcesses(java.lang.String processId,
                                       ProcessDef.ProcessState processState)

getProcessParticipants

java.util.Set<ParticipantDef> getProcessParticipants(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID)
Returns the set of participant definitions for the specified process and deployment.

Parameters:
processDefinitionUUID - the process UUID.
Returns:
the set of ParticipantDef for the specified process UUID.

getProcessParticipant

ParticipantDef getProcessParticipant(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID,
                                     java.lang.String participantId)
Returns the participant definition for the specified process UUID.

Parameters:
processDefinitionUUID - the process UUID.
participantId - the participant id as specified in the xpdl file.
Returns:
the ParticipantDef for the specified process UUID and participant participantId.

getProcessActivities

java.util.Set<ActivityDef> getProcessActivities(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID)
Returns the set of definition for process activities of the specified process UUID.

Parameters:
processDefinitionUUID - the process UUID.
Returns:
the set of ActivityDef for the specified process UUID.

getProcessActivity

ActivityDef getProcessActivity(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID,
                               java.lang.String activityId)
Returns the definition for process activity of the specified process.

Parameters:
processDefinitionUUID - the process UUID.
activityId - the activity id as specified in the xpdl file.
Returns:
the ActivityDef for the specified process UUID and activity id.

getProcessActivityId

org.ow2.bonita.facade.uuid.ActivityDefinitionUUID getProcessActivityId(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID,
                                                                       java.lang.String activityName)
Returns the activity UUID for the specified process UUID and activity name.

Parameters:
processDefinitionUUID - the process UUID.
activityName - the activity name as specified in the xpdl file.
Returns:
the activity UUID for the specified process UUID and activity name.

getProcessParticipantId

org.ow2.bonita.facade.uuid.ParticipantDefinitionUUID getProcessParticipantId(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processDefinitionUUID,
                                                                             java.lang.String participantName)
Returns the participant UUID for the specified process UUID and participant name.

Parameters:
processDefinitionUUID - the process UUID.
participantName - the participant name as specified in the xpdl file.
Returns:
the participant UUID for the specified process UUID and participant name.

getLastPackage

PackageDef getLastPackage(java.lang.String packageId)
Return the last deployed package for the specified package id.

Parameters:
packageId - the package id as specified in the xpdl file.
Returns:
the last deployed package for the specified package id.

getLastProcess

ProcessDef getLastProcess(java.lang.String processId)
Return the last deployed process for the specified process id.

Parameters:
processId - the process id as specified in the xpdl file.
Returns:
the last deployed process for the specified process id.