org.osid.calendaring.rules

Interface SupersedingEventEnablerRuleLookupSession

All Superinterfaces:

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

public interface SupersedingEventEnablerRuleLookupSession
extends OsidSession

This session provides methods to retrieve SupersedingEventEnabler to SupersedingEvent mappings. A SupersedingEvent with multiple SupersedingEventEnablers means any positive rule evaluation across the enablers result in an effective SupersedingEvent.

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 superseding event enablers defined explicitly in the current calendar
• federated calendar view: All 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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupSupersedingEventEnablerRules() Tests if this user can perform lookups of superseding event enabler/superseding event mappings.
Calendar	getCalendar() Gets the Calendar associated with this session.
Id	getCalendarId() Gets the Calendar Id associated with this session.
IdList	getSupersedingEventEnablerIdsForSupersedingEvent(Id supersedingEventId) Gets the SupersedingEventEnabler Id associated with a SupersedingEvent.
SupersedingEventEnablerList	getSupersedingEventEnablersForSupersedingEvent(Id supersedingEventId) Gets the SupersedingEventEnabler associated with a SupersedingEvent.
IdList	getSupersedingEventIdsForSupersedingEventEnabler(Id supersedingEventEnablerId) Gets the SupersedingEvent Ids mapped to a SupersedingEventEnabler.
SupersedingEventList	getSupersedingEventsForSupersedingEventEnabler(Id supersedingEventEnablerId) Gets the SupersedingEvents mapped to a SupersedingEventEnabler.
void	useComparativeSupersedingEventEnablerRuleView() 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	usePlenarySupersedingEventEnablerRuleView() A complete view of the SupersedingEventEnabler and 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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupSupersedingEventEnablerRules

boolean canLookupSupersedingEventEnablerRules()

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

useComparativeSupersedingEventEnablerRuleView

void useComparativeSupersedingEventEnablerRuleView()

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.

usePlenarySupersedingEventEnablerRuleView

void usePlenarySupersedingEventEnablerRuleView()

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

getSupersedingEventEnablerIdsForSupersedingEvent

IdList getSupersedingEventEnablerIdsForSupersedingEvent(Id supersedingEventId)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Gets the SupersedingEventEnabler Id associated with a SupersedingEvent.

Parameters:

supersedingEventId - Id of the SupersedingEvent

Returns:

the superseding event enabler Ids

Throws:

NotFoundException - supersedingEventId is not found

NullArgumentException - supersedingEventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSupersedingEventEnablersForSupersedingEvent

SupersedingEventEnablerList getSupersedingEventEnablersForSupersedingEvent(Id supersedingEventId)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException,
                                                                                  PermissionDeniedException

Gets the SupersedingEventEnabler associated with a SupersedingEvent.

Parameters:

supersedingEventId - Id of the SupersedingEvent

Returns:

the superseding event enablers

Throws:

NotFoundException - supersedingEventId is not found

NullArgumentException - supersedingEventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSupersedingEventIdsForSupersedingEventEnabler

IdList getSupersedingEventIdsForSupersedingEventEnabler(Id supersedingEventEnablerId)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Gets the SupersedingEvent Ids mapped to a SupersedingEventEnabler.

Parameters:

supersedingEventEnablerId - Id of a SupersedingEventEnabler

Returns:

list of superseding event Ids

Throws:

NotFoundException - supersedingEventEnablerId is not found

NullArgumentException - supersedingEventEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSupersedingEventsForSupersedingEventEnabler

SupersedingEventList getSupersedingEventsForSupersedingEventEnabler(Id supersedingEventEnablerId)
                                                                    throws NotFoundException,
                                                                           OperationFailedException,
                                                                           PermissionDeniedException

Gets the SupersedingEvents mapped to a SupersedingEventEnabler.

Parameters:

supersedingEventEnablerId - Id of a SupersedingEventEnabler

Returns:

list of superseding events

Throws:

NotFoundException - supersedingEventEnablerId is not found

NullArgumentException - supersedingEventEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.