org.osid.locale

Interface CalendarInfoSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface CalendarInfoSession
extends OsidSession

This session defines methods to examine a calendar.

Method Summary

Methods

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

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.