org.ow2.bonita.facade
Interface QueryAPI

All Known Implementing Classes:
QueryAPIImpl

public interface QueryAPI

Getters on workflow recorded data. Operations in this API applies to main entities managed by Nova Bonita such as: packages, processes, process instances, activities, tasks. Returned records are issued from recorded runtime informations (both runtime and archived workflow instances).

Author:
Pierre Vigneras, Charles Souillard

Method Summary
 java.util.Map<java.lang.String,org.ow2.bonita.services.record.ActivityRecord> getActivities(java.lang.String instanceId)
          Returns all records of activity for the given instance id.
 org.ow2.bonita.services.record.ActivityRecord getActivity(java.lang.String instanceId, java.lang.String activityId)
          Returns the record of the activity with the given instance id and activity id.
 org.ow2.bonita.services.record.InstanceRecord getInstance(java.lang.String instanceId)
          Returns the record of the instance with the given id.
 java.util.Map<java.lang.String,org.ow2.bonita.services.record.InstanceRecord> getInstances(java.lang.String processId)
          Returns all records of instance for the given process id.
 org.ow2.bonita.services.record.TaskRecord getTask(java.lang.String taskId)
          Returns the record of the task with the given task id.
 java.util.Map<java.lang.String,org.ow2.bonita.services.record.TaskRecord> getTasks(java.lang.String instanceId)
          Returns all records of task for the given instance id.
 

Method Detail

getInstance

org.ow2.bonita.services.record.InstanceRecord getInstance(java.lang.String instanceId)
Returns the record of the instance with the given id.

Parameters:
instanceId - the instance id.
Returns:
the record of the instance with the given id.
Throws:
BonitaInternalException - if an exception occurs.

getInstances

java.util.Map<java.lang.String,org.ow2.bonita.services.record.InstanceRecord> getInstances(java.lang.String processId)
Returns all records of instance for the given process id.

Parameters:
processId - the process id.
Returns:
the map containing all instance records. Key is the id of the instance. Value is the record for the instance.
Throws:
BonitaInternalException - if an exception occurs.

getActivity

org.ow2.bonita.services.record.ActivityRecord getActivity(java.lang.String instanceId,
                                                          java.lang.String activityId)
Returns the record of the activity with the given instance id and activity id.

Parameters:
instanceId - the instance id.
activityId - the activity id.
Returns:
the record activity with the given instance id and activity id.
Throws:
BonitaInternalException - if an exception occurs.

getActivities

java.util.Map<java.lang.String,org.ow2.bonita.services.record.ActivityRecord> getActivities(java.lang.String instanceId)
Returns all records of activity for the given instance id.

Parameters:
instanceId - the instance id.
Returns:
the map containing activity records. Key is the id of the activity. Value is the record for the activity.
Throws:
BonitaInternalException - if an exception occurs.

getTask

org.ow2.bonita.services.record.TaskRecord getTask(java.lang.String taskId)
Returns the record of the task with the given task id.

Parameters:
taskId - the task id.
Returns:
the record of the task with the given task id.
Throws:
BonitaInternalException - if an exception occurs.

getTasks

java.util.Map<java.lang.String,org.ow2.bonita.services.record.TaskRecord> getTasks(java.lang.String instanceId)
Returns all records of task for the given instance id.

Parameters:
instanceId - the instance id.
Returns:
the map containing all task records. Key is the id of the task. Value is the record for the task.
Throws:
BonitaInternalException - if an exception occurs.