public interface TimePeriodCalendarSession extends OsidSession
This session provides methods to retrieve TimePeriod
to
Calendar
mappings. A TimePeriod
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 |
canLookupTimePeriodCalendarMappings()
Tests if this user can perform lookups of time period/calendar
mappings.
|
IdList |
getCalendarIdsByTimePeriod(Id timePeriodId)
Gets the list of
Calendar Ids mapped to a
TimePeriod. |
CalendarList |
getCalendarsByTimePeriod(Id timePeriodId)
Gets the list of
Calendars mapped to a
TimePeriod. |
IdList |
getTimePeriodIdsByCalendar(Id calendarId)
Gets the list of
TimePeriod Ids
associated with an Calendar. |
IdList |
getTimePeriodIdsByCalendars(IdList calendarIds)
Gets the list of
TimePeriod Ids corresponding to a list
of Calendars. |
TimePeriodList |
getTimePeriodsByCalendar(Id calendarId)
Gets the list of
TimePeriods associated with an
Calendar. |
TimePeriodList |
getTimePeriodsByCalendars(IdList calendarIds)
Gets the list of
TimePeriods 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
TimePeriod and Calendar
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupTimePeriodCalendarMappings()
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()
TimePeriod
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 getTimePeriodIdsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
TimePeriod
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. TimePeriodList getTimePeriodsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
TimePeriods
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 getTimePeriodIdsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
TimePeriod 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. TimePeriodList getTimePeriodsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
TimePeriods
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 getCalendarIdsByTimePeriod(Id timePeriodId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendar Ids
mapped to a
TimePeriod.
timePeriodId
- Id
of a TimePeriod
Ids
NotFoundException
- timePeriodId
is not
foundNullArgumentException
- timePeriodId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CalendarList getCalendarsByTimePeriod(Id timePeriodId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendars
mapped to a
TimePeriod.
timePeriodId
- Id
of a TimePeriod
Ids
NotFoundException
- timePeriodId
is not
foundNullArgumentException
- timePeriodId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.