|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
java.util.Set<? extends PackageDef> getPackages()
BonitaInternalException
- if an exception occurs.java.util.Set<? extends PackageDef> getPackages(java.lang.String packageId)
packageId
- the package id.
BonitaInternalException
- if an exception occurs.PackageDef getPackage(java.lang.String packageId, java.lang.String deploymentId)
packageId
- the package id.deploymentId
- the deployment id.
BonitaInternalException
- if an exception occurs.java.util.Set<? extends PackageDef> getDeployedPackages()
PackageDef getDeployedPackage(java.lang.String packageId)
java.util.Set<? extends ProcessDef> getPackageProcesses(java.lang.String packageId, java.lang.String deploymentId)
packageId
- the package id.deploymentId
- the deployment id.
BonitaInternalException
- if an exception occurs.ProcessDef getPackageProcess(java.lang.String packageId, java.lang.String deploymentId, java.lang.String processId)
packageId
- the package id.deploymentId
- the deployment id.processId
- the process id.
BonitaInternalException
- if an exception occurs.java.util.Set<? extends ProcessDef> getProcesses()
BonitaInternalException
- if an exception occurs.java.util.Set<? extends ProcessDef> getProcesses(java.lang.String processId)
BonitaInternalException
- if an exception occurs.ProcessDef getProcess(java.lang.String processId, java.lang.String deploymentId)
processId
- the process id.deploymentId
- the deployment id.
BonitaInternalException
- if an exception occurs.java.util.Set<? extends ProcessDef> getDeployedProcesses()
ProcessDef getDeployedProcess(java.lang.String processId)
java.util.Set<? extends ParticipantDef> getProcessParticipants(java.lang.String processId, java.lang.String deploymentId)
processId
- the process id.deploymentId
- the deployment id.
ParticipantDef getProcessParticipant(java.lang.String processId, java.lang.String deploymentId, java.lang.String participantId)
processId
- the process id.deploymentId
- the deployment id.participantId
- the participant id.
java.util.Set<? extends ActivityDef> getProcessActivities(java.lang.String processId, java.lang.String deploymentId)
processId
- the process id.deploymentId
- the deployment id.
ActivityDef getProcessActivity(java.lang.String processId, java.lang.String deploymentId, java.lang.String activityId)
processId
- the process id.deploymentId
- the deployment id.activityId
- the activity id.
java.lang.String getPackageId(java.lang.String deploymentId, java.lang.String packageName)
deploymentId
- the deployment id.packageName
- the package name.
java.lang.String getProcessId(java.lang.String deploymentId, java.lang.String processName)
deploymentId
- the deployment id.processName
- the process name.
java.lang.String getProcessActivityId(java.lang.String processId, java.lang.String deploymentId, java.lang.String activityName)
processId
- the process id.deploymentId
- the deploymenet id.activityName
- the activity name.
java.lang.String getProcessParticipantId(java.lang.String processId, java.lang.String deploymentId, java.lang.String participantName)
processId
- the process id.deploymentId
- the deploymenet id.participantName
- the participant name.
PackageDef getLastPackage(java.lang.String packageId)
packageId
- the package id.
ProcessDef getLastProcess(java.lang.String processId)
processId
- the process id.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |