public interface CommitmentCalendarSession extends OsidSession
This session provides methods to retrieve Commitment
to
Calendar
mappings. A Commitment
may appear
in multiple Calendars.
Each Calendar
may
have its own authorizations governing who is allowed to look at it.
This lookup session defines two views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupCommitmentCalendarMappings()
Tests if this user can perform lookups of commitment/calendar
mappings.
|
IdList |
getCalendarIdsByCommitment(Id commitmentId)
Gets the list of
Calendar Ids mapped to a
Commitment. |
CalendarList |
getCalendarsByCommitment(Id commitmentId)
Gets the list of
Calendars mapped to a
Commitment. |
IdList |
getCommitmentIdsByCalendar(Id calendarId)
Gets the list of
Commitment Ids
associated with an Calendar. |
IdList |
getCommitmentIdsByCalendars(IdList calendarIds)
Gets the list of
Commitment Ids corresponding to a list
of Calendars. |
CommitmentList |
getCommitmentsByCalendar(Id calendarId)
Gets the list of
Commitments associated with an
Calendar. |
CommitmentList |
getCommitmentsByCalendars(IdList calendarIds)
Gets the list of
Commitments corresponding to a list of
Calendars. |
void |
useComparativeCalendarView()
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 |
usePlenaryCalendarView()
A complete view of the
Commitment and Calendar
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupCommitmentCalendarMappings()
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 useComparativeCalendarView()
mandatory
- This method is must be implemented. void usePlenaryCalendarView()
Commitment
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 getCommitmentIdsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Commitment
Ids
associated with an 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. CommitmentList getCommitmentsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Commitments
associated with an
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 getCommitmentIdsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
Commitment 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. CommitmentList getCommitmentsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
Commitments
corresponding to a list of
Calendars.
calendarIds
- list of calendar Ids
NullArgumentException
- calendarIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCalendarIdsByCommitment(Id commitmentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendar Ids
mapped to a
Commitment.
commitmentId
- Id
of a Commitment
Ids
NotFoundException
- commitmentId
is not
foundNullArgumentException
- commitmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CalendarList getCalendarsByCommitment(Id commitmentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendars
mapped to a
Commitment.
commitmentId
- Id
of a Commitment
Ids
NotFoundException
- commitmentId
is not
foundNullArgumentException
- commitmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.