public interface RecurringEventEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve RecurringEventEnabler
to RecurringEvent
mappings. An Calendar
with multiple RecurringEventEnablers
means any
positive rule evaluation across the enablers result in an effective
RecurringEvent.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupRecurringEventEnablerRules()
Tests if this user can perform lookups of recurring event
enabler/recurring event mappings.
|
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
IdList |
getRecurringEventEnablerIdsForRecurringEvent(Id recurringEventId)
Gets the
RecurringEventEnabler Id associated with a
RecurringEvent. |
RecurringEventEnablerList |
getRecurringEventEnablersForRecurringEvent(Id recurringEventId)
Gets the
RecurringEventEnablers associated with a
RecurringEvent. |
IdList |
getRecurringEventIdsForRecurringEventEnabler(Id recurringEventEnablerId)
Gets the
RecurringEvent Ids mapped to a
RecurringEventEnabler. |
RecurringEventList |
getRecurringEventsForRecurringEventEnabler(Id recurringEventEnablerId)
Gets the
RecurringEvents mapped to a
RecurringEventEnabler. |
void |
useComparativeRecurringEventEnablerRuleView()
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 |
usePlenaryRecurringEventEnablerRuleView()
A complete view of the
RecurringEventEnabler and
RecurringEvent returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCalendarId()
Calendar
Id
associated with
this session. Calendar Id
associated with this sessionmandatory
- This method must be implemented. Calendar getCalendar() throws OperationFailedException, PermissionDeniedException
Calendar
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupRecurringEventEnablerRules()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations to
unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeRecurringEventEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryRecurringEventEnablerRuleView()
RecurringEventEnabler
and
RecurringEvent
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.mandatory
- This method is must be implemented. void useFederatedCalendarView()
mandatory
- This method is must be implemented. void useIsolatedCalendarView()
mandatory
- This method is must be implemented. IdList getRecurringEventEnablerIdsForRecurringEvent(Id recurringEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RecurringEventEnabler Id
associated with a
RecurringEvent.
recurringEventId
- Id
of the
RecurringEvent
Ids
NotFoundException
- recurringEventId
is
not foundNullArgumentException
- recurringEventId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RecurringEventEnablerList getRecurringEventEnablersForRecurringEvent(Id recurringEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RecurringEventEnablers
associated with a
RecurringEvent.
recurringEventId
- Id
of the
RecurringEvent
NotFoundException
- recurringEventId
is
not foundNullArgumentException
- recurringEventId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getRecurringEventIdsForRecurringEventEnabler(Id recurringEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RecurringEvent
Ids
mapped to a
RecurringEventEnabler.
recurringEventEnablerId
- Id
of a
RecurringEventEnabler
Ids
NotFoundException
- recurringEventEnablerId
is not foundNullArgumentException
- recurringEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RecurringEventList getRecurringEventsForRecurringEventEnabler(Id recurringEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RecurringEvents
mapped to a
RecurringEventEnabler.
recurringEventEnablerId
- Id
of a
RecurringEventEnabler
NotFoundException
- recurringEventEnablerId
is not foundNullArgumentException
- recurringEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.