OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.CommissionSearchSession
Implementsosid.resourcing.CommissionQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetCommissionSearch
Description

Gets a commission search.

Returnosid.resourcing.CommissionSearchthe commission search
CompliancemandatoryThis method must be implemented.
MethodgetCommissionSearchOrder
Description

Gets a commission search order. The CommissionSearchOrder is supplied to a CommissionSearch to specify the ordering of results.

Returnosid.resourcing.CommissionSearchOrderthe commission search order
CompliancemandatoryThis method must be implemented.
MethodgetCommissionsBySearch
Description

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

Parametersosid.resourcing.CommissionQuerycommissionQuerythe commission query
osid.resourcing.CommissionSearchcommissionSearchthe commission search
Returnosid.resourcing.CommissionSearchResultsthe returned search results
ErrorsNULL_ARGUMENT commissionQuery or commissionSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED commissionQuery or commissionSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCommissionQueryFromInspector
Description

Gets a commission query from an inspector. The inspector is available from a CommissionSearchResults.

Parametersosid.resourcing.CommissionQueryInspectorcommissionQueryInspectora commission query inspector
Returnosid.resourcing.CommissionQuerythe commission query
ErrorsNULL_ARGUMENT commissionQueryInspector is null
UNSUPPORTED commissionQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.