OSID Logo
OSID Specifications
calendaring rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.rules.OffsetEventEnablerLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving OffsetEventEnablers.

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 offset event enabler methods in this session operate, retrieve and pertain to offset event enablers defined explicitly in the current calendar. Using an isolated view is useful for managing OffsetEventEnablers with the OffsetEventEnablerAdminSession.
  • federated calendar view: All offset event enabler methods in this session operate, retrieve and pertain to all offset event enablers defined in this calendar and any other offset event enablers implicitly available in this calendar through calendar inheritence.
  • active offset event enabler view: All offset event enabler lookup methods return active offset event enablers.
  • any status offset event enabler view: Offset event enablers of any active and inactive status are returned from methods.

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 useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

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
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupOffsetEventEnablers
Description

Tests if this user can perform OffsetEventEnablers 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.
MethoduseComparativeOffsetEventEnablerView
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.
MethodusePlenaryOffsetEventEnablerView
Description

A complete view of the OffsetEventEnabler 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 offset event enablers 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.
MethoduseActiveOffsetEventEnablerView
Description

Only active offset event enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusOffsetEventEnablerView
Description

All active and inactive offset event enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetOffsetEventEnabler
Description

Gets the OffsetEventEnabler specified by its Id.

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

In active mode, offset event enablers are returned that are currently active. In any status mode, active and inactive offset event enablers are returned.

Parametersosid.id.IdoffsetEventEnablerId Id of the OffsetEventEnabler
Returnosid.calendaring.rules.OffsetEventEnablerthe offset event enabler
ErrorsNOT_FOUND offsetEventEnablerId not found
NULL_ARGUMENT offsetEventEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetOffsetEventEnablersByIds
Description

Gets an OffsetEventEnablerList corresponding to the given IdList.

In plenary mode, the returned list contains all of the offset event enablers 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 OffsetEventEnablers may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, offset event enablers are returned that are currently active. In any status mode, active and inactive offset event enablers are returned.

Parametersosid.id.IdListoffsetEventEnablerIdsthe list of Ids to retrieve
Returnosid.calendaring.rules.OffsetEventEnablerListthe returned OffsetEventEnabler list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT offsetEventEnablerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOffsetEventEnablersByGenusType
Description

Gets an OffsetEventEnablerList corresponding to the given offset event enabler genus Type which does not include offset event enablers of genus types derived from the specified Type.

In plenary mode, the returned list contains all known offset event enablers or an error results. Otherwise, the returned list may contain only those offset event enablers that are accessible through this session.

In active mode, offset event enablers are returned that are currently active. In any status mode, active and inactive offset event enablers are returned.

Parametersosid.type.TypeoffsetEventEnablerGenusTypean offset event enabler genus type
Returnosid.calendaring.rules.OffsetEventEnablerListthe returned OffsetEventEnabler list
ErrorsNULL_ARGUMENT offsetEventEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOffsetEventEnablersByParentGenusType
Description

Gets an OffsetEventEnablerList corresponding to the given offset event enabler genus Type and include any additional offset event enablers with genus types derived from the specified Type.

In plenary mode, the returned list contains all known offset event enablers or an error results. Otherwise, the returned list may contain only those offset event enablers that are accessible through this session.

In active mode, offset event enablers are returned that are currently active. In any status mode, active and inactive offset event enablers are returned.

Parametersosid.type.TypeoffsetEventEnablerGenusTypean offset event enabler genus type
Returnosid.calendaring.rules.OffsetEventEnablerListthe returned OffsetEventEnabler list
ErrorsNULL_ARGUMENT offsetEventEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOffsetEventEnablersByRecordType
Description

Gets an OffsetEventEnablerList containing the given offset event enabler record Type.

In plenary mode, the returned list contains all known offset event enablers or an error results. Otherwise, the returned list may contain only those offset event enablers that are accessible through this session.

In active mode, offset event enablers are returned that are currently active. In any status mode, active and inactive offset event enablers are returned.

Parametersosid.type.TypeoffsetEventEnablerRecordTypean offset event enabler record type
Returnosid.calendaring.rules.OffsetEventEnablerListthe returned OffsetEventEnabler list
ErrorsNULL_ARGUMENT ofsetEventEnablerRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOffsetEventEnablersOnDate
Description

Gets an OffsetEventEnablerList effective for the entire the given date range inclusive but not confisned to the date range for any agent.

In plenary mode, the returned list contains all known offset event enablers or an error results. Otherwise, the returned list may contain only those offset event enablers that are accessible through this session.

In active mode, offset event enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive offset event enablers are returned.

Parametersosid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.calendaring.rules.OffsetEventEnablerListthe returned OffsetEventEnabler list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOffsetEventEnablersOnDateWithAgent
Description

Gets an OffsetEventEnablerList effective for the entire the given date range. inclusive but not confisned to the date range and evaluated against the given agent.

In plenary mode, the returned list contains all known offset event enablers or an error results. Otherwise, the returned list may contain only those offset event enablers that are accessible through this session.

In active mode, offset event enablers are returned that are currently active. In any status mode, active and inactive offset event enablers are returned.

Parametersosid.id.IdagentIdan agent Id
osid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.calendaring.rules.OffsetEventEnablerListthe returned OffsetEventEnabler list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT agent, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOffsetEventEnablers
Description

Gets all OffsetEventEnablers.

In plenary mode, the returned list contains all known offset event enablers or an error results. Otherwise, the returned list may contain only those offset event enablers that are accessible through this session.

In active mode, offset event enablers are returned that are currently active. In any status mode, active and inactive offset event enablers are returned.

Returnosid.calendaring.rules.OffsetEventEnablerListthe returned OffsetEventEnabler list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.