org.osid.calendaring.cycle

Interface EventCyclicEventLookupSession

All Superinterfaces:

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

public interface EventCyclicEventLookupSession
extends OsidSession

This session provides methods to retrieve CyclicEvent to Event mappings. An Event may be mapped to multiple CyclicEvents explicitly or through a rule-based generation.

This lookup session defines two views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition
• isolated calendar view: All cyclic event methods in this session operate, retrieve and pertain to cyclic events defined explicitly in the current calendar.
• federated calendar view: All cyclic 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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupEventCyclicEventMappings() Tests if this user can perform lookups of event/cyclic event mappings.
Calendar	getCalendar() Gets the Calendar associated with this session.
Id	getCalendarId() Gets the Calendar Id associated with this session.
IdList	getCyclicEventIdsByEvent(Id eventId) Gets the list of CyclicEvent Ids mapped to an Event.
CyclicEventList	getCyclicEventsByEvent(Id eventId) Gets the list of CyclicEvents mapped to an Event.
IdList	getEventIdsByCyclicEvent(Id cyclicEventId) Gets the list of Event Ids associated with a CyclicEvent.
IdList	getEventIdsByCyclicEventAndDate(Id cyclicEventId, DateTime from, DateTime to) Gets the list of Event Ids between the given date range included associated with a CyclicEvent.
EventList	getEventsByCyclicEvent(Id cyclicEventId) Gets the list of Events associated with a CyclicEvent.
EventList	getEventsByCyclicEventAndDate(Id cyclicEventId, DateTime from, DateTime to) Gets the list of Events between the given date range included associated with a CyclicEvent.
void	useComparativeCalendarView() 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	usePlenaryCalendarView() A complete view of the CyclicEvent and Event 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.

canLookupEventCyclicEventMappings

boolean canLookupEventCyclicEventMappings()

Tests if this user can perform lookups of event/cyclic event mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeCalendarView

void useComparativeCalendarView()

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.

usePlenaryCalendarView

void usePlenaryCalendarView()

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

getEventIdsByCyclicEvent

IdList getEventIdsByCyclicEvent(Id cyclicEventId)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Gets the list of Event Ids associated with a CyclicEvent.

Parameters:

cyclicEventId - Id of the CyclicEvent

Returns:

list of related event Ids

Throws:

NotFoundException - cyclicEventId is not found

NullArgumentException - cyclicEventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEventsByCyclicEvent

EventList getEventsByCyclicEvent(Id cyclicEventId)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Gets the list of Events associated with a CyclicEvent.

Parameters:

cyclicEventId - Id of the CyclicEvent

Returns:

list of related events

Throws:

NotFoundException - cyclicEventId is not found

NullArgumentException - cyclicEventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEventIdsByCyclicEventAndDate

IdList getEventIdsByCyclicEventAndDate(Id cyclicEventId,
                                     DateTime from,
                                     DateTime to)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Gets the list of Event Ids between the given date range included associated with a CyclicEvent.

Parameters:

cyclicEventId - Id of the CyclicEvent

from - starting date

to - ending date

Returns:

list of related event Ids

Throws:

InvalidArgumentException - from is greater than to

NotFoundException - cyclicEventId is not found

NullArgumentException - cyclicEventId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEventsByCyclicEventAndDate

EventList getEventsByCyclicEventAndDate(Id cyclicEventId,
                                      DateTime from,
                                      DateTime to)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Gets the list of Events between the given date range included associated with a CyclicEvent.

Parameters:

cyclicEventId - Id of the CyclicEvent

from - starting date

to - ending date

Returns:

list of related cyclic events

Throws:

InvalidArgumentException - from is greater than to

NotFoundException - cyclicEventId is not found

NullArgumentException - cyclicEventId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCyclicEventIdsByEvent

IdList getCyclicEventIdsByEvent(Id eventId)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Gets the list of CyclicEvent Ids mapped to an Event.

Parameters:

eventId - Id of an Event

Returns:

list of cyclic event Ids

Throws:

NotFoundException - eventId is not found

NullArgumentException - eventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCyclicEventsByEvent

CyclicEventList getCyclicEventsByEvent(Id eventId)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Gets the list of CyclicEvents mapped to an Event.

Parameters:

eventId - Id of an Event

Returns:

list of cyclic events

Throws:

NotFoundException - eventId is not found

NullArgumentException - eventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.