OSID Logo
OSID Specifications
calendaring cycle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.cycle.CyclicTimePeriodLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving CyclicTimePeriod objects.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated calendar view: All cyclic time period methods in this session operate, retrieve and pertain to cyclic time periods defined explicitly in the current calendar. Using an isolated view is useful for managing cyclic time periods with the CyclicTimePeriodAdminSession.
  • federated calendar view: All cyclic time period methods in this session operate, retrieve and pertain to all cyclic time periods defined in this calendar and any other calendars implicitly available in this calendar through calendar inheritence.

Cyclic time periods may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the CyclicTimePeriod.

MethodgetCalendarId
Description

Gets the Calendar Id associated with this session.

Returnosid.id.Idthe Calendar Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCalendar
Description

Gets the Calendar associated with this session.

Returnosid.calendaring.Calendarthe Calendar associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupCyclicTimePeriods
Description

Tests if this user can perform CyclicTimePeriod lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeCyclicTimePeriodView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryCyclicTimePeriodView
Description

A complete view of the CyclicTimePeriod returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedCalendarView
Description

Federates the view for methods in this session. A federated view will include cyclic time periods in calendars which are children of this calendar in the calendar hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCalendarView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this calendar only.

CompliancemandatoryThis method is must be implemented.
MethodgetCyclicTimePeriod
Description

Gets the CyclicTimePeriod specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned CyclicTimePeriod may have a different Id than requested, such as the case where a duplicate Id was assigned to a CyclicTimePeriod and retained for compatibility.

Parametersosid.id.IdcyclicTimePeriodId Id of the CyclicTimePeriod
Returnosid.calendaring.cycle.CyclicTimePeriodthe cyclic time period
ErrorsNOT_FOUND cyclicTimePeriodId not found
NULL_ARGUMENT cyclicTimePeriodId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetCyclicTimePeriodsByIds
Description

Gets a CyclicTimePeriodList corresponding to the given IdList. In plenary mode, the returned list contains all of the cyclic time periods specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible CyclicTimePeriods may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListcyclicTimePeriodIdsthe list of Ids to retrieve
Returnosid.calendaring.cycle.CyclicTimePeriodListthe returned CyclicTimePeriod list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT rimePeriodIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCyclicTimePeriodsByGenusType
Description

Gets a CyclicTimePeriodList corresponding to the given cyclic time period genus Type which does not include cyclic time periods of genus types derived from the specified Type. In plenary mode, the returned list contains all known cyclic time periods or an error results. Otherwise, the returned list may contain only those cyclic time periods that are accessible through this session.

Parametersosid.type.TypecyclicTimePeriodGenusTypea cyclic time period genus type
Returnosid.calendaring.cycle.CyclicTimePeriodListthe returned CyclicTimePeriod list
ErrorsNULL_ARGUMENT cyclicTimePeriodGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCyclicTimePeriodsByParentGenusType
Description

Gets a CyclicTimePeriodList corresponding to the given cyclic time period genus Type and include any additional cyclic time periods with genus types derived from the specified Type. In plenary mode, the returned list contains all known cyclic time periods or an error results. Otherwise, the returned list may contain only those cyclic time periods that are accessible through this session.

Parametersosid.type.TypecyclicTimePeriodGenusTypea cyclic time period genus type
Returnosid.calendaring.cycle.CyclicTimePeriodListthe returned CyclicTimePeriod list
ErrorsNULL_ARGUMENT cyclicTimePeriodGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCyclicTimePeriodsByRecordType
Description

Gets a CyclicTimePeriodList containing the given cyclic time period record Type. In plenary mode, the returned list contains all known cyclic time periods or an error results. Otherwise, the returned list may contain only those cyclic time periods that are accessible through this session.

Parametersosid.type.TypecyclicTimePeriodRecordTypea cyclic time period record type
Returnosid.calendaring.cycle.CyclicTimePeriodListthe returned CyclicTimePeriod list
ErrorsNULL_ARGUMENT cyclicTimePeriodRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCyclicTimePeriods
Description

Gets all CyclicTimePeriods. In plenary mode, the returned list contains all known cyclic time periods or an error results. Otherwise, the returned list may contain only those cyclic time periods that are accessible through this session. In both cases, the order of the set is not specified.

Returnosid.calendaring.cycle.CyclicTimePeriodLista CyclicTimePeriodList
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.