OSID - osid.calendaring.CalendarHierarchySession Service Interface Definition

Interface	osid.calendaring.CalendarHierarchySession
Implements	`osid.OsidSession`
Description	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	getCalendarHierarchyId
Description	Gets the hierarchy `Id` associated with this session.
Return	`osid.id.Id`		the hierarchy `Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCalendarHierarchy
Description	Gets the hierarchy associated with this session.
Return	`osid.hierarchy.Hierarchy`		the hierarchy associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAccessCalendarHierarchy
Description	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.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeCalendarView
Description	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.
Method	usePlenaryCalendarView
Description	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.
Method	getRootCalendarIds
Description	Gets the root calendar `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root calendar `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootCalendars
Description	Gets the root calendars in this calendar hierarchy.
Return	`osid.calendaring.CalendarList`		the root calendars
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentCalendars
Description	Tests if the `Calendar` has any parents.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of a calendar
Return	`boolean`		`true` if the calendar has parents, `false` otherwise
Errors	NOT_FOUND		`calendarId` is not found
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfCalendar
Description	Tests if an `Id` is a direct parent of a calendar.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`calendarId`	the `Id` of a calendar
Return	`boolean`		`true` if this `id` is a parent of `calendarId,` `false` otherwise
Errors	NOT_FOUND		`calendarId` is not found
	NULL_ARGUMENT		`id` or `calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	getParentCalendarIds
Description	Gets the parent `Ids` of the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of a calendar
Return	`osid.id.IdList`		the parent `Ids` of the calendar
Errors	NOT_FOUND		`calendarId` is not found
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentCalendars
Description	Gets the parents of the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of a calendar
Return	`osid.calendaring.CalendarList`		the parents of the calendar
Errors	NOT_FOUND		`calendarId` is not found
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfCalendar
Description	Tests if an `Id` is an ancestor of a calendar.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`calendarId`	the `Id` of a calendar
Return	`boolean`		`true` if this `id` is an ancestor of `calendarId,` `false` otherwise
Errors	NOT_FOUND		`calendarId` is not found
	NULL_ARGUMENT		`id` or `calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	hasChildCalendars
Description	Tests if a calendar has any children.
Parameters	`osid.id.Id`	`calendarId`	the `Id` of a calendar
Return	`boolean`		`true` if the `calendarId` has children, `false` otherwise
Errors	NOT_FOUND		`calendarId` is not found
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfCalendar
Description	Tests if a calendar is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`calendarId`	the `Id` of a calendar
Return	`boolean`		`true` if the `id` is a child of `calendarId,` `false` otherwise
Errors	NOT_FOUND		`calendarId` is not found
	NULL_ARGUMENT		`id` or `calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	getChildCalendarIds
Description	Gets the child `Ids` of the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` to query
Return	`osid.id.IdList`		the children of the calendar
Errors	NOT_FOUND		`calendarId` is not found
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildCalendars
Description	Gets the children of the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` to query
Return	`osid.calendaring.CalendarList`		the children of the calendar
Errors	NOT_FOUND		`calendarId` is not found
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfCalendar
Description	Tests if an `Id` is a descendant of a calendar.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`calendarId`	the `Id` of a calendar
Return	`boolean`		`true` if the `id` is a descendant of the `calendarId,` `false` otherwise
Errors	NOT_FOUND		`calendarId` is not found
	NULL_ARGUMENT		`id` or `calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` is not found return `false.`
Method	getCalendarNodeIds
Description	Gets a portion of the hierarchy for the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.hierarchy.Node`		a catalog node
Errors	NOT_FOUND		`calendarId` not found
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCalendarNodes
Description	Gets a portion of the hierarchy for the given calendar.
Parameters	`osid.id.Id`	`calendarId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.calendaring.CalendarNode`		a calendar node
Errors	NOT_FOUND		`calendarId` not found
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.