com.bonitasoft.engine.api

Interface ProcessRuntimeAPI

All Superinterfaces:

ProcessRuntimeAPI

All Known Subinterfaces:

ProcessAPI

public interface ProcessRuntimeAPI
extends ProcessRuntimeAPI

ProcessRuntimeAPI extends ProcessRuntimeAPI and adds capabilities on Manual tasks, connector execution (directly available at API level), search index updating.

Author:

Matthieu Chaffotte, Emmanuel Duchastenier

Method Summary

Methods

Modifier and Type	Method and Description
ManualTaskInstance	addManualUserTask(ManualTaskCreator creator) Add a manual task with given human task id.
void	deleteManualUserTask(long manualTaskId) Delete a manual task.
Map<String,Serializable>	executeConnectorAtProcessInstantiation(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, List<Operation> operations, Map<String,Serializable> operationsInputValues, long processInstanceId) Execute connector in given process instance initialized with operations.
Map<String,Serializable>	executeConnectorAtProcessInstantiation(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, long processInstanceId) Execute connector in given process instance initialized.
Map<String,Serializable>	executeConnectorOnActivityInstance(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, List<Operation> operations, Map<String,Serializable> operationsInputValues, long activityInstanceId) Execute connector in given activity instance.
Map<String,Serializable>	executeConnectorOnActivityInstance(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, long activityInstanceId) Execute connector in given activity instance.
Map<String,Serializable>	executeConnectorOnCompletedActivityInstance(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, List<Operation> operations, Map<String,Serializable> operationsInputValues, long activityInstanceId) Execute connector in given activity instance finished.
Map<String,Serializable>	executeConnectorOnCompletedActivityInstance(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, long activityInstanceId) Execute connector in given activity instance finished.
Map<String,Serializable>	executeConnectorOnCompletedProcessInstance(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, List<Operation> operations, Map<String,Serializable> operationsInputValues, long processInstanceId) Execute connector in given process instance finished with operations.
Map<String,Serializable>	executeConnectorOnCompletedProcessInstance(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, long processInstanceId) Execute connector in given process instance finished.
Map<String,Serializable>	executeConnectorOnProcessInstance(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, List<Operation> operations, Map<String,Serializable> operationsInputValues, long processInstanceId) Execute connector in given process instance with operations
Map<String,Serializable>	executeConnectorOnProcessInstance(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, long processInstanceId) Execute connector in given process instance.
ConnectorInstanceWithFailureInfo	getConnectorInstanceWithFailureInformation(long connectorInstanceId) Retrieves a ConnectorInstanceWithFailureInfo specified by its identifier.
SearchResult<ArchivedActivityInstance>	searchArchivedActivityInstancesSupervisedBy(long supervisorId, SearchOptions searchOptions) Search for archived flow node instances (activities, gateways and events) supervised by the specified user.
SearchResult<ArchivedFlowNodeInstance>	searchArchivedFlowNodeInstancesSupervisedBy(long supervisorId, SearchOptions searchOptions) Search for archived flow node instances (activities, gateways and events) supervised by the specified user.
SearchResult<FlowNodeInstance>	searchFlowNodeInstancesSupervisedBy(long supervisorId, SearchOptions searchOptions) Search for flow node instances (activities, gateways and events) supervised by the specified user.
ProcessInstance	updateProcessInstance(long processInstanceId, ProcessInstanceUpdater updater) Update an instance of process with the given processInstanceId.
ProcessInstance	updateProcessInstanceIndex(long processInstanceId, Index index, String value) Update an index of a process instance.

Methods inherited from interface org.bonitasoft.engine.api.ProcessRuntimeAPI

