Interface | osid.resourcing.CommissionQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among 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 | getFoundryId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Foundry Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getFoundry | ||
Description |
Gets the | ||
Return | osid.resourcing.Foundry | the foundry | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchCommissions | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedFoundryView | ||
Description |
Federates the view for methods in this session. A federated view will include commissions in foundries which are children of this foundry in the foundry hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedFoundryView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts searches to this foundry only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getCommissionQuery | ||
Description |
Gets a commission query. | ||
Return | osid.resourcing.CommissionQuery | the commission query | |
Compliance | mandatory | This method must be implemented. | |
Method | getCommissionsByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.resourcing.CommissionQuery | commissionQuery | the commission query |
Return | osid.resourcing.CommissionList | the returned CommissionList | |
Errors | NULL_ARGUMENT | commissionQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | commissionQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |