org.ow2.bonita.facade
Interface DefinitionAPI

All Known Implementing Classes:
DefinitionAPIImpl

public interface DefinitionAPI

Getters on the workflow definition data for: packages, processes, activities, participants, dataFields, transitions hooks, mappers, performer assignments.

This interface could be considered as complementary to the QueryAPI interface. For this interface the returned data represents static part of managed workflow elements.

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


Method Summary
 PackageDef getDeployedPackage(java.lang.String packageId)
           
 java.util.Set<? extends PackageDef> getDeployedPackages()
           
 ProcessDef getDeployedProcess(java.lang.String processId)
           
 java.util.Set<? extends ProcessDef> getDeployedProcesses()
           
 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(java.lang.String packageId, java.lang.String deploymentId)
          Returns the package definition for the specified package and deployment.
 java.lang.String getPackageId(java.lang.String deploymentId, java.lang.String packageName)
          Returns the package id for the specified package name and deployment id.
 ProcessDef getPackageProcess(java.lang.String packageId, java.lang.String deploymentId, java.lang.String processId)
          Returns the process information for the specified package and deployment and process.
 java.util.Set<? extends ProcessDef> getPackageProcesses(java.lang.String packageId, java.lang.String deploymentId)
          Returns the set of definition information of all processes within the specified deployed package and the specified deployment.
 java.util.Set<? extends PackageDef> getPackages()
          Returns the set of definition informations for all deployed packages.
 java.util.Set<? extends PackageDef> getPackages(java.lang.String packageId)
          Returns the set of definition informations for all deployed packages for the specified package.
 ProcessDef getProcess(java.lang.String processId, java.lang.String deploymentId)
          Returns the process definition for the specified process id and deployment id.
 java.util.Set<? extends ActivityDef> getProcessActivities(java.lang.String processId, java.lang.String deploymentId)
          Returns the set of definition for process activities of the specified process and deployment.
 ActivityDef getProcessActivity(java.lang.String processId, java.lang.String deploymentId, java.lang.String activityId)
          Returns the definition for process activity of the specified process and deployment.
 java.lang.String getProcessActivityId(java.lang.String processId, java.lang.String deploymentId, java.lang.String activityName)
          Returns the activity id for the specified process id and deployment id and activity id.
 java.util.Set<? extends ProcessDef> getProcesses()
          Returns the set of definition information of all deployed processes.
 java.util.Set<? extends ProcessDef> getProcesses(java.lang.String processId)
          Returns the set of definition informations for the process with the specified id.
 java.lang.String getProcessId(java.lang.String deploymentId, java.lang.String processName)
          Returns the process id for the specified process name and deployment id.
 ParticipantDef getProcessParticipant(java.lang.String processId, java.lang.String deploymentId, java.lang.String participantId)
          Returns the participant definition for the specified process and deployment.
 java.lang.String getProcessParticipantId(java.lang.String processId, java.lang.String deploymentId, java.lang.String participantName)
          Returns the participant id for the specified process id and deployment id and participant name.
 java.util.Set<? extends ParticipantDef> getProcessParticipants(java.lang.String processId, java.lang.String deploymentId)
          Returns the set of participant definitions for the specified process and deployment.
 

Method Detail

getPackages

java.util.Set<? extends 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<? extends 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.
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(java.lang.String packageId,
                      java.lang.String deploymentId)
Returns the package definition for the specified package and deployment.

Parameters:
packageId - the package id.
deploymentId - the deployment id.
Returns:
a packageDef interface.
Throws:
BonitaInternalException - if an exception occurs.

getDeployedPackages

java.util.Set<? extends PackageDef> getDeployedPackages()

getDeployedPackage

PackageDef getDeployedPackage(java.lang.String packageId)

getPackageProcesses

java.util.Set<? extends ProcessDef> getPackageProcesses(java.lang.String packageId,
                                                        java.lang.String deploymentId)
Returns the set of definition information of all processes within the specified deployed package and the specified deployment.

Parameters:
packageId - the package id.
deploymentId - the deployment id.
Returns:
set of ProcessDef of all the processes within the specified deployed package and the specified deployment.
Throws:
BonitaInternalException - if an exception occurs.