addComment, addProcessComment, assignUserTask, cancelProcessInstance, canExecuteTask, countAttachments, countComments, deleteArchivedProcessInstances, deleteProcessInstance, deleteProcessInstances, deleteProcessInstances, evaluateExpressionOnCompletedProcessInstance, evaluateExpressionOnProcessDefinition, evaluateExpressionsAtProcessInstanciation, evaluateExpressionsOnActivityInstance, evaluateExpressionsOnCompletedActivityInstance, evaluateExpressionsOnProcessDefinition, evaluateExpressionsOnProcessInstance, executeConnectorOnProcessDefinition, executeConnectorOnProcessDefinition, executeFlowNode, executeFlowNode, getActivities, getActivityDataInstance, getActivityDataInstances, getActivityInstance, getActivityInstanceState, getActivityReachedStateDate, getActivityTransientDataInstance, getActivityTransientDataInstances, getArchivedActivityDataInstance, getArchivedActivityDataInstances, getArchivedActivityInstance, getArchivedActivityInstances, getArchivedComment, getArchivedFlowNodeInstance, getArchivedProcessDataInstance, getArchivedProcessDataInstances, getArchivedProcessInstance, getArchivedProcessInstances, getArchivedProcessInstances, getAssignedHumanTaskInstances, getChildrenInstanceIdsOfProcessInstance, getComments, getEventInstances, getFailedJobs, getFinalArchivedProcessInstance, getFlowNodeInstance, getHumanTaskInstance, getHumanTaskInstances, getLastStateHumanTaskInstance, getNumberOfActivityDataInstances, getNumberOfArchivedProcessInstances, getNumberOfAssignedHumanTaskInstances, getNumberOfOpenedActivityInstances, getNumberOfOpenTasks, getNumberOfOverdueOpenTasks, getNumberOfPendingHumanTaskInstances, getNumberOfProcessDataInstances, getNumberOfProcessInstances, getOneAssignedUserTaskInstanceOfProcessDefinition, getOneAssignedUserTaskInstanceOfProcessInstance, getOpenActivityInstances, getPendingHumanTaskInstances, getPossibleUsersOfPendingHumanTask, getProcessDataInstance, getProcessDataInstances, getProcessDefinitionIdFromActivityInstanceId, getProcessDefinitionIdFromProcessInstanceId, getProcessInstance, getProcessInstanceIdFromActivityInstanceId, getProcessInstances, hideTasks, isInvolvedInProcessInstance, isTaskHidden, releaseUserTask, replayFailedJob, replayFailedJob, retryTask, searchActivities, searchArchivedActivities, searchArchivedComments, searchArchivedConnectorInstances, searchArchivedFlowNodeInstances, searchArchivedHumanTasks, searchArchivedHumanTasksManagedBy, searchArchivedHumanTasksSupervisedBy, searchArchivedProcessInstances, searchArchivedProcessInstancesInAllStates, searchArchivedProcessInstancesInvolvingUser, searchArchivedProcessInstancesSupervisedBy, searchAssignedAndPendingHumanTasks, searchAssignedAndPendingHumanTasksFor, searchAssignedTasksManagedBy, searchAssignedTasksSupervisedBy, searchComments, searchCommentsInvolvingUser, searchCommentsManagedBy, searchConnectorInstances, searchFlowNodeInstances, searchHumanTaskInstances, searchMyAvailableHumanTasks, searchOpenProcessInstances, searchOpenProcessInstancesInvolvingUser, searchOpenProcessInstancesInvolvingUsersManagedBy, searchOpenProcessInstancesSupervisedBy, searchPendingHiddenTasks, searchPendingTasksForUser, searchPendingTasksManagedBy, searchPendingTasksSupervisedBy, searchProcessDeploymentInfosWithAssignedOrPendingHumanTasks, searchProcessDeploymentInfosWithAssignedOrPendingHumanTasksFor, searchProcessDeploymentInfosWithAssignedOrPendingHumanTasksSupervisedBy, searchProcessInstances, searchUsersWhoCanExecutePendingHumanTask, sendMessage, sendMessage, sendSignal, setActivityStateById, setActivityStateByName, setProcessInstanceState, setTaskPriority, startProcess, startProcess, startProcess, startProcess, startProcess, startProcess, unhideTasks, updateActivityDataInstance, updateActivityInstanceVariables, updateActivityInstanceVariables, updateActivityTransientDataInstance, updateActorsOfUserTask, updateDueDateOfTask, updateProcessDataInstance, updateProcessDataInstances

Method Detail

