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:
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. |
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 canLookupSupersedingEventEnablerRules()
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 useComparativeSupersedingEventEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenarySupersedingEventEnablerRuleView()
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.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 getSupersedingEventEnablerIdsForSupersedingEvent(Id supersedingEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SupersedingEventEnabler Id
associated with a
SupersedingEvent.
supersedingEventId
- Id
of the
SupersedingEvent
Ids
NotFoundException
- supersedingEventId
is not foundNullArgumentException
- supersedingEventId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SupersedingEventEnablerList getSupersedingEventEnablersForSupersedingEvent(Id supersedingEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SupersedingEventEnabler
associated with a
SupersedingEvent.
supersedingEventId
- Id
of the
SupersedingEvent
NotFoundException
- supersedingEventId
is not foundNullArgumentException
- supersedingEventId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getSupersedingEventIdsForSupersedingEventEnabler(Id supersedingEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SupersedingEvent
Ids
mapped to
a SupersedingEventEnabler.
supersedingEventEnablerId
- Id
of a
SupersedingEventEnabler
Ids
NotFoundException
- supersedingEventEnablerId
is not foundNullArgumentException
-
supersedingEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SupersedingEventList getSupersedingEventsForSupersedingEventEnabler(Id supersedingEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SupersedingEvents
mapped to a
SupersedingEventEnabler.
supersedingEventEnablerId
- Id
of a
SupersedingEventEnabler
NotFoundException
- supersedingEventEnablerId
is not foundNullArgumentException
-
supersedingEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.