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

This session provides methods for retrieving SupersedingEventEnablers.

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 superseding event enabler methods in this session operate, retrieve and pertain to superseding event enablers defined explicitly in the current calendar. Using an isolated view is useful for managing SupersedingEventEnablers with the SupersedingEventEnablerAdminSession.
  • federated calendar view: All superseding event enabler methods in this session operate, retrieve and pertain to all superseding event enablers defined in this calendar and any other superseding event enablers implicitly available in this calendar through calendar inheritence.
  • active superseding event enabler view: All superseding event enabler lookup methods return active superseding event enablers.
  • any status superseding event enabler view: superseding event enablers of any active or 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.
MethodcanLookupSupersedingEventEnablers
Description

Tests if this user can perform SupersedingEventEnablers 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.
MethoduseComparativeSupersedingEventEnablerView
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.
MethodusePlenarySupersedingEventEnablerView
Description

A complete view of the SupersedingEventEnabler 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 superseding 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.
MethoduseActiveSupersedingEventEnablerView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusSupersedingEventEnablerView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetSupersedingEventEnabler
Description

Gets the SupersedingEventEnabler specified by its Id.

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

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

Parametersosid.id.IdsupersedingEventEnablerId Id of the SupersedingEventEnabler
Returnosid.calendaring.rules.SupersedingEventEnablerthe superseding event enabler
ErrorsNOT_FOUND supersedingEventEnablerId not found
NULL_ARGUMENT supersedingEventEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetSupersedingEventEnablersByIds
Description

Gets a SupersedingEventEnablerList corresponding to the given IdList.

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

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

Parametersosid.id.IdListsupersedingEventEnablerIdsthe list of Ids to retrieve
Returnosid.calendaring.rules.SupersedingEventEnablerListthe returned SupersedingEventEnabler list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT supersedingEventEnablerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventEnablersByGenusType
Description

Gets a SupersedingEventEnablerList corresponding to the given superseding event enabler genus Type which does not include superseding event enablers of genus types derived from the specified Type.

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

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

Parametersosid.type.TypesupersedingEventEnablerGenusTypea superseding event enabler genus type
Returnosid.calendaring.rules.SupersedingEventEnablerListthe returned SupersedingEventEnabler list
ErrorsNULL_ARGUMENT supersedingEventEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventEnablersByParentGenusType
Description

Gets a SupersedingEventEnablerList corresponding to the given superseding event enabler genus Type and include any additional superseding event enablers with genus types derived from the specified Type.

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

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

Parametersosid.type.TypesupersedingEventEnablerGenusTypea superseding event enabler genus type
Returnosid.calendaring.rules.SupersedingEventEnablerListthe returned SupersedingEventEnabler list
ErrorsNULL_ARGUMENT supersedingEventEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventEnablersByRecordType
Description

Gets a SupersedingEventEnablerList containing the given superseding event enabler record Type.

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

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

Parametersosid.type.TypesupersedingEventEnablerRecordTypea superseding event enabler record type
Returnosid.calendaring.rules.SupersedingEventEnablerListthe returned SupersedingEventEnabler list
ErrorsNULL_ARGUMENT supersedingEventEnablerRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventEnablersOnDate
Description

Gets a SupersedingEventEnablerList effectiveduring the entire given date range inclusive but not confined to the date range.

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

In active mode, supseding 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 superseding event enablers are returned.

Parametersosid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.calendaring.rules.SupersedingEventEnablerListthe returned SupersedingEventEnabler 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.
MethodgetSupersedingEventEnablersOnDateWithAgent
Description

Gets a SupersedingEventEnablerList effectiveduring the entire given date range inclusive but not confined to the date range evaluated against the given agent.

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

In active mode, supseding 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 superseding event enablers are returned.

Parametersosid.id.IdagentIdan agent Id
osid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.calendaring.rules.SupersedingEventEnablerListthe returned SupersedingEventEnabler 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.
MethodgetSupersedingEventEnablers
Description

Gets all SupersedingEventEnablers.

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

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

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