OSID Logo
OSID Specifications
workflow rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.rules.StepProcessorEnablerSearchSession
Implementsosid.workflow.rules.StepProcessorEnablerQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetStepProcessorEnablerSearch
Description

Gets a step processor enabler search.

Returnosid.workflow.rules.StepProcessorEnablerSearchthe step processor enabler search
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorEnablerSearchOrder
Description

Gets a step processor enabler search order. The StepProcessorEnablerSearchOrder is supplied to a StepProcessorEnablerSearch to specify the ordering of results.

Returnosid.workflow.rules.StepProcessorEnablerSearchOrderthe step processor enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorEnablersBySearch
Description

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

Parametersosid.workflow.rules.StepProcessorEnablerQuerystepProcessorEnablerQuerythe step processor enabler query
osid.workflow.rules.StepProcessorEnablerSearchstepProcessorEnablerSearchthe step processor enabler search
Returnosid.workflow.rules.StepProcessorEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT stepProcessorEnablerQuery or stepProcessorEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED stepProcessorEnablerQuery or stepProcessorEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorEnablerQueryFromInspector
Description

Gets a step processor enabler query from an inspector. The inspector is available from a StepProcessorEnablerSearchResults.

Parametersosid.workflow.rules.StepProcessorEnablerQueryInspectorstepProcessorEnablerQueryInspectora step processor enabler query inspector
Returnosid.workflow.rules.StepProcessorEnablerQuerythe step processor enabler query
ErrorsNULL_ARGUMENT stepProcessorEnablerQueryInspector is null
UNSUPPORTED stepProcessorEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.