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
 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.
 ProcessDefinition getLastProcess(java.lang.String processId)
          Return process definition of the last deployed process for the specified package id and process id.
 ProcessDefinition getProcess(ProcessDefinitionUUID processDefinitionUUID)
          Returns the process definition for the specified processDefinition UUID.
 ProcessDefinition getProcess(java.lang.String processId, java.lang.String processVersion)
          Return the process definition for the specified 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.lang.String getProcessMetaData(ProcessDefinitionUUID uuid, java.lang.String key)
          Obtains the value of a process meta data.
 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

getProcesses

java.util.Set<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.

getProcesses

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. 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

ProcessDefinition getProcess(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.

getProcess

ProcessDefinition getProcess(java.lang.String processId,
                             java.lang.String processVersion)
                             throws ProcessNotFoundException
Return the process definition for the specified processId and process version.

Parameters:
processId - the processId.
processVersion - the process version.
Returns:
the process definition for the specified 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<ProcessDefinition> getProcesses(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<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.

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<DataFieldDefinition> getProcessDataFields(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

DataFieldDefinition getProcessDataField(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<ParticipantDefinition> getProcessParticipants(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

ParticipantDefinition getProcessParticipant(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<ActivityDefinition> getProcessActivities(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

ActivityDefinition getProcessActivity(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

DataFieldDefinition getActivityDataField(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<DataFieldDefinition> getActivityDataFields(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

ActivityDefinitionUUID getProcessActivityId(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

ParticipantDefinitionUUID getProcessParticipantId(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.

getLastProcess

ProcessDefinition getLastProcess(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.

getProcessMetaData

java.lang.String getProcessMetaData(ProcessDefinitionUUID uuid,
                                    java.lang.String key)
                                    throws ProcessNotFoundException
Obtains the value of a process meta data. If no meta data matches with the key, null is returned.

Parameters:
uuid - the process definition UUID
key - the key of the meta data
Returns:
the value of the meta data
Throws:
ProcessNotFoundException


Copyright © 2009 OW2 Consortium. All Rights Reserved.