Interface CalendarAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

CalendarBatchAdminSession

public interface CalendarAdminSession
extends OsidSession

This session creates, updates, and deletes Calendars . The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Calendar , a CalendarForm is requested using getCalendarFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned CalendarForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the CalendarForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each CalendarForm corresponds to an attempted transaction.

For updates, CalendarForms are requested to the Calendar Id that is to be updated using getCalendarFormForUpdate() . Similarly, the CalendarForm has metadata about the data that can be updated and it can perform validation before submitting the update. The Calendar can only be used once for a successful update and cannot be reused.

The delete operations delete Calendars .This session also includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

Method Summary

Modifier and Type	Method	Description
void	aliasCalendar(Id calendarId, Id aliasId)	Adds an Id to a Calendar for the purpose of creating compatibility.
boolean	canCreateCalendars()	Tests if this user can create Calendars .
boolean	canCreateCalendarWithRecordTypes(Type[] calendarRecordTypes)	Tests if this user can create a single Calendar using the desired record types.
boolean	canDeleteCalendars()	Tests if this user can delete calendars.
boolean	canManageCalendarAliases()	Tests if this user can manage Id aliases for Calendars .
boolean	canUpdateCalendars()	Tests if this user can update Calendars .
Calendar	createCalendar(CalendarForm calendarForm)	Creates a new Calendar .
void	deleteCalendar(Id calendarId)	Deletes a Calendar .
CalendarForm	getCalendarFormForCreate(Type[] calendarRecordTypes)	Gets the calendar form for creating new calendars.
CalendarForm	getCalendarFormForUpdate(Id calendarId)	Gets the calendar form for updating an existing calendar.
void	updateCalendar(CalendarForm calendarForm)	Updates an existing calendar.

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

canCreateCalendars

boolean canCreateCalendars()

Tests if this user can create Calendars . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a Calendar will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.

Returns:

false if Calendar creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateCalendarWithRecordTypes

boolean canCreateCalendarWithRecordTypes(Type[] calendarRecordTypes)

Tests if this user can create a single Calendar using the desired record types. While CalendaringManager.getCalendarRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Calendar . Providing an empty array tests if a Calendar can be created with no records.

Parameters:

calendarRecordTypes - array of calendar record types

Returns:

true if Calendar creation using the specified Types is supported, false otherwise

Throws:

NullArgumentException - calendarRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getCalendarFormForCreate

CalendarForm getCalendarFormForCreate(Type[] calendarRecordTypes)
                               throws OperationFailedException,
PermissionDeniedException

Gets the calendar form for creating new calendars. A new form should be requested for each create transaction.

Parameters:

calendarRecordTypes - array of calendar record types

Returns:

the calendar form

Throws:

NullArgumentException - calendarRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form for requested record types

Compliance:

mandatory - This method must be implemented.

createCalendar

Calendar createCalendar(CalendarForm calendarForm)
                 throws OperationFailedException,
PermissionDeniedException

Creates a new Calendar .

Parameters:

calendarForm - the form for this Calendar

Returns:

the new Calendar

Throws:

IllegalStateException - calendarForm already used for a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - calendarForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - calendarForm did not originate from getCalendarFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateCalendars

boolean canUpdateCalendars()

Tests if this user can update Calendars . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a Calendar will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.

Returns:

false if Calendar modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getCalendarFormForUpdate

CalendarForm getCalendarFormForUpdate(Id calendarId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the calendar form for updating an existing calendar. A new calendar form should be requested for each update transaction.

Parameters:

calendarId - the Id of the Calendar

Returns:

the calendar form

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.

updateCalendar

void updateCalendar(CalendarForm calendarForm)
             throws OperationFailedException,
PermissionDeniedException

Updates an existing calendar.

Parameters:

calendarForm - the form containing the elements to be updated

Throws:

IllegalStateException - calendarForm already used for an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - calendarForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - calendarForm did not originate from getCalendarFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteCalendars

boolean canDeleteCalendars()

Tests if this user can delete calendars. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a Calendar will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.

Returns:

false if Calendar deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteCalendar

void deleteCalendar(Id calendarId)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Deletes a Calendar .

Parameters:

calendarId - the Id of the Calendar to remove

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageCalendarAliases

boolean canManageCalendarAliases()

Tests if this user can manage Id aliases for Calendars . A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returns:

false if Calendar aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasCalendar

void aliasCalendar(Id calendarId,
 Id aliasId)
            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an Id to a Calendar for the purpose of creating compatibility. The primary Id of the Calendar is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another calendar, it is reassigned to the given calendar Id .

Parameters:

calendarId - the Id of a Calendar

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - calendarId not found

NullArgumentException - calendarId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.