Interface CalendarHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CalendarHierarchyDesignSession
extends OsidSession

This session defines methods for managing a hierarchy of Calendar objects. Each node in the hierarchy is a unique Calendar .

Method Summary

Modifier and Type	Method	Description
void	addChildCalendar(Id calendarId, Id childId)	Adds a child to a calendar.
void	addRootCalendar(Id calendarId)	Adds a root calendar.
boolean	canModifyCalendarHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getCalendarHierarchy()	Gets the hierarchy associated with this session.
Id	getCalendarHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildCalendar(Id calendarId, Id childId)	Removes a child from a calendar.
void	removeChildCalendars(Id calendarId)	Removes all children from a calendar.
void	removeRootCalendar(Id calendarId)	Removes a root calendar from this hierarchy.

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

getCalendarHierarchyId

Id getCalendarHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCalendarHierarchy

Hierarchy getCalendarHierarchy()
                        throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canModifyCalendarHierarchy

boolean canModifyCalendarHierarchy()

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returns:

false if changing this hierarchy is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addRootCalendar

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

Adds a root calendar.

Parameters:

calendarId - the Id of a calendar

Throws:

NotFoundException - calendarId not a root

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootCalendar

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

Removes a root calendar from this hierarchy.

Parameters:

calendarId - the Id of a calendar

Throws:

NotFoundException - calendarId not a parent of childId

NullArgumentException - calendarId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildCalendar

void addChildCalendar(Id calendarId,
 Id childId)
               throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a calendar.

Parameters:

calendarId - the Id of a calendar

childId - the Id of the new child

Throws:

AlreadyExistsException - calendarId is already a parent of childId

NotFoundException - calendarId or childId not found

NullArgumentException - calendarId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildCalendar

void removeChildCalendar(Id calendarId,
 Id childId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a calendar.

Parameters:

calendarId - the Id of a calendar

childId - the Id of the new child

Throws:

NotFoundException - calendarId not a parent of childId

NullArgumentException - calendarId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildCalendars

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

Removes all children from a calendar.

Parameters:

calendarId - the Id of a calendar

Throws:

NotFoundException - calendarId is in hierarchy

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.