addManualUserTask

ManualTaskInstance addManualUserTask(ManualTaskCreator creator)
                                     throws CreationException,
                                            AlreadyExistsException

Add a manual task with given human task id.

Parameters:

creator - the manual task creator

Returns:

the matching an instance of manual task

Throws:

CreationException - if the manual task cannot be created.

AlreadyExistsException - if the provided manual task already exists.

InvalidSessionException - if the session is invalid, e.g. the session has expired.

Since:

6.0

deleteManualUserTask

void deleteManualUserTask(long manualTaskId)
                          throws DeletionException

Delete a manual task. Only manual tasks can be deleted at runtime.

Parameters:

manualTaskId - the id of the task to delete

Throws:

DeletionException - if the manual task could not be deleted.

InvalidSessionException - if the session is invalid, e.g. the session has expired.

executeConnectorAtProcessInstantiation

Map<String,Serializable> executeConnectorAtProcessInstantiation(String connectorDefinitionId,
                                                              String connectorDefinitionVersion,
                                                              Map<String,Expression> connectorInputParameters,
                                                              Map<String,Map<String,Serializable>> inputValues,
                                                              long processInstanceId)
                                                                throws ConnectorExecutionException,
                                                                       ConnectorNotFoundException

Execute connector in given process instance initialized.

Parameters:

connectorDefinitionId - Identifier of connector definition

connectorDefinitionVersion - version of the connector definition

connectorInputParameters - all expressions related with the connector

inputValues - all parameters values for expression need when evaluate the connector

processInstanceId - Identifier of the process instance

Returns:

a map with connector parameter name and parameter value object

Throws:

ConnectorExecutionException - if an error occurs when trying to execute the connector

ConnectorNotFoundException - if the specified connector is not found

InvalidSessionException - if the session is invalid, e.g. the session has expired.

Since:

6.0

executeConnectorAtProcessInstantiation

Map<String,Serializable> executeConnectorAtProcessInstantiation(String connectorDefinitionId,
                                                              String connectorDefinitionVersion,
                                                              Map<String,Expression> connectorInputParameters,
                                                              Map<String,Map<String,Serializable>> inputValues,
                                                              List<Operation> operations,
                                                              Map<String,Serializable> operationsInputValues,
                                                              long processInstanceId)
                                                                throws ConnectorExecutionException,
                                                                       ConnectorNotFoundException

Execute connector in given process instance initialized with operations.

Parameters:

connectorDefinitionId - Identifier of connector definition

connectorDefinitionVersion - version of the connector definition

connectorInputParameters - all expressions related with the connector

inputValues - all parameters values for expression need when evaluate the connector

operations - map of operations having each a special context (input values)

operationsInputValues - all parameters values for operations

processInstanceId - Identifier of the process instance

Returns:

a map with new values of elements set by the operations

Throws:

ConnectorExecutionException - if the connector failed to execute properly.

ConnectorNotFoundException - if the connector cannot be found with the provided connectorDefinitionId + connectorDefinitionVersion

InvalidSessionException - if the session is invalid, e.g. the session has expired.

Since:

6.0

executeConnectorOnActivityInstance

Map<String,Serializable> executeConnectorOnActivityInstance(String connectorDefinitionId,
                                                          String connectorDefinitionVersion,
                                                          Map<String,Expression> connectorInputParameters,
                                                          Map<String,Map<String,Serializable>> inputValues,
                                                          long activityInstanceId)
                                                            throws ConnectorExecutionException,
                                                                   ConnectorNotFoundException

Execute connector in given activity instance.

Parameters:

connectorDefinitionId - Identifier of connector definition

connectorDefinitionVersion - version of the connector definition

connectorInputParameters - all expressions related with the connector

inputValues - all parameters values for expression need when evalute the connector

activityInstanceId - Identifier of the activity instance

Returns:

a map with connector parameter name and parameter value object

Throws:

ConnectorExecutionException - if the connector failed to execute properly.

ConnectorNotFoundException - if the connector cannot be found with the provided connectorDefinitionId + connectorDefinitionVersion

InvalidSessionException - if the session is invalid, e.g. the session has expired.

