org.osid.calendaring.rules

Interface OffsetEventEnablerRuleLookupSession

All Superinterfaces:

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

public interface OffsetEventEnablerRuleLookupSession
extends OsidSession

This session provides methods to retrieve OffsetEventEnabler to OffsetEvent mappings. An Calendar with multiple OffsetEventEnablers means any positive rule evaluation across the enablers result in an effective OffsetEvent.

This lookup session defines several 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 methods in this session operate, retrieve and pertain offset event enablers defined explicitly in the current calendar
• federated calendar view: All 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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupOffsetEventEnablerRules() Tests if this user can perform lookups of offset event enabler/offset event mappings.
Calendar	getCalendar() Gets the Calendar associated with this session.
Id	getCalendarId() Gets the Calendar Id associated with this session.
IdList	getOffsetEventEnablerIdsForOffsetEvent(Id offsetEventId) Gets the OffsetEventEnabler Id associated with an OffsetEvent.
OffsetEventEnablerList	getOffsetEventEnablersForOffsetEvent(Id offsetEventId) Gets the OffsetEventEnablers associated with an OffsetEvent.
IdList	getOffsetEventIdsForOffsetEventEnabler(Id offsetEventEnablerId) Gets the OffsetEvent Ids mapped to an OffsetEventEnabler.
OffsetEventList	getOffsetEventsForOffsetEventEnabler(Id offsetEventEnablerId) Gets the OffsetEvents mapped to an OffsetEventEnabler.
void	useComparativeOffsetEventEnablerRuleView() 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	usePlenaryOffsetEventEnablerRuleView() A complete view of the OffsetEventEnabler and OffsetEvent 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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupOffsetEventEnablerRules

boolean canLookupOffsetEventEnablerRules()

Tests if this user can perform lookups of offset event enabler/offset 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.

useComparativeOffsetEventEnablerRuleView

void useComparativeOffsetEventEnablerRuleView()

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.

usePlenaryOffsetEventEnablerRuleView

void usePlenaryOffsetEventEnablerRuleView()

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

getOffsetEventEnablerIdsForOffsetEvent

IdList getOffsetEventEnablerIdsForOffsetEvent(Id offsetEventId)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Gets the OffsetEventEnabler Id associated with an OffsetEvent.

Parameters:

offsetEventId - Id of the OffsetEvent

Returns:

the offset event enabler Ids

Throws:

NotFoundException - offsetEventId is not found

NullArgumentException - offsetEventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOffsetEventEnablersForOffsetEvent

OffsetEventEnablerList getOffsetEventEnablersForOffsetEvent(Id offsetEventId)
                                                            throws NotFoundException,
                                                                   OperationFailedException,
                                                                   PermissionDeniedException

Gets the OffsetEventEnablers associated with an OffsetEvent.

Parameters:

offsetEventId - Id of the OffsetEvent

Returns:

the offset event enablers

Throws:

NotFoundException - offsetEventId is not found

NullArgumentException - offsetEventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOffsetEventIdsForOffsetEventEnabler

IdList getOffsetEventIdsForOffsetEventEnabler(Id offsetEventEnablerId)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Gets the OffsetEvent Ids mapped to an OffsetEventEnabler.

Parameters:

offsetEventEnablerId - Id of an OffsetEventEnabler

Returns:

list of offset event Ids

Throws:

NotFoundException - offsetEventEnablerId is not found

NullArgumentException - offsetEventEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOffsetEventsForOffsetEventEnabler

OffsetEventList getOffsetEventsForOffsetEventEnabler(Id offsetEventEnablerId)
                                                     throws NotFoundException,
                                                            OperationFailedException,
                                                            PermissionDeniedException

Gets the OffsetEvents mapped to an OffsetEventEnabler.

Parameters:

offsetEventEnablerId - Id of an OffsetEventEnabler

Returns:

list of offset events

Throws:

NotFoundException - offsetEventEnablerId is not found

NullArgumentException - offsetEventEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.