OSID Logo
OSID Specifications
hold rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.rules.HoldEnablerSearchSession
Implementsosid.hold.rules.HoldEnablerQuerySession
Description

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

getHoldEnablersByQuery() is the basic search method and returns a list of HoldEnablers. A more advanced search may be performed with getHoldEnablersBySearch(). It accepts a HoldEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getHoldEnablersBySearch() returns a HoldEnablerSearchResults that can be used to access the resulting HoldEnablerList or be used to perform a search within the result set through HoldEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

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

MethodgetHoldEnablerSearch
Description

Gets a hold enabler search.

Returnosid.hold.rules.HoldEnablerSearchthe hold enabler search
CompliancemandatoryThis method must be implemented.
MethodgetHoldEnablerSearchOrder
Description

Gets a hold enabler search order. The HoldEnablerSearchOrder is supplied to a HoldEnablerSearch to specify the ordering of results.

Returnosid.hold.rules.HoldEnablerSearchOrderthe hold enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetHoldEnablersBySearch
Description

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

Parametersosid.hold.rules.HoldEnablerQueryholdEnablerQuerythe hold enabler query
osid.hold.rules.HoldEnablerSearchholdEnablerSearchthe hold enabler search
Returnosid.hold.rules.HoldEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT holdEnablerQuery or holdEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED holdEnablerQuery or holdEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetHoldEnablerQueryFromInspector
Description

Gets a hold enabler query from an inspector. The inspector is available from a HoldEnablerSearchResults.

Parametersosid.hold.rules.HoldEnablerQueryInspectorholdEnablerQueryInspectora hold enabler query inspector
Returnosid.hold.rules.HoldEnablerQuerythe hold enabler query
ErrorsNULL_ARGUMENT holdEnablerQueryInspector is null
UNSUPPORTED holdEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.