Interface CalendarHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CalendarHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Calendar objects. Each node in the hierarchy is a unique Calendar . The hierarchy may be traversed recursively to establish the tree structure through getParentCalendars() and getChildCalendars() . To relate these Ids to another OSID, getCalendarNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Calendar available in the Calendaring OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node.

A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of getParentCalendars() or getChildCalendars() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized pathways.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: calendar elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canAccessCalendarHierarchy()	Tests if this user can perform hierarchy queries.
Hierarchy	getCalendarHierarchy()	Gets the hierarchy associated with this session.
Id	getCalendarHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getCalendarNodeIds(Id calendarId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given calendar.
CalendarNode	getCalendarNodes(Id calendarId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given calendar.
IdList	getChildCalendarIds(Id calendarId)	Gets the child Ids of the given calendar.
CalendarList	getChildCalendars(Id calendarId)	Gets the children of the given calendar.
IdList	getParentCalendarIds(Id calendarId)	Gets the parent Ids of the given calendar.
CalendarList	getParentCalendars(Id calendarId)	Gets the parents of the given calendar.
IdList	getRootCalendarIds()	Gets the root calendar Ids in this hierarchy.
CalendarList	getRootCalendars()	Gets the root calendars in this calendar hierarchy.
boolean	hasChildCalendars(Id calendarId)	Tests if a calendar has any children.
boolean	hasParentCalendars(Id calendarId)	Tests if the Calendar has any parents.
boolean	isAncestorOfCalendar(Id id, Id calendarId)	Tests if an Id is an ancestor of a calendar.
boolean	isChildOfCalendar(Id id, Id calendarId)	Tests if a calendar is a direct child of another.
boolean	isDescendantOfCalendar(Id id, Id calendarId)	Tests if an Id is a descendant of a calendar.
boolean	isParentOfCalendar(Id id, Id calendarId)	Tests if an Id is a direct parent of a calendar.
void	useComparativeCalendarView()	The returns from the calendar methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryCalendarView()	A complete view of the Hierarchy returns is desired.

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.

canAccessCalendarHierarchy

boolean canAccessCalendarHierarchy()

Tests if this user can perform hierarchy queries. 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 an application that may not offer traversal functions to unauthorized users.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeCalendarView

void useComparativeCalendarView()

The returns from the calendar methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryCalendarView

void usePlenaryCalendarView()

A complete view of the Hierarchy returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getRootCalendarIds

IdList getRootCalendarIds()
                   throws OperationFailedException,
PermissionDeniedException

Gets the root calendar Ids in this hierarchy.

Returns:

the root calendar Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootCalendars

CalendarList getRootCalendars()
                       throws OperationFailedException,
PermissionDeniedException

Gets the root calendars in this calendar hierarchy.

Returns:

the root calendars

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentCalendars

boolean hasParentCalendars(Id calendarId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Calendar has any parents.

Parameters:

calendarId - the Id of a calendar

Returns:

true if the calendar has parents, false otherwise

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.

isParentOfCalendar

boolean isParentOfCalendar(Id id,
 Id calendarId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of a calendar.

Parameters:

id - an Id

calendarId - the Id of a calendar

Returns:

true if this id is a parent of calendarId , false otherwise

Throws:

NotFoundException - calendarId is not found

NullArgumentException - id or calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getParentCalendarIds

IdList getParentCalendarIds(Id calendarId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given calendar.

Parameters:

calendarId - the Id of a calendar

Returns:

the parent Ids of the calendar

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.

getParentCalendars

CalendarList getParentCalendars(Id calendarId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given calendar.

Parameters:

calendarId - the Id of a calendar

Returns:

the parents of the calendar

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.

isAncestorOfCalendar

boolean isAncestorOfCalendar(Id id,
 Id calendarId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a calendar.

Parameters:

id - an Id

calendarId - the Id of a calendar

Returns:

true if this id is an ancestor of calendarId , false otherwise

Throws:

NotFoundException - calendarId is not found

NullArgumentException - id or calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

hasChildCalendars

boolean hasChildCalendars(Id calendarId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a calendar has any children.

Parameters:

calendarId - the Id of a calendar

Returns:

true if the calendarId has children, false otherwise

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.

isChildOfCalendar

boolean isChildOfCalendar(Id id,
 Id calendarId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a calendar is a direct child of another.

Parameters:

id - an Id

calendarId - the Id of a calendar

Returns:

true if the id is a child of calendarId , false otherwise

Throws:

NotFoundException - calendarId is not found

NullArgumentException - id or calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getChildCalendarIds

IdList getChildCalendarIds(Id calendarId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given calendar.

Parameters:

calendarId - the Id to query

Returns:

the children of the calendar

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.

getChildCalendars

CalendarList getChildCalendars(Id calendarId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given calendar.

Parameters:

calendarId - the Id to query

Returns:

the children of the calendar

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.

isDescendantOfCalendar

boolean isDescendantOfCalendar(Id id,
 Id calendarId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a calendar.

Parameters:

id - an Id

calendarId - the Id of a calendar

Returns:

true if the id is a descendant of the calendarId , false otherwise

Throws:

NotFoundException - calendarId is not found

NullArgumentException - id or calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false} .

getCalendarNodeIds

Node getCalendarNodeIds(Id calendarId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given calendar.

Parameters:

calendarId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a catalog node

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCalendarNodes

CalendarNode getCalendarNodes(Id calendarId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given calendar.

Parameters:

calendarId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a calendar node

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.