Interface | osid.calendaring.TimePeriodLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Time periods may have an additional records indicated by
their respective record types. The record may not be accessed
through a cast of the | ||
Method | getCalendarId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Calendar Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCalendar | ||
Description |
Gets the | ||
Return | osid.calendaring.Calendar | the Calendar associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupTimePeriods | ||
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 | useComparativeTimePeriodView | ||
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 | usePlenaryTimePeriodView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedCalendarView | ||
Description |
Federates the view for methods in this session. A federated view will include time periods in calendars which are children of this calendar in the calendar hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCalendarView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this calendar only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getTimePeriod | ||
Description |
Gets the | ||
Parameters | osid.id.Id | timePeriodId | Id of the TimePeriod |
Return | osid.calendaring.TimePeriod | the time period | |
Errors | NOT_FOUND | timePeriodId not found | |
NULL_ARGUMENT | timePeriodId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getTimePeriodsByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | timePeriodIds | the list of Ids to retrieve |
Return | osid.calendaring.TimePeriodList | the returned TimePeriod list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | rimePeriodIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTimePeriodsByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | timePeriodGenusType | a time period genus type |
Return | osid.calendaring.TimePeriodList | the returned TimePeriod list | |
Errors | NULL_ARGUMENT | timePeriodGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTimePeriodsByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | timePeriodGenusType | a time period genus type |
Return | osid.calendaring.TimePeriodList | the returned TimePeriod list | |
Errors | NULL_ARGUMENT | timePeriodGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTimePeriodsByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | timePeriodRecordType | a time period record type |
Return | osid.calendaring.TimePeriodList | the returned TimePeriod list | |
Errors | NULL_ARGUMENT | timePeriodRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTimePeriodsByDate | ||
Description |
Gets a | ||
Parameters | osid.calendaring.DateTime | datetime | a date |
Return | osid.calendaring.TimePeriodList | the returned TimePeriod list | |
Errors | NULL_ARGUMENT | datetime is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTimePeriodsInDateRange | ||
Description |
Gets a | ||
Parameters | osid.calendaring.DateTime | start | start of daterange |
osid.calendaring.DateTime | end | end of date range | |
Return | osid.calendaring.TimePeriodList | the returned TimePeriod list | |
Errors | INVALID_ARGUMENT | end is less than start | |
NULL_ARGUMENT | start or end is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTimePeriods | ||
Description |
Gets all | ||
Return | osid.calendaring.TimePeriodList | a TimePeriodList | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |