OSID Logo
OSID Specifications
workflow rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.rules.StepConstrainerSearchSession
Implementsosid.workflow.rules.StepConstrainerQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetStepConstrainerSearch
Description

Gets a step constrainer search.

Returnosid.workflow.rules.StepConstrainerSearchthe step constrainer search
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerSearchOrder
Description

Gets a step constrainer search order. The StepConstrainerSearchOrder is supplied to a StepConstrainerSearch to specify the ordering of results.

Returnosid.workflow.rules.StepConstrainerSearchOrderthe step constrainer search order
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainersBySearch
Description

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

Parametersosid.workflow.rules.StepConstrainerQuerystepConstrainerQuerythe step constrainer query
osid.workflow.rules.StepConstrainerSearchstepConstrainerSearchthe step constrainer search
Returnosid.workflow.rules.StepConstrainerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT stepConstrainerQuery or stepConstrainerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED stepConstrainerQuery or stepConstrainerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerQueryFromInspector
Description

Gets a step constrainer query from an inspector. The inspector is available from a StepConstrainerSearchResults.

Parametersosid.workflow.rules.StepConstrainerQueryInspectorstepConstrainerQueryInspectora step constrainer query inspector
Returnosid.workflow.rules.StepConstrainerQuerythe step constrainer query
ErrorsNULL_ARGUMENT stepConstrainerQueryInspector is null
UNSUPPORTED stepConstrainerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.