Interface | osid.resourcing.AvailabilityLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving availabilities. This lookup session defines several views:
The methods Availabilities may have an additional records indicated by
their respective record types. The record may not be accessed
through a cast of 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 | canLookupAvailabilities | ||
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 | useComparativeAvailabilityView | ||
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 | usePlenaryAvailabilityView | ||
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 availabilities 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 retrievals to this foundry only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useEffectiveAvailabilityView | ||
Description |
Only availabilities whose effective dates are current are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyEffectiveAvailabilityView | ||
Description |
All availabilities of any effective dates are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getAvailability | ||
Description |
Gets the In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities and those currently expired are returned. | ||
Parameters | osid.id.Id | availabilityId | the Id of the Availability to retrieve |
Return | osid.resourcing.Availability | the returned Availability | |
Errors | NOT_FOUND | no Availability found with the given Id | |
NULL_ARGUMENT | availabilityId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAvailabilitiesByIds | ||
Description |
Gets an In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities and those currently expired are returned. | ||
Parameters | osid.id.IdList | availabilityIds | the list of Ids to retrieve |
Return | osid.resourcing.AvailabilityList | the returned Availability list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | availabilityIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAvailabilitiesByGenusType | ||
Description |
Gets an In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities and those currently expired are returned. | ||
Parameters | osid.type.Type | availabilityGenusType | an availability genus type |
Return | osid.resourcing.AvailabilityList | the returned Availability list | |
Errors | NULL_ARGUMENT | availabilityGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAvailabilitiesByParentGenusType | ||
Description |
Gets an In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities and those currently expired are returned. | ||
Parameters | osid.type.Type | availabilityGenusType | an availability genus type |
Return | osid.resourcing.AvailabilityList | the returned Availability list | |
Errors | NULL_ARGUMENT | availabilityGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAvailabilitiesByRecordType | ||
Description |
Gets an In plenary mode, the returned list contains all known availabilities or an error results. Otherwise, the returned list may contain only those availabilities that are accessible through this session. In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities and those currently expired are returned. | ||
Parameters | osid.type.Type | availabilityRecordType | an availability record type |
Return | osid.resourcing.AvailabilityList | the returned Availability list | |
Errors | NULL_ARGUMENT | availabilityRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAvailabilitiesOnDate | ||
Description |
Gets a list of availabilities effective during the
entire given date range inclusive but not confined to the
date range. In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities 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.AvailabilityList | the returned Availability 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 | getAvailabilitiesForResource | ||
Description |
Gets a list of availabilities for a resource. In plenary mode, the returned list contains all known availabilities or an error results. Otherwise, the returned list may contain only those availabilities that are accessible through this session. In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.resourcing.AvailabilityList | the returned Availability 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 | getAvailabilitiesForResourceOnDate | ||
Description |
Gets a list of availabilities for a resource and
effective during the entire given date range inclusive but
not confined to the date range. In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities 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.AvailabilityList | the returned Availability 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 | getAvailabilitiesForJob | ||
Description |
Gets a list of availabilities for a job. In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities and those currently expired are returned. | ||
Parameters | osid.id.Id | jobId | a job Id |
Return | osid.resourcing.AvailabilityList | the returned Availability list | |
Errors | NULL_ARGUMENT | jobId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAvailabilitiesForJobOnDate | ||
Description |
Gets a list of availabilities for a job and effective during the entire given date range inclusive but not confined to the date range. In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities and those currently expired are returned. | ||
Parameters | osid.id.Id | jobId | a job Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.resourcing.AvailabilityList | the returned Availability list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | jobId, from, or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAvailabilitiesForResourceAndJob | ||
Description |
Gets a list of availabilities for a resource and job.
In effective mode, credits are returned that are currently effective. In any effective mode, effective credits and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.id.Id | jobId | a job Id | |
Return | osid.resourcing.AvailabilityList | the returned Availability list | |
Errors | NULL_ARGUMENT | resourceId or jobId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAvailabilitiesForResourceAndJobOnDate | ||
Description |
Gets a list of availabilities for a resource and job
and effective during the entire given date range inclusive
but not confined to the date range. In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.id.Id | jobId | a job Id | |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.resourcing.AvailabilityList | the returned Availability list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | resourceId, jobId, from, or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAvailabilities | ||
Description |
Gets all availabilities. In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities and those currently expired are returned. | ||
Return | osid.resourcing.AvailabilityList | the returned Availability list | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |