Interface CommitmentCalendarSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

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:

• 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	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.

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

canLookupCommitmentCalendarMappings

boolean canLookupCommitmentCalendarMappings()

Tests if this user can perform lookups of commitment/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 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.

Compliance:

mandatory - This method is must be implemented.

getCommitmentIdsByCalendar

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

Gets the list of Commitment Ids associated with an Calendar .

Parameters:

calendarId - Id of the Calendar

Returns:

list of related commitment 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.

getCommitmentsByCalendar

CommitmentList getCommitmentsByCalendar(Id calendarId)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Commitments associated with an Calendar .

Parameters:

calendarId - Id of the Calendar

Returns:

list of related commitments

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.

getCommitmentIdsByCalendars

IdList getCommitmentIdsByCalendars(IdList calendarIds)
                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

calendarIds - list of calendar Ids

Returns:

list of commitment Ids

Throws:

NullArgumentException - calendarIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCommitmentsByCalendars

CommitmentList getCommitmentsByCalendars(IdList calendarIds)
                                  throws OperationFailedException,
PermissionDeniedException

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

Parameters:

calendarIds - list of calendar Ids

Returns:

list of commitments

Throws:

NullArgumentException - calendarIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCalendarIdsByCommitment

IdList getCalendarIdsByCommitment(Id commitmentId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Calendar Ids mapped to a Commitment .

Parameters:

commitmentId - Id of a Commitment

Returns:

list of calendar Ids

Throws:

NotFoundException - commitmentId is not found

NullArgumentException - commitmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCalendarsByCommitment

CalendarList getCalendarsByCommitment(Id commitmentId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Calendars mapped to a Commitment .

Parameters:

commitmentId - Id of a Commitment

Returns:

list of calendar Ids

Throws:

NotFoundException - commitmentId is not found

NullArgumentException - commitmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.