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:
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. |
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 canLookupOffsetEventEnablerRules()
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 useComparativeOffsetEventEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryOffsetEventEnablerRuleView()
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.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 getOffsetEventEnablerIdsForOffsetEvent(Id offsetEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OffsetEventEnabler Id
associated with an
OffsetEvent.
offsetEventId
- Id
of the OffsetEvent
Ids
NotFoundException
- offsetEventId
is not
foundNullArgumentException
- offsetEventId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OffsetEventEnablerList getOffsetEventEnablersForOffsetEvent(Id offsetEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OffsetEventEnablers
associated with an
OffsetEvent.
offsetEventId
- Id
of the OffsetEvent
NotFoundException
- offsetEventId
is not
foundNullArgumentException
- offsetEventId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getOffsetEventIdsForOffsetEventEnabler(Id offsetEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OffsetEvent
Ids
mapped to an
OffsetEventEnabler.
offsetEventEnablerId
- Id
of an
OffsetEventEnabler
Ids
NotFoundException
- offsetEventEnablerId
is not foundNullArgumentException
- offsetEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OffsetEventList getOffsetEventsForOffsetEventEnabler(Id offsetEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OffsetEvents
mapped to an
OffsetEventEnabler.
offsetEventEnablerId
- Id
of an
OffsetEventEnabler
NotFoundException
- offsetEventEnablerId
is not foundNullArgumentException
- offsetEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.