Uses of Interface
org.bonitasoft.engine.search.SearchOptions

Packages that use SearchOptions

Package	Description
com.bonitasoft.engine.api	The Bonita BPM project has a clear separation between the API the users should be interacting with and the actual implementation classes.
org.bonitasoft.engine.api	The Bonita BPM project has a clear separation between the API the users should be interacting with and the actual implementation classes.
org.bonitasoft.engine.search	Contains classes to use when invoking search methods

Uses of SearchOptions in com.bonitasoft.engine.api

Methods in com.bonitasoft.engine.api with parameters of type SearchOptions

Modifier and Type	Method and Description
SearchResult<ApplicationMenu>	ApplicationAPI.searchApplicationMenus(SearchOptions searchOptions) Searches for ApplicationMenus with specific search criteria.
SearchResult<ApplicationPage>	ApplicationAPI.searchApplicationPages(SearchOptions searchOptions) Searches for ApplicationPages with specific search criteria.
SearchResult<Application>	ApplicationAPI.searchApplications(SearchOptions searchOptions) Searches for Applications with specific search criteria.
SearchResult<ArchivedActivityInstance>	ProcessRuntimeAPI.searchArchivedActivityInstancesSupervisedBy(long supervisorId, SearchOptions searchOptions) Search for archived flow node instances (activities, gateways and events) supervised by the specified user.
SearchResult<ArchivedFlowNodeInstance>	ProcessRuntimeAPI.searchArchivedFlowNodeInstancesSupervisedBy(long supervisorId, SearchOptions searchOptions) Search for archived flow node instances (activities, gateways and events) supervised by the specified user.
SearchResult<FlowNodeInstance>	ProcessRuntimeAPI.searchFlowNodeInstancesSupervisedBy(long supervisorId, SearchOptions searchOptions) Search for flow node instances (activities, gateways and events) supervised by the specified user.
SearchResult<Log>	LogAPI.searchLogs(SearchOptions searchOptions) Searches logs according to the criteria containing in the options.
SearchResult<Page>	PageAPI.searchPages(SearchOptions searchOptions) Searches for pages with specific search criteria.
SearchResult<Report>	ReportingAPI.searchReports(SearchOptions searchOptions) Searches for reports with specific search criteria.
SearchResult<Tenant>	PlatformAPI.searchTenants(SearchOptions searchOptions) Search tenant under the given condition, including pagination, term, filter, sort.

Uses of SearchOptions in org.bonitasoft.engine.api

Methods in org.bonitasoft.engine.api with parameters of type SearchOptions

