org.osid.calendaring.cycle

Interface CyclicEventLookupSession

All Superinterfaces:

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

public interface CyclicEventLookupSession
extends OsidSession

This session provides methods for retrieving CyclicEvent s.

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 event methods in this session operate, retrieve and pertain to cyclic events defined explicitly in the current calendar. Using an isolated view is useful for managing cyclic events with the CyclicEventAdminSession.
• federated calendar view: All event methods in this session operate, retrieve and pertain to all cyclic events defined in this calendar and any other calendars implicitly available in this calendar through calendar inheritence.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupCyclicEvents() Tests if this user can perform CyclicEvent lookups.
Calendar	getCalendar() Gets the Calendar associated with this session.
Id	getCalendarId() Gets the Calendar Id associated with this session.
CyclicEvent	getCyclicEvent(Id cyclicEventId) Gets the CyclicEvent specified by its Id.
CyclicEventList	getCyclicEvents() Gets all CyclicEvents.
CyclicEventList	getCyclicEventsByGenusType(Type cyclicEventGenusType) Gets a CyclicEventList corresponding to the given event genus Type which does not include cyclic events of genus types derived from the specified Type.
CyclicEventList	getCyclicEventsByIds(IdList cyclicEventIds) Gets a CyclicEventList corresponding to the given IdList.
CyclicEventList	getCyclicEventsByParentGenusType(Type cyclicEventGenusType) Gets a CyclicEventList corresponding to the given event genus Type and include any additional cyclic event with genus types derived from the specified Type.
CyclicEventList	getCyclicEventsByRecordType(Type cyclicEventRecordType) Gets a CyclicEventList containing the given event record Type.
void	useComparativeCyclicEventView() 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	usePlenaryCyclicEventView() A complete view of the CyclicEvent 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.

canLookupCyclicEvents

boolean canLookupCyclicEvents()

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

useComparativeCyclicEventView

void useComparativeCyclicEventView()

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.

usePlenaryCyclicEventView

void usePlenaryCyclicEventView()

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

getCyclicEvent

CyclicEvent getCyclicEvent(Id cyclicEventId)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

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

Parameters:

cyclicEventId - Id of the CyclicEvent

Returns:

the cyclic event

Throws:

NotFoundException - cyclicEventId not found

NullArgumentException - cyclicEventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getCyclicEventsByIds

CyclicEventList getCyclicEventsByIds(IdList cyclicEventIds)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Gets a CyclicEventList corresponding to the given IdList. In plenary mode, the returned list contains all of the cyclic 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 CyclicEvents may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

cyclicEventIds - the list of Ids to retrieve

Returns:

the returned CyclicEvent list

Throws:

NotFoundException - an Id was not found

NullArgumentException - cyclicEventIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCyclicEventsByGenusType

CyclicEventList getCyclicEventsByGenusType(Type cyclicEventGenusType)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

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

Parameters:

cyclicEventGenusType - a cyclic event genus type

Returns:

the returned Event list

Throws:

NullArgumentException - cyclicEventGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCyclicEventsByParentGenusType

CyclicEventList getCyclicEventsByParentGenusType(Type cyclicEventGenusType)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

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

Parameters:

cyclicEventGenusType - a cyclic event genus type

Returns:

the returned CyclicEvent list

Throws:

NullArgumentException - cyclicEventGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCyclicEventsByRecordType

CyclicEventList getCyclicEventsByRecordType(Type cyclicEventRecordType)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

cyclicEventRecordType - a cyclic event record type

Returns:

the returned Event list

Throws:

NullArgumentException - cyclicEventRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCyclicEvents

CyclicEventList getCyclicEvents()
                                throws OperationFailedException,
                                       PermissionDeniedException

Gets all CyclicEvents. In plenary mode, the returned list contains all known cyclic events or an error results. Otherwise, the returned list may contain only those cyclic events that are accessible through this session.

Returns:

a CyclicEventList

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.