Since:

6.0

executeConnectorOnActivityInstance

Map<String,Serializable> executeConnectorOnActivityInstance(String connectorDefinitionId,
                                                          String connectorDefinitionVersion,
                                                          Map<String,Expression> connectorInputParameters,
                                                          Map<String,Map<String,Serializable>> inputValues,
                                                          List<Operation> operations,
                                                          Map<String,Serializable> operationsInputValues,
                                                          long activityInstanceId)
                                                            throws ConnectorExecutionException,
                                                                   ConnectorNotFoundException

Execute connector in given activity instance.

Parameters:

connectorDefinitionId - Identifier of connector definition

connectorDefinitionVersion - version of the connector definition

connectorInputParameters - all expressions related with the connector

inputValues - all parameters values for expression need when evaluate the connector

operations - map of operations having each a special context (input values)

operationsInputValues - the map of input name-value pairs used by operation executions.

activityInstanceId - Identifier of the activity instance

Returns:

a map with new values of elements set by the operations

Throws:

ConnectorExecutionException - if the connector failed to execute properly.

ConnectorNotFoundException - if the connector cannot be found with the provided connectorDefinitionId + connectorDefinitionVersion

InvalidSessionException - if the session is invalid, e.g. the session has expired.

Since:

6.0

executeConnectorOnCompletedActivityInstance

Map<String,Serializable> executeConnectorOnCompletedActivityInstance(String connectorDefinitionId,
                                                                   String connectorDefinitionVersion,
                                                                   Map<String,Expression> connectorInputParameters,
                                                                   Map<String,Map<String,Serializable>> inputValues,
                                                                   long activityInstanceId)
                                                                     throws ConnectorExecutionException,
                                                                            ConnectorNotFoundException

Execute connector in given activity instance finished.

Parameters:

connectorDefinitionId - Identifier of connector definition

connectorDefinitionVersion - version of the connector definition

connectorInputParameters - all expressions related with the connector

inputValues - all parameters values for expression need when evalute the connector

activityInstanceId - Identifier of the activity instance

Returns:

a map with connector parameter name and parameter value object

Throws:

ConnectorExecutionException - if the connector failed to execute properly.

ConnectorNotFoundException - if the connector cannot be found with the provided connectorDefinitionId + connectorDefinitionVersion

InvalidSessionException - if the session is invalid, e.g. the session has expired.

Since:

6.0

executeConnectorOnCompletedActivityInstance

Map<String,Serializable> executeConnectorOnCompletedActivityInstance(String connectorDefinitionId,
                                                                   String connectorDefinitionVersion,
                                                                   Map<String,Expression> connectorInputParameters,
                                                                   Map<String,Map<String,Serializable>> inputValues,
                                                                   List<Operation> operations,
                                                                   Map<String,Serializable> operationsInputValues,
                                                                   long activityInstanceId)
                                                                     throws ConnectorExecutionException,
                                                                            ConnectorNotFoundException

Execute connector in given activity instance finished.

Parameters:

connectorDefinitionId - Identifier of connector definition

connectorDefinitionVersion - version of the connector definition

connectorInputParameters - all expressions related with the connector

inputValues - all parameters values for expression need when evalute the connector

operations - map of operations having each a special context (input values)

operationsInputValues - the map of input name-value pairs used by operation executions.

activityInstanceId - Identifier of the activity instance

Returns:

a map with new values of elements set by the operations

Throws:

ConnectorExecutionException - if the connector failed to execute properly.

ConnectorNotFoundException - if the connector cannot be found with the provided connectorDefinitionId + connectorDefinitionVersion

InvalidSessionException - if the session is invalid, e.g. the session has expired.

Since:

6.0

executeConnectorOnCompletedProcessInstance

Map<String,Serializable> executeConnectorOnCompletedProcessInstance(String connectorDefinitionId,
                                                                  String connectorDefinitionVersion,
                                                                  Map<String,Expression> connectorInputParameters,
                                                                  Map<String,Map<String,Serializable>> inputValues,
                                                                  long processInstanceId)
                                                                    throws ConnectorExecutionException,
                                                                           ConnectorNotFoundException

