Interface | osid.resourcing.EffortLookupSession | ||
---|---|---|---|
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 | canLookupEfforts | ||
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 | useComparativeEffortView | ||
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 | usePlenaryEffortView | ||
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 efforts 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 | useEffectiveEffortView | ||
Description |
Only efforts whose effective dates are current are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyEffectiveEffortView | ||
Description |
All efforts of any effective dates are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getEffort | ||
Description |
Gets the In effective mode, efforts are returned that are currently effective. In any effective mode, effective efforts and those currently expired are returned. | ||
Parameters | osid.id.Id | effortId | Id of the Effort |
Return | osid.resourcing.Effort | the effort | |
Errors | NOT_FOUND | effortId not found | |
NULL_ARGUMENT | effortId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getEffortsByIds | ||
Description |
Gets an In effective mode, efforts are returned that are currently effective. In any effective mode, effective efforts and those currently expired are returned. | ||
Parameters | osid.id.IdList | effortIds | the list of Ids to retrieve |
Return | osid.resourcing.EffortList | the returned Effort list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | effortIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEffortsByGenusType | ||
Description |
Gets an In effective mode, efforts are returned that are currently effective. In any effective mode, effective efforts and those currently expired are returned. | ||
Parameters | osid.type.Type | effortGenusType | an effort genus type |
Return | osid.resourcing.EffortList | the returned Effort list | |
Errors | NULL_ARGUMENT | effortGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEffortsByParentGenusType | ||
Description |
Gets an In effective mode, efforts are returned that are currently effective. In any effective mode, effective efforts and those currently expired are returned. | ||
Parameters | osid.type.Type | effortGenusType | an effort genus type |
Return | osid.resourcing.EffortList | the returned Effort list | |
Errors | NULL_ARGUMENT | effortGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEffortsByRecordType | ||
Description |
Gets an In effective mode, efforts are returned that are currently effective. In any effective mode, effective efforts and those currently expired are returned. | ||
Parameters | osid.type.Type | effortRecordType | an effort record type |
Return | osid.resourcing.EffortList | the returned Effort list | |
Errors | NULL_ARGUMENT | effortRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEffortsOnDate | ||
Description |
Gets a list of efforts effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known efforts or an error results. Otherwise, the returned list may contain only those efforts that are accessible through this session. In effective mode, efforts are returned that are currently effective. In any effective mode, effective efforts 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.EffortList | the returned Effort 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 | getEffortsForResource | ||
Description |
Gets a list of efforts for a resource. In effective mode, efforts are returned that are currently effective. In any effective mode, effective efforts and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.resourcing.EffortList | the returned Effort 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 | getEffortsForResourceOnDate | ||
Description |
Gets a list of efforts for a resource and effective
beginning in the date range. Efforts are returned with a
start effective date that falls between the requested
dates inclusive. In effective mode, efforts are returned that are currently effective. In any effective mode, effective efforts 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.EffortList | the returned Effort 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 | getEffortsForCommission | ||
Description |
Gets a list of efforts for a commission. In plenary mode, the returned list contains all known efforts or an error results. Otherwise, the returned list may contain only those efforts that are accessible through this session. In effective mode, efforts are returned that are currently effective. In any effective mode, effective efforts and those currently expired are returned. | ||
Parameters | osid.id.Id | commissionId | a commission Id |
Return | osid.resourcing.EffortList | the returned Effort list | |
Errors | NULL_ARGUMENT | commissionId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEffortsForCommissionOnDate | ||
Description |
Gets a list of efforts for a commission and effective
during the entire given date range inclusive but not
confined to the date range. In effective mode, efforts are returned that are currently effective. In any effective mode, effective efforts and those currently expired are returned. | ||
Parameters | osid.id.Id | commissionId | a commision Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.resourcing.EffortList | the returned Effort list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | commissionId, from or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEffortsForResourceAndCommission | ||
Description |
Gets a list of efforts for a resource and commission.
In effective mode, efforts are returned that are currently effective. In any effective mode, effective efforts and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.id.Id | commissionId | a commission Id | |
Return | osid.resourcing.EffortList | the returned Effort list | |
Errors | NULL_ARGUMENT | resourceId or commissionId is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEffortsForResourceAndCommissionOnDate | ||
Description |
Gets a list of efforts for a resource and commission
and effective during the entire given date range inclusive
but not confined to the date range. In effective mode, efforts are returned that are currently effective. In any effective mode, effective efforts and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.id.Id | commissionId | a commission Id | |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.resourcing.EffortList | the returned Effort list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | resourceId, commissionId, from or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEffortsForWork | ||
Description |
Gets a list of efforts for a work. In plenary mode, the returned list contains all known efforts or an error results. Otherwise, the returned list may contain only those efforts that are accessible through this session. In effective mode, efforts are returned that are currently effective. In any effective mode, effective efforts and those currently expired are returned. | ||
Parameters | osid.id.Id | workId | a work Id |
Return | osid.resourcing.EffortList | the returned Effort 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 | getEffortsForWorkOnDate | ||
Description |
Gets a list of efforts for a work and effective during
the entire given date range inclusive but not confined to
the date range. In effective mode, efforts are returned that are currently effective. In any effective mode, effective efforts 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.EffortList | the returned Effort 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 | getEffortsForResourceAndWork | ||
Description |
Gets a list of efforts for a resource and work. In effective mode, efforts are returned that are currently effective. In any effective mode, effective efforts and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.id.Id | workId | a work Id | |
Return | osid.resourcing.EffortList | the returned Effort 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 | getEffortsForResourceAndWorkOnDate | ||
Description |
Gets a list of efforts for a resource and work and
effective during the entire given date range inclusive but
not confined to the date range. In effective mode, efforts are returned that are currently effective. In any effective mode, effective efforts 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.EffortList | the returned Effort 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 | getEfforts | ||
Description |
Gets all In plenary mode, the returned list contains all known efforts or an error results. Otherwise, the returned list may contain only those efforts that are accessible through this session. In effective mode, efforts are returned that are currently effective. In any effective mode, effective efforts and those currently expired are returned. | ||
Return | osid.resourcing.EffortList | a list of Efforts | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |