Interface | osid.resourcing.CommissionLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most
applications as it permits operation even if there is data
that cannot be accessed. The methods | ||
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 | canLookupCommissions | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeCommissionView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryCommissionView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is 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 lookups to this foundry only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useEffectiveCommissionView | ||
Description |
Only commissions whose effective dates are current are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyEffectiveCommissionView | ||
Description |
All commissions of any effective dates are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getCommission | ||
Description |
Gets the In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned. | ||
Parameters | osid.id.Id | commissionId | Id of the Commission |
Return | osid.resourcing.Commission | the commission | |
Errors | NOT_FOUND | commissionId not found | |
NULL_ARGUMENT | commissionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getCommissionsByIds | ||
Description |
Gets a In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned. | ||
Parameters | osid.id.IdList | commissionIds | the list of Ids to retrieve |
Return | osid.resourcing.CommissionList | the returned Commission list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | commissionIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommissionsByGenusType | ||
Description |
Gets a In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned. | ||
Parameters | osid.type.Type | commissionGenusType | a commission genus type |
Return | osid.resourcing.CommissionList | the returned Commission list | |
Errors | NULL_ARGUMENT | commissionGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommissionsByParentGenusType | ||
Description |
Gets a In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned. | ||
Parameters | osid.type.Type | commissionGenusType | a commission genus type |
Return | osid.resourcing.CommissionList | the returned Commission list | |
Errors | NULL_ARGUMENT | commissionGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommissionsByRecordType | ||
Description |
Gets a In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned. | ||
Parameters | osid.type.Type | commissionRecordType | a commission record type |
Return | osid.resourcing.CommissionList | the returned Commission list | |
Errors | NULL_ARGUMENT | commissionRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommissionsOnDate | ||
Description |
Gets a list of commissions effective during the entire
given date range inclusive but not confined to the date
range. In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned. | ||
Parameters | osid.calendaring.DateTime | from | start of date range |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.resourcing.CommissionList | the returned Commission list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommissionsForResource | ||
Description |
Gets a list of commissions for a resource. In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.resourcing.CommissionList | the returned Commission list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommissionsForResourceOnDate | ||
Description |
Gets a list of commissions for a resource and effective
during the entire given date range inclusive but not
confined to the date range. In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.resourcing.CommissionList | the returned Commission list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | resourceId, from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommissionsForWork | ||
Description |
Gets a list of commissions for a work. In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned. | ||
Parameters | osid.id.Id | workId | a work Id |
Return | osid.resourcing.CommissionList | the returned C ommission list | |
Errors | NULL_ARGUMENT | workId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommissionsForWorkOnDate | ||
Description |
Gets a list of commissions for a work and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session. In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned. | ||
Parameters | osid.id.Id | workId | a work Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.resourcing.CommissionList | the returned C ommission list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | workId, from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommissionsForResourceAndWork | ||
Description |
Gets a list of commissions for a resource and work.
In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.id.Id | workId | a work Id | |
Return | osid.resourcing.CommissionList | the returned C ommission list | |
Errors | NULL_ARGUMENT | resourceId or workId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommissionsForResourceAndWorkOnDate | ||
Description |
Gets a list of commissions for a resource and work and effective during the entire given date range inclusive but not confined to the date range. In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.id.Id | workId | a work Id | |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.resourcing.CommissionList | the returned C ommission list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | resourceId, workId, from or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommissions | ||
Description |
Gets all In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session. In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned. | ||
Return | osid.resourcing.CommissionList | a list of Commissions | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |