| Interface | osid.resourcing.CommissionSearchSession | ||
|---|---|---|---|
| Implements | osid.resourcing.CommissionQuerySession | ||
| Used By | osid.resourcing.ResourcingManager | ||
osid.resourcing.ResourcingProxyManager | |||
| Description |
This session provides methods for searching among
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.
Commissions may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
| Method | getCommissionSearch | ||
| Description |
Gets a commission search. | ||
| Return | osid.resourcing.CommissionSearch | the commission search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCommissionSearchOrder | ||
| Description |
Gets a commission search order. The
| ||
| Return | osid.resourcing.CommissionSearchOrder | the commission search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCommissionsBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.resourcing.CommissionQuery | commissionQuery | the commission query |
osid.resourcing.CommissionSearch | commissionSearch | the commission search | |
| Return | osid.resourcing.CommissionSearchResults | the returned search results | |
| Errors | NULL_ARGUMENT | commissionQuery or commissionSearch is
null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | commissionQuery or commissionSearch is not of
this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCommissionQueryFromInspector | ||
| Description |
Gets a commission query from an inspector. The
inspector is available from a
| ||
| Parameters | osid.resourcing.CommissionQueryInspector | commissionQueryInspector | a commission query inspector |
| Return | osid.resourcing.CommissionQuery | the commission query | |
| Errors | NULL_ARGUMENT | commissionQueryInspector is null | |
| UNSUPPORTED | commissionQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |