org.osid.calendaring

Interface SupersedingEventLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface SupersedingEventLookupSession
extends OsidSession

This session provides methods for retrieving SupersedingEvents.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupSupersedingEvents() Tests if this user can perform SupersedingEvent lookups.
Calendar	getCalendar() Gets the Calendar associated with this session.
Id	getCalendarId() Gets the Calendar Id associated with this session.
SupersedingEvent	getSupersedingEvent(Id supersedingEventId) Gets the Superseding specified by its Id.
SupersedingEventList	getSupersedingEvents() Gets all SupersedingEvents.
SupersedingEventList	getSupersedingEventsByGenusType(Type supersedingEventGenusType) Gets a SupersedingEventList corresponding to the given superseding event genus Type which does not include superseding events of genus types derived from the specified Type.
SupersedingEventList	getSupersedingEventsByIds(IdList supersedingEventIds) Gets a SupersedingEventList corresponding to the given IdList.
SupersedingEventList	getSupersedingEventsByParentGenusType(Type supersedingEventGenusType) Gets a SupersedingEventList corresponding to the given superseding event genus Type and include any additional superseding event with genus types derived from the specified Type.
SupersedingEventList	getSupersedingEventsByRecordType(Type supersedingEventRecordType) Gets a SupersedingEventList containing the given superseding event record Type.
SupersedingEventList	getSupersedingEventsBySupersededEvent(Id supersededEventId) Gets the SupersedingEvents related to the relative event Id.
void	useActiveSupersedingEventView() Only active superseding events are returned by methods in this session.
void	useAnyStatusSupersedingEventView() All active and inactive superseding events are returned by methods in this session.
void	useComparativeSupersedingEventView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useFederatedCalendarView() Federates the view for methods in this session.
void	useIsolatedCalendarView() Isolates the view for methods in this session.
void	usePlenarySupersedingEventView() A complete view of the SupersedingEvent returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getCalendarId

Id getCalendarId()

Gets the Calendar Id associated with this session.

Returns:

the Calendar Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCalendar

Calendar getCalendar()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Calendar associated with this session.

Returns:

the Calendar associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupSupersedingEvents

boolean canLookupSupersedingEvents()

Tests if this user can perform SupersedingEvent 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.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeSupersedingEventView

void useComparativeSupersedingEventView()

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.

usePlenarySupersedingEventView

void usePlenarySupersedingEventView()

A complete view of the SupersedingEvent 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.

Compliance:

mandatory - This method is must be implemented.

useFederatedCalendarView

void useFederatedCalendarView()

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

Compliance:

mandatory - This method is must be implemented.

useIsolatedCalendarView

void useIsolatedCalendarView()

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.

useActiveSupersedingEventView

void useActiveSupersedingEventView()

Only active superseding events are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusSupersedingEventView

void useAnyStatusSupersedingEventView()

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

Compliance:

mandatory - This method is must be implemented.

getSupersedingEvent

SupersedingEvent getSupersedingEvent(Id supersedingEventId)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Gets the Superseding specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned SupersedingEvent may have a different Id than requested, such as the case where a duplicate Id was assigned to a Superseding and retained for compatibility. In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned.

Parameters:

supersedingEventId - Id of the SupersedingEvent

Returns:

the superseding event

Throws:

NotFoundException - supersedngEventId not found

NullArgumentException - supersedingEventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getSupersedingEventsByIds

SupersedingEventList getSupersedingEventsByIds(IdList supersedingEventIds)
                                               throws NotFoundException,
                                                      OperationFailedException,
                                                      PermissionDeniedException

Gets a SupersedingEventList corresponding to the given IdList. In plenary mode, the returned list contains all of the superseding events 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 SupersedingEvents may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned.

Parameters:

supersedingEventIds - the list of Ids to retrieve

Returns:

the returned SupersedingEvent list

Throws:

NotFoundException - an Id was not found

NullArgumentException - supersedingEventIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSupersedingEventsByGenusType

SupersedingEventList getSupersedingEventsByGenusType(Type supersedingEventGenusType)
                                                     throws OperationFailedException,
                                                            PermissionDeniedException

Gets a SupersedingEventList corresponding to the given superseding event genus Type which does not include superseding events of genus types derived from the specified Type. In plenary mode, the returned list contains all known superseding events or an error results. Otherwise, the returned list may contain only those superseding events that are accessible through this session. In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned.

Parameters:

supersedingEventGenusType - a superseding event genus type

Returns:

the returned SupersedingEvent list

Throws:

NullArgumentException - supersedingEventGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSupersedingEventsByParentGenusType

SupersedingEventList getSupersedingEventsByParentGenusType(Type supersedingEventGenusType)
                                                           throws OperationFailedException,
                                                                  PermissionDeniedException

Gets a SupersedingEventList corresponding to the given superseding event genus Type and include any additional superseding event with genus types derived from the specified Type. In plenary mode, the returned list contains all known superseding events or an error results. Otherwise, the returned list may contain only those superseding events that are accessible through this session. In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned.

Parameters:

supersedingEventGenusType - a superseding event genus type

Returns:

the returned SupersedingEvent list

Throws:

NullArgumentException - supersedingEventGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSupersedingEventsByRecordType

SupersedingEventList getSupersedingEventsByRecordType(Type supersedingEventRecordType)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Gets a SupersedingEventList containing the given superseding event record Type. In plenary mode, the returned list contains all known superseding events or an error results. Otherwise, the returned list may contain only those superseding events that are accessible through this session. In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned.

Parameters:

supersedingEventRecordType - a superseding event record type

Returns:

the returned SupersedingEvent list

Throws:

NullArgumentException - supersedingEventRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSupersedingEventsBySupersededEvent

SupersedingEventList getSupersedingEventsBySupersededEvent(Id supersededEventId)
                                                           throws NotFoundException,
                                                                  OperationFailedException,
                                                                  PermissionDeniedException

Gets the SupersedingEvents related to the relative event Id. In plenary mode, the returned list contains all known superseding events or an error results. Otherwise, the returned list may contain only those superseding events that are accessible through this session. In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned.

Parameters:

supersededEventId - Id of the related event

Returns:

the superseding events

Throws:

NotFoundException - supersededEventId not found

NullArgumentException - supersededEventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getSupersedingEvents

SupersedingEventList getSupersedingEvents()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets all SupersedingEvents. In plenary mode, the returned list contains all known superseding events or an error results. Otherwise, the returned list may contain only those superseding events that are accessible through this session. In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned.

Returns:

a SupersedingEventList

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.