Interface TimePeriodCalendarSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

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:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupTimePeriodCalendarMappings

boolean canLookupTimePeriodCalendarMappings()

Tests if this user can perform lookups of time period/calendar mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeCalendarView

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. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryCalendarView

void usePlenaryCalendarView()

A complete view of the 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.

Compliance:

mandatory - This method is must be implemented.

getTimePeriodIdsByCalendar

IdList getTimePeriodIdsByCalendar(Id calendarId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of TimePeriod Ids associated with an Calendar .

Parameters:

calendarId - Id of the Calendar

Returns:

list of related time period Ids

Throws:

NotFoundException - calendarId is not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTimePeriodsByCalendar

TimePeriodList getTimePeriodsByCalendar(Id calendarId)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of TimePeriods associated with an Calendar .

Parameters:

calendarId - Id of the Calendar

Returns:

list of related time periods

Throws:

NotFoundException - calendarId is not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTimePeriodIdsByCalendars

IdList getTimePeriodIdsByCalendars(IdList calendarIds)
                            throws OperationFailedException,
PermissionDeniedException

Gets the list of TimePeriod Ids corresponding to a list of Calendars .

Parameters:

calendarIds - list of calendar Ids

Returns:

list of time period Ids

Throws:

NullArgumentException - calendarIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTimePeriodsByCalendars

TimePeriodList getTimePeriodsByCalendars(IdList calendarIds)
                                  throws OperationFailedException,
PermissionDeniedException

Gets the list of TimePeriods corresponding to a list of Calendars .

Parameters:

calendarIds - list of calendar Ids

Returns:

list of time periods

Throws:

NullArgumentException - calendarIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCalendarIdsByTimePeriod

IdList getCalendarIdsByTimePeriod(Id timePeriodId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Calendar Ids mapped to a TimePeriod .

Parameters:

timePeriodId - Id of a TimePeriod

Returns:

list of calendar Ids

Throws:

NotFoundException - timePeriodId is not found

NullArgumentException - timePeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCalendarsByTimePeriod

CalendarList getCalendarsByTimePeriod(Id timePeriodId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Calendars mapped to a TimePeriod .

Parameters:

timePeriodId - Id of a TimePeriod

Returns:

list of calendar Ids

Throws:

NotFoundException - timePeriodId is not found

NullArgumentException - timePeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.