getPackageProcess

ProcessDef getPackageProcess(java.lang.String packageId,
                             java.lang.String deploymentId,
                             java.lang.String processId)
Returns the process information for the specified package and deployment and process.

Parameters:
packageId - the package id.
deploymentId - the deployment id.
processId - the process id.
Returns:
the ProcessDef interface for the specified package and deployment and process.
Throws:
BonitaInternalException - if an exception occurs.

getProcesses

java.util.Set<? extends 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<? extends ProcessDef> getProcesses(java.lang.String processId)
Returns the set of definition informations for the process with the specified id. These process informations are searched into the current recorded informations and into the archived informations. A process with a given id could have been deployed and undeployed several times.

Returns:
set of ProcessDef of the specified process id.
Throws:
BonitaInternalException - if an exception occurs.

getProcess

ProcessDef getProcess(java.lang.String processId,
                      java.lang.String deploymentId)
Returns the process definition for the specified process id and deployment id.

Parameters:
processId - the process id.
deploymentId - the deployment id.
Returns:
the ProcessDef interface for the specified process id and deployment id.
Throws:
BonitaInternalException - if an exception occurs.

getDeployedProcesses

java.util.Set<? extends ProcessDef> getDeployedProcesses()

getDeployedProcess

ProcessDef getDeployedProcess(java.lang.String processId)

getProcessParticipants

java.util.Set<? extends ParticipantDef> getProcessParticipants(java.lang.String processId,
                                                               java.lang.String deploymentId)
Returns the set of participant definitions for the specified process and deployment.

Parameters:
processId - the process id.
deploymentId - the deployment id.
Returns:
the set of ParticipantDef for the specified process id and deployment id.

getProcessParticipant

ParticipantDef getProcessParticipant(java.lang.String processId,
                                     java.lang.String deploymentId,
                                     java.lang.String participantId)
Returns the participant definition for the specified process and deployment.

Parameters:
processId - the process id.
deploymentId - the deployment id.
participantId - the participant id.
Returns:
the ParticipantDef for the specified process id and deployment id and participant id.

getProcessActivities

java.util.Set<? extends ActivityDef> getProcessActivities(java.lang.String processId,
                                                          java.lang.String deploymentId)
Returns the set of definition for process activities of the specified process and deployment.

Parameters:
processId - the process id.
deploymentId - the deployment id.
Returns:
the set of ActivityDef for the specified process id and deployment id.

getProcessActivity

ActivityDef getProcessActivity(java.lang.String processId,
                               java.lang.String deploymentId,
                               java.lang.String activityId)
Returns the definition for process activity of the specified process and deployment.

Parameters:
processId - the process id.
deploymentId - the deployment id.
activityId - the activity id.
Returns:
the ActivityDef for the specified process id and deployment id and activity id.

getPackageId

java.lang.String getPackageId(java.lang.String deploymentId,
                              java.lang.String packageName)
Returns the package id for the specified package name and deployment id.

Parameters:
deploymentId - the deployment id.
packageName - the package name.
Returns:
the package id for the specified package name and deployment id.

getProcessId

java.lang.String getProcessId(java.lang.String deploymentId,
                              java.lang.String processName)
Returns the process id for the specified process name and deployment id.

Parameters:
deploymentId - the deployment id.
processName - the process name.
Returns:
the process id for the specified process name and deployment id.

getProcessActivityId

java.lang.String getProcessActivityId(java.lang.String processId,
                                      java.lang.String deploymentId,
                                      java.lang.String activityName)
Returns the activity id for the specified process id and deployment id and activity id.

Parameters:
processId - the process id.
deploymentId - the deploymenet id.
activityName - the activity name.
Returns:
the activity id for the specified process id and deployment id and activity id.

getProcessParticipantId

java.lang.String getProcessParticipantId(java.lang.String processId,
                                         java.lang.String deploymentId,
                                         java.lang.String participantName)
Returns the participant id for the specified process id and deployment id and participant name.

Parameters:
processId - the process id.
deploymentId - the deploymenet id.
participantName - the participant name.
Returns:
the participant id for the specified process id and deployment id 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.
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.
Returns:
the last deployed process for the specified process id.