OSID Logo
OSID Specifications
workflow rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.rules.StepProcessorSearchSession
Implementsosid.workflow.rules.StepProcessorQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

StepProcessors may have a query record indicated by their respective record types. Thequery record is accessed via the StepProcessorQuery.

MethodgetStepProcessorSearch
Description

Gets a step processor search.

Returnosid.workflow.rules.StepProcessorSearchthe step processor search
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorSearchOrder
Description

Gets a step processor search order. The StepProcessorSearchOrder is supplied to a StepProcessorSearch to specify the ordering of results.

Returnosid.workflow.rules.StepProcessorSearchOrderthe step processor search order
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorsBySearch
Description

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

Parametersosid.workflow.rules.StepProcessorQuerystepProcessorQuerythe step processor query
osid.workflow.rules.StepProcessorSearchstepProcessorSearchthe step processor search
Returnosid.workflow.rules.StepProcessorSearchResultsthe returned search results
ErrorsNULL_ARGUMENT stepProcessorQuery or stepProcessorSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED stepProcessorQuery or stepProcessorSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorQueryFromInspector
Description

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

Parametersosid.workflow.rules.StepProcessorQueryInspectorstepProcessorQueryInspectora step processor query inspector
Returnosid.workflow.rules.StepProcessorQuerythe step processor query
ErrorsNULL_ARGUMENT stepProcessorQueryInspector is null
UNSUPPORTED stepProcessorQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.