Execute connector in given process instance finished.

Parameters:

connectorDefinitionId - Identifier of connector definition

connectorDefinitionVersion - version of the connector definition

connectorInputParameters - all expressions related with the connector

inputValues - all parameters values for expression need when evalute the connector

processInstanceId - Identifier of the process instance

Returns:

a map with connector parameter name and parameter value object

Throws:

ConnectorExecutionException - if the connector failed to execute properly.

ConnectorNotFoundException - if the connector cannot be found with the provided connectorDefinitionId + connectorDefinitionVersion

InvalidSessionException - if the session is invalid, e.g. the session has expired.

Since:

6.0

executeConnectorOnCompletedProcessInstance

Map<String,Serializable> executeConnectorOnCompletedProcessInstance(String connectorDefinitionId,
                                                                  String connectorDefinitionVersion,
                                                                  Map<String,Expression> connectorInputParameters,
                                                                  Map<String,Map<String,Serializable>> inputValues,
                                                                  List<Operation> operations,
                                                                  Map<String,Serializable> operationsInputValues,
                                                                  long processInstanceId)
                                                                    throws ConnectorExecutionException,
                                                                           ConnectorNotFoundException

Execute connector in given process instance finished with operations.

Parameters:

connectorDefinitionId - Identifier of connector definition

connectorDefinitionVersion - version of the connector definition

connectorInputParameters - all expressions related with the connector

inputValues - all parameters values for expression need when evalute the connector

operations - map of operations having each a special context (input values)

operationsInputValues - the map of input name-value pairs used by operation executions.

processInstanceId - Identifier of the process instance

Returns:

a map with new values of elements set by the operations

Throws:

ConnectorExecutionException - if the connector failed to execute properly.

ConnectorNotFoundException - if the connector cannot be found with the provided connectorDefinitionId + connectorDefinitionVersion

InvalidSessionException - if the session is invalid, e.g. the session has expired.

Since:

6.0

executeConnectorOnProcessInstance

Map<String,Serializable> executeConnectorOnProcessInstance(String connectorDefinitionId,
                                                         String connectorDefinitionVersion,
                                                         Map<String,Expression> connectorInputParameters,
                                                         Map<String,Map<String,Serializable>> inputValues,
                                                         long processInstanceId)
                                                           throws ConnectorExecutionException,
                                                                  ConnectorNotFoundException

Execute connector in given process instance.

Parameters:

connectorDefinitionId - Identifier of connector definition

connectorDefinitionVersion - version of the connector definition

connectorInputParameters - all expressions related with the connector

inputValues - all parameters values for expression need when evalute the connector

processInstanceId - Identifier of the process instance

Returns:

a map with connector parameter name and parameter value object

Throws:

ConnectorExecutionException - if the connector failed to execute properly.

ConnectorNotFoundException - if the connector cannot be found with the provided connectorDefinitionId + connectorDefinitionVersion

InvalidSessionException - if the session is invalid, e.g. the session has expired.

Since:

6.0

executeConnectorOnProcessInstance

Map<String,Serializable> executeConnectorOnProcessInstance(String connectorDefinitionId,
                                                         String connectorDefinitionVersion,
                                                         Map<String,Expression> connectorInputParameters,
                                                         Map<String,Map<String,Serializable>> inputValues,
                                                         List<Operation> operations,
                                                         Map<String,Serializable> operationsInputValues,
                                                         long processInstanceId)
                                                           throws ConnectorExecutionException,
                                                                  ConnectorNotFoundException

Execute connector in given process instance with operations

Parameters:

connectorDefinitionId - Identifier of connector definition

connectorDefinitionVersion - version of the connector definition

connectorInputParameters - all expressions related with the connector

inputValues - all parameters values for expression need when evalute the connector

processInstanceId - Identifier of the process instance

operations - map of operations having each a special context (input values)

operationsInputValues - the map of input name-value pairs used by operation executions.

Returns:

a map with new values of elements set by the operations

Throws:

ConnectorExecutionException - if the connector failed to execute properly.

