OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.PoolConstrainerEnablerSearchSession
Implementsosid.provisioning.rules.PoolConstrainerEnablerQuerySession
Description

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

getPoolConstrainerEnablersByQuery() is the basic search method and returns a list of PoolConstrainerEnablers. A more advanced search may be performed with getPoolConstrainerEnablersBySearch(). It accepts a PoolConstrainerEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as provisioning. getPoolConstrainerEnablersBySearch() returns a PoolConstrainerEnablerSearchResults that can be used to access the resulting PoolConstrainerEnablerList or be used to perform a search within the result set through PoolConstrainerEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

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

MethodgetPoolConstrainerEnablerSearch
Description

Gets a pool constrainer enabler search.

Returnosid.provisioning.rules.PoolConstrainerEnablerSearchthe pool constrainer enabler search
CompliancemandatoryThis method must be implemented.
MethodgetPoolConstrainerEnablerSearchOrder
Description

Gets a pool constrainer enabler search order. The PoolConstrainerEnablerSearchOrder is supplied to a PoolConstrainerEnablerSearch to specify the ordering of results.

Returnosid.provisioning.rules.PoolConstrainerEnablerSearchOrderthe pool constrainer enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetPoolConstrainerEnablersBySearch
Description

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

Parametersosid.provisioning.rules.PoolConstrainerEnablerQuerypoolConstrainerEnablerQuerythe pool constrainer enabler query
osid.provisioning.rules.PoolConstrainerEnablerSearchpoolConstrainerEnablerSearchthe pool constrainer enabler search
Returnosid.provisioning.rules.PoolConstrainerEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT poolConstrainerEnablerQuery or poolConstrainerEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED poolConstrainerEnablerQuery or poolConstrainerEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPoolConstrainerEnablerQueryFromInspector
Description

Gets a pool constrainer enabler query from an inspector. The inspector is available from a PoolConstrainerEnablerSearchResults.

Parametersosid.provisioning.rules.PoolConstrainerEnablerQueryInspectorpoolConstrainerEnablerQueryInspectora pool constrainer enabler query inspector
Returnosid.provisioning.rules.PoolConstrainerEnablerQuerythe pool constrainer enabler query
ErrorsNULL_ARGUMENT poolConstrainerEnablerQueryInspector is null
UNSUPPORTED poolConstrainerEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.