Interface CalendarFormattingSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CalendarFormattingSession
extends OsidSession

This session defines methods to format and parse date times of the calendar and time type defined.

Method Summary

Modifier and Type	Method	Description
boolean	canDisplayPrimitives()	Tests if this user can format and parse date times.
String[]	datetimesToStrings(DateTimeList datetimes)	Gets a string representation of a list of datetimes.
String	datetimeToString(DateTime datetime)	Gets a string representation of a datetime.
String[]	durationsToStrings(DurationList durations)	Gets a string representation of a list of durations.
String	durationToString(Duration duration)	Gets a string representation of a duration.
Type	getCalendarType()	Gets the calendar type for the datetimes used in this session.
Type	getDateFormatType()	Gets the date format type used in this session.
Type	getTimeFormatType()	Gets the time format type used in this session.
Type	getTimeType()	Gets the time type for the times used in this session.
DateTime	stringToDateTime(String s)	Parses a date time string.
Duration	stringToDuration(String s)	Parses a duration string.
Time	stringToTime(String s)	Parses a time string.
String[]	timesToStrings(TimeList times)	Gets a string representation of a list of times.
String	timeToString(Time time)	Gets a string representation of a time.

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 datetimes used in this session.

Returns:

the calendar type

Compliance:

mandatory - This method must be implemented.

getTimeType

Type getTimeType()

Gets the time type for the times used in this session.

Returns:

the time type

Compliance:

mandatory - This method must be implemented.

getDateFormatType

Type getDateFormatType()

Gets the date format type used in this session.

Returns:

the target language

Compliance:

mandatory - This method must be implemented.

getTimeFormatType

Type getTimeFormatType()

Gets the time format type used in this session.

Returns:

the target script

Compliance:

mandatory - This method must be implemented.

canDisplayPrimitives

boolean canDisplayPrimitives()

Tests if this user can format and parse date times. 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 translation methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

datetimeToString

String datetimeToString(DateTime datetime)
                 throws OperationFailedException,
PermissionDeniedException

Gets a string representation of a datetime.

Parameters:

datetime - a datetime value

Returns:

the display string

Throws:

InvalidArgumentException - datetime.getCalendarType() != getCalendarType() or datetime.getTimeType() != getTimeType()

NullArgumentException - datetime is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

datetimesToStrings

String[] datetimesToStrings(DateTimeList datetimes)
                     throws OperationFailedException,
PermissionDeniedException

Gets a string representation of a list of datetimes.

Parameters:

datetimes - a datetime value list

Returns:

the display strings

Throws:

InvalidArgumentException - datetime.getCalendarType() != getCalendarType() or datetime.getTimeType() != getTimeType()

NullArgumentException - datetimes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

stringToDateTime

DateTime stringToDateTime(String s)
                   throws OperationFailedException,
PermissionDeniedException

Parses a date time string.

Parameters:

s - a datetime string

Returns:

the date time value

Throws:

InvalidArgumentException - s is not of getDateFormatType() or s is not of getTimeFormatType()

NullArgumentException - s is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

timeToString

String timeToString(Time time)
             throws OperationFailedException,
PermissionDeniedException

Gets a string representation of a time.

Parameters:

time - a time value

Returns:

the display string

Throws:

InvalidArgumentException - time.getTimeType() != getTimeType()

NullArgumentException - time is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

timesToStrings

String[] timesToStrings(TimeList times)
                 throws OperationFailedException,
PermissionDeniedException

Gets a string representation of a list of times.

Parameters:

times - a time value list

Returns:

the display strings

Throws:

InvalidArgumentException - time.getTimeType() != getTimeType()

NullArgumentException - times is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

stringToTime

Time stringToTime(String s)
           throws OperationFailedException,
PermissionDeniedException

Parses a time string.

Parameters:

s - a time string

Returns:

the time value

Throws:

InvalidArgumentException - s is not of getTimeFormatType()

NullArgumentException - s is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

durationToString

String durationToString(Duration duration)
                 throws OperationFailedException,
PermissionDeniedException

Gets a string representation of a duration.

Parameters:

duration - a duration value

Returns:

the display string

Throws:

InvalidArgumentException - duration.getCalendarType() != getCalendarType() or duration.getTimeType() != getTimeType()

NullArgumentException - duration is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

durationsToStrings

String[] durationsToStrings(DurationList durations)
                     throws OperationFailedException,
PermissionDeniedException

Gets a string representation of a list of durations.

Parameters:

durations - a duration value list

Returns:

the display strings

Throws:

InvalidArgumentException - duration.getCalendarType() != getCalendarType() or duration.getTimeType() != getTimeType()

NullArgumentException - durations is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

stringToDuration

Duration stringToDuration(String s)
                   throws OperationFailedException,
PermissionDeniedException

Parses a duration string.

Parameters:

s - a duration string

Returns:

the duration value

Throws:

InvalidArgumentException - s is not of getDateFormatType() or s is not of getTimeFormatType()

NullArgumentException - s is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.