| Interface | osid.resourcing.rules.CommissionEnablerQuerySession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Commission enablers may have a commission enabler query
record indicated by their respective record types. The
commission enabler 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 | canSearchCommissionEnablers | ||
| 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 commission enabler in foundries which are children of this job 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 lookups to this foundry only. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getCommissionEnablerQuery | ||
| Description |
Gets a commission enabler query. | ||
| Return | osid.resourcing.rules.CommissionEnablerQuery | the commission enabler query | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCommissionEnablersByQuery | ||
| Description |
Gets a list of | ||
| Parameters | osid.resourcing.rules.CommissionEnablerQuery | commissionEnablerQuery | the commission enabler query |
| Return | osid.resourcing.rules.CommissionEnablerList | the returned CommissionEnablerList | |
| Errors | NULL_ARGUMENT | commissionEnablerQuery is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | commissionEnablerQuery is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |