public interface CyclicTimePeriodCalendarSession extends OsidSession
This session provides methods to retrieve CyclicTimePeriod
to Calendar
mappings. A CyclicTimePeriod
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 |
canLookupCyclicTimePeriodCalendarMappings()
Tests if this user can perform lookups of cyclic time period/calendar
mappings.
|
IdList |
getCalendarIdsByCyclicTimePeriod(Id cyclicTimePeriodId)
Gets the list of
Calendar Ids mapped to a
CyclicTimePeriod. |
CalendarList |
getCalendarsByCyclicTimePeriod(Id cyclicTimePeriodId)
Gets the list of
Calendars mapped to a
CyclicTimePeriod. |
IdList |
getCyclicTimePeriodIdsByCalendar(Id calendarId)
Gets the list of
CyclicTimePeriod Ids
associated with an Calendar. |
IdList |
getCyclicTimePeriodIdsByCalendars(IdList calendarIds)
Gets the list of
CyclicTimePeriod Ids corresponding to
a list of Calendars. |
CyclicTimePeriodList |
getCyclicTimePeriodsByCalendar(Id calendarId)
Gets the list of
CyclicTimePeriods associated with an
Calendar. |
CyclicTimePeriodList |
getCyclicTimePeriodsByCalendars(IdList calendarIds)
Gets the list of
CyclicTimePeriods 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
CyclicTimePeriod and
Calendar returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupCyclicTimePeriodCalendarMappings()
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()
CyclicTimePeriod
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 getCyclicTimePeriodIdsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CyclicTimePeriod
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. CyclicTimePeriodList getCyclicTimePeriodsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CyclicTimePeriods
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 getCyclicTimePeriodIdsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
CyclicTimePeriod 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. CyclicTimePeriodList getCyclicTimePeriodsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
CyclicTimePeriods
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 getCalendarIdsByCyclicTimePeriod(Id cyclicTimePeriodId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendar Ids
mapped to a
CyclicTimePeriod.
cyclicTimePeriodId
- Id
of a
CyclicTimePeriod
Ids
NotFoundException
- cyclicTimePeriodId
is not foundNullArgumentException
- cyclicTimePeriodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CalendarList getCalendarsByCyclicTimePeriod(Id cyclicTimePeriodId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Calendars
mapped to a
CyclicTimePeriod.
cyclicTimePeriodId
- Id
of a
CyclicTimePeriod
Ids
NotFoundException
- cyclicTimePeriodId
is not foundNullArgumentException
- cyclicTimePeriodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.