OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.ProvisionableSearchSession
Implementsosid.provisioning.ProvisionableQuerySession
Description

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

getProvisionablesByQuery() is the basic search method and returns a list of Provisionables. A more advanced search may be performed with getProvisionablesBySearch(). It accepts an ProvisionableSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getProvisionablesBySearch() returns an ProvisionableSearchResults that can be used to access the resulting ProvisionableList or be used to perform a search within the result set through ProvisionableSearch.

This session defines views that offer differing behaviors for searching.

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

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

MethodgetProvisionableSearch
Description

Gets a provisionable search.

Returnosid.provisioning.ProvisionableSearchthe provisionable search
CompliancemandatoryThis method must be implemented.
MethodgetProvisionableSearchOrder
Description

Gets a provisionable search order. The ProvisionableSearchOrder is supplied to a ProvisionableSearch to specify the ordering of results.

Returnosid.provisioning.ProvisionableSearchOrderthe provisionable search order
CompliancemandatoryThis method must be implemented.
MethodgetProvisionablesBySearch
Description

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

Parametersosid.provisioning.ProvisionableQueryprovisionableQuerythe provisionable query
osid.provisioning.ProvisionableSearchprovisionableSearchthe provisionable search
Returnosid.provisioning.ProvisionableSearchResultsthe returned search results
ErrorsNULL_ARGUMENT provisionableQuery or provisionableSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED provisionableQuery or provisionableSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProvisionableQueryFromInspector
Description

Gets a provisionable query from an inspector. The inspector is available from a ProvisionableSearchResults.

Parametersosid.provisioning.ProvisionableQueryInspectorprovisionableQueryInspectora provisionable query inspector
Returnosid.provisioning.ProvisionableQuerythe provisionable query
ErrorsNULL_ARGUMENT provisionableQueryInspector is null
UNSUPPORTED provisionableQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.