Interface CalendarInfoSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CalendarInfoSession
extends OsidSession

This session defines methods to examine a calendar.

Method Summary

Modifier and Type	Method	Description
boolean	canExamineCalendars()	Tests if this user can perform calendar inspections.
CalendarInfo	getCalendarInfo()	Gets information about the calendar.
Type	getCalendarType()	Gets the calendar type for the calendar system informational methods in this session.
TimeInfo	getTimeInfo()	Gets information about the time system.
Type	getTimeType()	Gets the time system type for the time system informational methods in this session.

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

getCalendarType

Type getCalendarType()

Gets the calendar type for the calendar system informational methods in this session.

Returns:

the calendar type

Compliance:

mandatory - This method must be implemented.

getTimeType

Type getTimeType()

Gets the time system type for the time system informational methods in this session.

Returns:

the time type

Compliance:

mandatory - This method must be implemented.

canExamineCalendars

boolean canExamineCalendars()

Tests if this user can perform calendar inspections. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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.

Returns:

false if conversion methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getCalendarInfo

CalendarInfo getCalendarInfo()
                      throws OperationFailedException,
PermissionDeniedException

Gets information about the calendar.

Returns:

calendar information

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTimeInfo

TimeInfo getTimeInfo()
              throws OperationFailedException,
PermissionDeniedException

Gets information about the time system.

Returns:

time information

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.