OSID Logo
OSID Specifications
workflow rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.rules.StepConstrainerEnablerSearchSession
Implementsosid.workflow.rules.StepConstrainerEnablerQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetStepConstrainerEnablerSearch
Description

Gets a step constrainer enabler search.

Returnosid.workflow.rules.StepConstrainerEnablerSearchthe step constrainer enabler search
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerEnablerSearchOrder
Description

Gets a step constrainer enabler search order. The StepConstrainerEnablerSearchOrder is supplied to a StepConstrainerEnablerSearch to specify the ordering of results.

Returnosid.workflow.rules.StepConstrainerEnablerSearchOrderthe step constrainer enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerEnablersBySearch
Description

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

Parametersosid.workflow.rules.StepConstrainerEnablerQuerystepConstrainerEnablerQuerythe step constrainer enabler query
osid.workflow.rules.StepConstrainerEnablerSearchstepConstrainerEnablerSearchthe step constrainer enabler search
Returnosid.workflow.rules.StepConstrainerEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT stepConstrainerEnablerQuery or stepConstrainerEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED stepConstrainerEnablerQuery or stepConstrainerEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerEnablerQueryFromInspector
Description

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

Parametersosid.workflow.rules.StepConstrainerEnablerQueryInspectorstepConstrainerEnablerQueryInspectora step constrainer enabler query inspector
Returnosid.workflow.rules.StepConstrainerEnablerQuerythe step constrainer enabler query
ErrorsNULL_ARGUMENT stepConstrainerEnablerQueryInspector is null
UNSUPPORTED stepConstrainerEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.