OSID Logo
OSID Specifications
workflow rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.rules.ProcessEnablerSearchSession
Implementsosid.workflow.rules.ProcessEnablerQuerySession
Description

This session provides methods for searching among ProcessEnabler objects. The search query is constructed using the ProcessEnableryQuery.

getProcessEnablersByQuery() is the basic search method and returns a list of ProcessEnablers. A more advanced search may be performed with getProcessEnablersBySearch(). It accepts a ProcessEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as workflow. getProcessEnablersBySearch() returns a ProcessEnablerSearchResults that can be used to access the resulting ProcessEnablerList or be used to perform a search within the result set through ProcessEnablerSearch.

This session defines views that offer differing behaviors for searching.

  • federated office view: searches include process enabler in office of which this office is an ancestor in the office hierarchy
  • isolated office view: searches are restricted to process enabler in this office

ProcessEnablers may have a query record indicated by their respective record types. The query record is accessed via the ProcessEnablerQuery.

MethodgetProcessEnablerSearch
Description

Gets a process enabler search.

Returnosid.workflow.rules.ProcessEnablerSearchthe process enabler search
CompliancemandatoryThis method must be implemented.
MethodgetProcessEnablerSearchOrder
Description

Gets a process enabler search order. The ProcessEnablerSearchOrder is supplied to a ProcessEnablerSearch to specify the ordering of results.

Returnosid.workflow.rules.ProcessEnablerSearchOrderthe process enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetProcessEnablersBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.workflow.rules.ProcessEnablerQueryprocessEnablerQuerythe process enabler query
osid.workflow.rules.ProcessEnablerSearchprocessEnablerSearchthe process enabler search
Returnosid.workflow.rules.ProcessEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT processEnablerQuery or processEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED processEnablerQuery or processEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProcessEnablerQueryFromInspector
Description

Gets a process enabler query from an inspector. The inspector is available from a ProcessEnablerSearchResults.

Parametersosid.workflow.rules.ProcessEnablerQueryInspectorprocessEnablerQueryInspectora process enabler query inspector
Returnosid.workflow.rules.ProcessEnablerQuerythe process enabler query
ErrorsNULL_ARGUMENT processEnablerQueryInspector is null
UNSUPPORTED processEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.