public interface CommitmentEnablerCalendarSession extends OsidSession
This session provides methods to retrieve CommitmentEnabler
to Calendar
mappings. A CommitmentEnabler
may appear in multiple Calendar
objects. Each
calendar may have its own authorizations governing who is allowed to look
at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupCommitmentEnablerCalendarMappings()
Tests if this user can perform lookups of commitment enabler/calendar
mappings.
|
IdList |
getCalendarIdsByCommitmentEnabler(Id commitmentEnablerId)
Gets the
Calendar Ids mapped to a
CommitmentEnabler. |
CalendarList |
getCalendarsByCommitmentEnabler(Id commitmentEnablerId)
Gets the
Calendars mapped to a
CommitmentEnabler. |
IdList |
getCommitmentEnablerIdsByCalendar(Id calendarId)
Gets the list of
CommitmentEnabler Ids associated with
a Calendar. |
IdList |
getCommitmentEnablerIdsByCalendars(IdList calendarIds)
Gets the list of
CommitmentEnabler Ids corresponding to
a list of Calendars. |
CommitmentEnablerList |
getCommitmentEnablersByCalendar(Id calendarId)
Gets the list of commitment enablers associated with a
Calendar. |
CommitmentEnablerList |
getCommitmentEnablersByCalendars(IdList calendarIds)
Gets the list of commitment enablers corresponding to a list of
Calendars. |
void |
useComparativeCommitmentEnablerCalendarView()
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 |
usePlenaryCommitmentEnablerCalendarView()
A complete view of the
CommitmentEnabler and
Calendar returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupCommitmentEnablerCalendarMappings()
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 useComparativeCommitmentEnablerCalendarView()
mandatory
- This method is must be implemented. void usePlenaryCommitmentEnablerCalendarView()
CommitmentEnabler
and
Calendar
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. IdList getCommitmentEnablerIdsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CommitmentEnabler Ids
associated with
a Calendar.
calendarId
- Id
of the Calendar
Ids
NotFoundException
- calendarId
is not
foundNullArgumentException
- calendarId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CommitmentEnablerList getCommitmentEnablersByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendar.
calendarId
- Id
of the Calendar
NotFoundException
- calendarId
is not
foundNullArgumentException
- calendarId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCommitmentEnablerIdsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
CommitmentEnabler Ids
corresponding to
a list of Calendars.
calendarIds
- list of calendar Ids
Ids
NullArgumentException
- calendarIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CommitmentEnablerList getCommitmentEnablersByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
Calendars.
calendarIds
- list of calendar Ids
NullArgumentException
- calendarIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCalendarIdsByCommitmentEnabler(Id commitmentEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendar
Ids
mapped to a
CommitmentEnabler.
commitmentEnablerId
- Id
of a
CommitmentEnabler
NotFoundException
- commitmentEnablerId
is not foundNullArgumentException
- commitmentEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CalendarList getCalendarsByCommitmentEnabler(Id commitmentEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendars
mapped to a
CommitmentEnabler.
commitmentEnablerId
- Id
of a
CommitmentEnabler
NotFoundException
- commitmentEnablerId
is not foundNullArgumentException
- commitmentEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.