Modifier and Type	Method and Description
long	ProcessRuntimeAPI.countAttachments(SearchOptions searchOptions) Get the number of attachments matching the search conditions.
long	ProcessRuntimeAPI.countComments(SearchOptions searchOptions) Get the number of comments matching the search conditions.
SearchResult<ActivityInstance>	ProcessRuntimeAPI.searchActivities(SearchOptions searchOptions) Search for activity instances.
SearchResult<ArchivedActivityInstance>	ProcessRuntimeAPI.searchArchivedActivities(SearchOptions searchOptions) Search for archived activity instances in terminal states.
SearchResult<ArchivedComment>	ProcessRuntimeAPI.searchArchivedComments(SearchOptions searchOptions) Search for archived comments.
SearchResult<ArchivedConnectorInstance>	ProcessRuntimeAPI.searchArchivedConnectorInstances(SearchOptions searchOptions) Search for archived connector instances.
SearchResult<ArchivedDocument>	DocumentAPI.searchArchivedDocuments(SearchOptions searchOptions) Search for archived documents that meet the search options.
SearchResult<ArchivedDocument>	DocumentAPI.searchArchivedDocumentsSupervisedBy(long userId, SearchOptions searchOptions) Search for archived documents that match the search options and are supervised by the specified user.
SearchResult<ArchivedFlowNodeInstance>	ProcessRuntimeAPI.searchArchivedFlowNodeInstances(SearchOptions searchOptions) Search for archived flow node instances (activities, gateways and events)
SearchResult<ArchivedHumanTaskInstance>	ProcessRuntimeAPI.searchArchivedHumanTasks(SearchOptions searchOptions) Search the archived human tasks for tasks that match the search options.
SearchResult<ArchivedHumanTaskInstance>	ProcessRuntimeAPI.searchArchivedHumanTasksManagedBy(long managerUserId, SearchOptions searchOptions) Search for archived human tasks managed by the specified user.
SearchResult<ArchivedHumanTaskInstance>	ProcessRuntimeAPI.searchArchivedHumanTasksSupervisedBy(long supervisorId, SearchOptions searchOptions) Search for archived tasks assigned to users supervised by the specified user.
SearchResult<ArchivedProcessInstance>	ProcessRuntimeAPI.searchArchivedProcessInstances(SearchOptions searchOptions) Search for archived root process instances.
SearchResult<ArchivedProcessInstance>	ProcessRuntimeAPI.searchArchivedProcessInstancesInAllStates(SearchOptions searchOptions) Search for archived process instances (root and intermediate levels) in all states (even intermediate states).
SearchResult<ArchivedProcessInstance>	ProcessRuntimeAPI.searchArchivedProcessInstancesInvolvingUser(long userId, SearchOptions searchOptions) Search for archived process instances that the specified user can access.
SearchResult<ArchivedProcessInstance>	ProcessRuntimeAPI.searchArchivedProcessInstancesSupervisedBy(long userId, SearchOptions searchOptions) Search for archived process instances supervised by the specified user.
SearchResult<HumanTaskInstance>	ProcessRuntimeAPI.searchAssignedAndPendingHumanTasks(long rootProcessDefinitionId, SearchOptions searchOptions) Search the assigned and pending human tasks for any user, on the specified root process definition, corresponding to the options.
SearchResult<HumanTaskInstance>	ProcessRuntimeAPI.searchAssignedAndPendingHumanTasksFor(long rootProcessDefinitionId, long userId, SearchOptions searchOptions) Search the assigned and pending human tasks for the specified user, on the specified root process definition, corresponding to the options.
SearchResult<HumanTaskInstance>	ProcessRuntimeAPI.searchAssignedTasksManagedBy(long managerUserId, SearchOptions searchOptions) Search the assigned human tasks for tasks that match the search options and are administered by the specified user.
SearchResult<HumanTaskInstance>	ProcessRuntimeAPI.searchAssignedTasksSupervisedBy(long supervisorId, SearchOptions searchOptions) Search for tasks assigned to users supervised by the specified user.
SearchResult<CommandDescriptor>	CommandAPI.searchCommands(SearchOptions searchOptions) Search commands corresponding to the criteria.
SearchResult<Comment>	ProcessRuntimeAPI.searchComments(SearchOptions searchOptions) Search for comments related to the specified process instance.
SearchResult<Comment>	ProcessRuntimeAPI.searchCommentsInvolvingUser(long userId, SearchOptions searchOptions) Get the comments on process instances that the specified user can access.
SearchResult<Comment>	ProcessRuntimeAPI.searchCommentsManagedBy(long managerUserId, SearchOptions searchOptions) Get all the comments managed by the specified user.
SearchResult<ConnectorInstance>	ProcessRuntimeAPI.searchConnectorInstances(SearchOptions searchOptions) Search for connector instances.
SearchResult<CustomUserInfoValue>	CustomUserInfoAPI.searchCustomUserInfoValues(SearchOptions options) Searches CustomUserInfoValues according to the criteria contained in the given SearchOptions.
SearchResult<Document>	DocumentAPI.searchDocuments(SearchOptions searchOptions) Search for documents that match the search options.
SearchResult<Document>	DocumentAPI.searchDocumentsSupervisedBy(long userId, SearchOptions searchOptions) Search for documents that match the search options and are supervised by the specified user.
SearchResult<ProcessInstance>	ProcessRuntimeAPI.searchFailedProcessInstances(SearchOptions searchOptions) List all process instances with at least one failed task or the ProcessInstanceState.ERROR state.
SearchResult<FlowNodeInstance>	ProcessRuntimeAPI.searchFlowNodeInstances(SearchOptions searchOptions) Search for flow node instances (activities, gateways and events).
SearchResult<Group>	GroupAPI.searchGroups(SearchOptions options) Searches groups according to the criteria containing in the options.
SearchResult<HumanTaskInstance>	ProcessRuntimeAPI.searchHumanTaskInstances(SearchOptions searchOptions) Search for human task instances.
SearchResult<HumanTaskInstance>	ProcessRuntimeAPI.searchMyAvailableHumanTasks(long userId, SearchOptions searchOptions) Search for all tasks available to a specified user.
SearchResult<ProcessInstance>	ProcessRuntimeAPI.searchOpenProcessInstances(SearchOptions searchOptions) List all open root process instances.
SearchResult<ProcessInstance>	ProcessRuntimeAPI.searchOpenProcessInstancesInvolvingUser(long userId, SearchOptions searchOptions) Search for open process instances that the specified user can access.
SearchResult<ProcessInstance>	ProcessRuntimeAPI.searchOpenProcessInstancesInvolvingUsersManagedBy(long managerUserId, SearchOptions searchOptions) Search for open process instances that all subordinates of the specified user can access.
SearchResult<ProcessInstance>	ProcessRuntimeAPI.searchOpenProcessInstancesSupervisedBy(long userId, SearchOptions searchOptions) List all open process instances supervised by a user.
SearchResult<HumanTaskInstance>	ProcessRuntimeAPI.searchPendingHiddenTasks(long userId, SearchOptions searchOptions) Search for pending hidden tasks that are available to the specified user.
SearchResult<HumanTaskInstance>	ProcessRuntimeAPI.searchPendingTasksForUser(long userId, SearchOptions searchOptions) Search the pending human tasks for tasks available to the specified user.
SearchResult<HumanTaskInstance>	ProcessRuntimeAPI.searchPendingTasksManagedBy(long managerUserId, SearchOptions searchOptions) Search the pending human tasks for tasks that match the search options and are managed by the specified user.
SearchResult<HumanTaskInstance>	ProcessRuntimeAPI.searchPendingTasksSupervisedBy(long userId, SearchOptions searchOptions) Search the pending human tasks for tasks that match the search options and are supervised by the specified user.
SearchResult<ProcessDeploymentInfo>	ProcessManagementAPI.searchProcessDeploymentInfos(long userId, SearchOptions searchOptions) Deprecated. since 6.3.3
SearchResult<ProcessDeploymentInfo>	ProcessManagementAPI.searchProcessDeploymentInfos(SearchOptions searchOptions) Searches for the number and the list of process definitions.
SearchResult<ProcessDeploymentInfo>	ProcessManagementAPI.searchProcessDeploymentInfosCanBeStartedBy(long userId, SearchOptions searchOptions) Searches for the number and the list of processes that the user can start.
SearchResult<ProcessDeploymentInfo>	ProcessManagementAPI.searchProcessDeploymentInfosCanBeStartedByUsersManagedBy(long managerUserId, SearchOptions searchOptions) TODO do not understand the behavior of this Search for all process definitions that can be started by users managed by a specific user.
SearchResult<ProcessDeploymentInfo>	ProcessManagementAPI.searchProcessDeploymentInfosStartedBy(long userId, SearchOptions searchOptions) Searches for the number and the list of processes which have been recently started by the user.
SearchResult<ProcessDeploymentInfo>	ProcessManagementAPI.searchProcessDeploymentInfosSupervisedBy(long userId, SearchOptions searchOptions) Searches the number and the list of processes supervised by the user.
SearchResult<ProcessDeploymentInfo>	ProcessManagementAPI.searchProcessDeploymentInfosUsersManagedByCanStart(long managerUserId, SearchOptions searchOptions) Deprecated. 6.3.3
SearchResult<ProcessDeploymentInfo>	ProcessRuntimeAPI.searchProcessDeploymentInfosWithAssignedOrPendingHumanTasks(SearchOptions searchOptions) Search process definitions that have instances with assigned or pending human tasks.
SearchResult<ProcessDeploymentInfo>	ProcessRuntimeAPI.searchProcessDeploymentInfosWithAssignedOrPendingHumanTasksFor(long userId, SearchOptions searchOptions) Search process definitions that have instances with assigned or pending human tasks for a specific user.
SearchResult<ProcessDeploymentInfo>	ProcessRuntimeAPI.searchProcessDeploymentInfosWithAssignedOrPendingHumanTasksSupervisedBy(long supervisorId, SearchOptions searchOptions) Search process definitions supervised by a specific user, that have instances with assigned or pending human tasks.
SearchResult<ProcessInstance>	ProcessRuntimeAPI.searchProcessInstances(SearchOptions searchOptions) List all process instances.
SearchResult<ProcessSupervisor>	ProcessManagementAPI.searchProcessSupervisors(SearchOptions searchOptions) Searches for the number and the list of processes supervisors.
SearchResult<ProfileEntry>	ProfileAPI.searchProfileEntries(SearchOptions options) Searches profile entries according to the criteria containing in the options.
SearchResult<ProfileMember>	ProfileAPI.searchProfileMembers(String memberType, SearchOptions options) Searches profile members according to the criteria containing in the options.
SearchResult<Profile>	ProfileAPI.searchProfiles(SearchOptions options) Searches profiles according to the criteria containing in the options.
SearchResult<Role>	RoleAPI.searchRoles(SearchOptions options) Searches roles according to the criteria containing in the options.
SearchResult<TimerEventTriggerInstance>	ProcessRuntimeAPI.searchTimerEventTriggerInstances(long processInstanceId, SearchOptions searchOptions) Search the TimerEventTriggerInstance on the specific ProcessInstance.
SearchResult<ProcessDeploymentInfo>	ProcessManagementAPI.searchUncategorizedProcessDeploymentInfos(SearchOptions searchOptions) Searches for the number and the list of uncategorized processes.
SearchResult<ProcessDeploymentInfo>	ProcessManagementAPI.searchUncategorizedProcessDeploymentInfosCanBeStartedBy(long userId, SearchOptions searchOptions) Searches the number and the list of processes that the user can start which have no category.
SearchResult<ProcessDeploymentInfo>	ProcessManagementAPI.searchUncategorizedProcessDeploymentInfosSupervisedBy(long userId, SearchOptions searchOptions) Searches for the number and the list of uncategorized processes supervised by the user.
SearchResult<ProcessDeploymentInfo>	ProcessManagementAPI.searchUncategorizedProcessDeploymentInfosUserCanStart(long userId, SearchOptions searchOptions) Deprecated.
SearchResult<User>	UserAPI.searchUsers(SearchOptions options) Searches users according to the criteria containing in the options.
SearchResult<User>	ProcessRuntimeAPI.searchUsersWhoCanExecutePendingHumanTask(long humanTaskInstanceId, SearchOptions searchOptions) Lists the possible users (candidates) that can execute the specified human task instance.
SearchResult<User>	ProcessManagementAPI.searchUsersWhoCanStartProcessDefinition(long processDefinitionId, SearchOptions searchOptions) Searches for the number and the list of users who can start the process.

Uses of SearchOptions in org.bonitasoft.engine.search

Methods in org.bonitasoft.engine.search that return SearchOptions

Modifier and Type	Method and Description
SearchOptions	SearchOptionsBuilder.done()

Constructors in org.bonitasoft.engine.search with parameters of type SearchOptions

Constructor and Description
SearchOptionsBuilder(SearchOptions searchOptions) Creates a new SearchOptionsBuilder from another instance by