ConnectorNotFoundException - if the connector cannot be found with the provided connectorDefinitionId + connectorDefinitionVersion

InvalidSessionException - if the session is invalid, e.g. the session has expired.

Since:

6.0

updateProcessInstanceIndex

ProcessInstance updateProcessInstanceIndex(long processInstanceId,
                                         Index index,
                                         String value)
                                           throws ProcessInstanceNotFoundException,
                                                  UpdateException

Update an index of a process instance.

Parameters:

processInstanceId - identifier of the process instance

index - which index to update

value - the new value for the index

Returns:

the updated process instance

Throws:

ProcessInstanceNotFoundException - Error thrown if no process instance have an id corresponding to the value of processInstanceId parameter.

UpdateException - if an error is thrown while updating the process instance.

InvalidSessionException - if the session is invalid, e.g. the session has expired.

Since:

6.0

updateProcessInstance

ProcessInstance updateProcessInstance(long processInstanceId,
                                    ProcessInstanceUpdater updater)
                                      throws ProcessInstanceNotFoundException,
                                             UpdateException

Update an instance of process with the given processInstanceId.

Parameters:

processInstanceId - Identifier of the process instance

updater - including new value of all attributes adaptable

Returns:

the process instance updated

Throws:

ProcessInstanceNotFoundException - Error thrown if no process instance have an id corresponding to the value of processInstanceId parameter.

UpdateException - if an error is thrown while updating the process instance.

InvalidSessionException - if the session is invalid, e.g. the session has expired.

Since:

6.0

getConnectorInstanceWithFailureInformation

ConnectorInstanceWithFailureInfo getConnectorInstanceWithFailureInformation(long connectorInstanceId)
                                                                            throws ConnectorInstanceNotFoundException

Retrieves a ConnectorInstanceWithFailureInfo specified by its identifier.

Parameters:

connectorInstanceId - the identifier of the ConnectorInstanceWithFailureInfo to be retrieved.

Returns:

the ConnectorInstanceWithFailureInfo instance.

Throws:

ConnectorInstanceNotFoundException - if no ConnectorInstanceWithFailureInfo is found with the specified connectorInstanceId.

Since:

6.1

searchArchivedFlowNodeInstancesSupervisedBy

SearchResult<ArchivedFlowNodeInstance> searchArchivedFlowNodeInstancesSupervisedBy(long supervisorId,
                                                                                 SearchOptions searchOptions)
                                                                                   throws SearchException

Search for archived flow node instances (activities, gateways and events) supervised by the specified user.

Parameters:

supervisorId - The identifier of the supervising user.

searchOptions - The search options (pagination, filter, order sort).

Returns:

A SearchResult containing the search result.

Throws:

InvalidSessionException - If the session is invalid, e.g. the session has expired.

SearchException - If the search could not be completed correctly.

Since:

6.3

searchArchivedActivityInstancesSupervisedBy

SearchResult<ArchivedActivityInstance> searchArchivedActivityInstancesSupervisedBy(long supervisorId,
                                                                                 SearchOptions searchOptions)
                                                                                   throws SearchException

Search for archived flow node instances (activities, gateways and events) supervised by the specified user.

Parameters:

supervisorId - The identifier of the supervising user.

searchOptions - The search options (pagination, filter, order sort).

Returns:

A SearchResult containing the search result.

Throws:

InvalidSessionException - If the session is invalid, e.g. the session has expired.

SearchException - If the search could not be completed correctly.

Since:

6.3

searchFlowNodeInstancesSupervisedBy

SearchResult<FlowNodeInstance> searchFlowNodeInstancesSupervisedBy(long supervisorId,
                                                                 SearchOptions searchOptions)
                                                                   throws SearchException

Search for flow node instances (activities, gateways and events) supervised by the specified user.

Parameters:

supervisorId - The identifier of the supervising user.

searchOptions - The search options (pagination, filter, order sort).

Returns:

A SearchResult containing the search result.

Throws:

InvalidSessionException - If the session is invalid, e.g. the session has expired.

SearchException - If the search could not be completed correctly.

Since:

6.3