Interface CalendarConversionSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CalendarConversionSession
extends OsidSession

This session defines methods to convert dates across calendar systems.

Method Summary

Modifier and Type	Method	Description
boolean	canConvertCalendars()	Tests if this user can perform calendar conversions.
DateTime	convertCalendar(DateTime sourceDate)	Converts a date.
DateTimeList	convertCalendars(DateTimeList sourceDateList)	Converts dates.
Type	getSourceCalendarType()	Gets the source calendar type used in this session.
Type	getSourceTimeType()	Gets the source time type used in this session.
Type	getTargetCalendarType()	Gets the target calendar type used in this session.
Type	getTargetTimeType()	Gets the target time type used 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

getSourceCalendarType

Type getSourceCalendarType()

Gets the source calendar type used in this session.

Returns:

the source calendar type

Compliance:

mandatory - This method must be implemented.

getSourceTimeType

Type getSourceTimeType()

Gets the source time type used in this session.

Returns:

the source time type

Compliance:

mandatory - This method must be implemented.

getTargetCalendarType

Type getTargetCalendarType()

Gets the target calendar type used in this session.

Returns:

the target calendar

Compliance:

mandatory - This method must be implemented.

getTargetTimeType

Type getTargetTimeType()

Gets the target time type used in this session.

Returns:

the target time type

Compliance:

mandatory - This method must be implemented.

canConvertCalendars

boolean canConvertCalendars()

Tests if this user can perform calendar conversions. 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.

convertCalendar

DateTime convertCalendar(DateTime sourceDate)
                  throws OperationFailedException,
PermissionDeniedException

Converts a date.

Parameters:

sourceDate - the date to convert

Returns:

the resulting date

Throws:

InvalidArgumentException - sourceDate.getCalendarType() != getSourceCalendarType() or sourceDate.getTimeType() != getSourceTimeType()

NullArgumentException - sourceDate is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

convertCalendars

DateTimeList convertCalendars(DateTimeList sourceDateList)
                       throws OperationFailedException,
PermissionDeniedException

Converts dates.

Parameters:

sourceDateList - the dates to convert

Returns:

the resulting dates

Throws:

InvalidArgumentException - sourceDate.getCalendarType() != getSourceCalendarType() or sourceDate.getTimeType() != getSourceTimeType()

NullArgumentException - sourceDateList is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.