OSID Logo
OSID Specifications
resourcing rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.rules.CommissionEnablerSearchSession
Implementsosid.resourcing.rules.CommissionEnablerQuerySession
Description

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

getCommissionEnablersByQuery() is the basic search method and returns a list of CommissionEnablers. A more advanced search may be performed with getCommissionEnablersBySearch(). It accepts a CommissionEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as resourcing. getCommissionEnablersBySearch() returns a CommissionEnablerSearchResults that can be used to access the resulting CommissionEnablerList or be used to perform a search within the result set through CommissionEnablerSearch.

This session defines views that offer differing behaviors for searching.

  • federated foundry view: searches include commission enabler in foundries of which this foundry is an ancestor in the foundry hierarchy
  • isolated foundry view: searches are restricted to commission enabler in this foundry

CommissionEnablers may have a commission enabler query record indicated by their respective record types. The commission enabler query record is accessed via the CommissionEnablerQuery.

MethodgetCommissionEnablerSearch
Description

Gets a commission enabler search.

Returnosid.resourcing.rules.CommissionEnablerSearchthe commission enabler search
CompliancemandatoryThis method must be implemented.
MethodgetCommissionEnablerSearchOrder
Description

Gets a commission enabler search order. The CommissionEnablerSearchOrder is supplied to a CommissionEnablerSearch to specify the ordering of results.

Returnosid.resourcing.rules.CommissionEnablerSearchOrderthe commission enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetCommissionEnablersBySearch
Description

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

Parametersosid.resourcing.rules.CommissionEnablerQuerycommissionEnablerQuerythe commission enabler query
osid.resourcing.rules.CommissionEnablerSearchcommissionEnablerSearchthe commission enabler search
Returnosid.resourcing.rules.CommissionEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT commissionEnablerQuery or commissionEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED commissionEnablerQuery or commissionEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCommissionEnablerQueryFromInspector
Description

Gets a commission enabler query from an inspector. The inspector is available from a CommissionEnablerSearchResults.

Parametersosid.resourcing.rules.CommissionEnablerQueryInspectorccommissionEnablerQueryInspectora commission enabler query inspector
Returnosid.resourcing.rules.CommissionEnablerQuerythe commission enabler query
ErrorsNULL_ARGUMENT commissionEnablerQueryInspector is null
UNSUPPORTED commissionEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.