OSID - osid.cataloging.CatalogHierarchySession Service Interface Definition

Interface	osid.cataloging.CatalogHierarchySession
Implements	`osid.OsidSession`
Used By	`osid.cataloging.CatalogingManager`
Used By	`osid.cataloging.CatalogingProxyManager`
Description	This session defines methods for traversing a hierarchy of `Catalogs`. Each node in the hierarchy is a unique `Catalog`. The hierarchy may be traversed recursively to establish the tree structure through `getParentCatalogs()` and `getChildCatalogs()`. To relate these `Ids` to another OSID, `getCatalogNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Catalog` available in the Catalog 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 `getParentCatalogs()` or `getChildCatalogs()` 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: catalog elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition Like all `OsidSessions`, `CatalogHierarchySessions` are dedicated to single processing threads and a single authenticated user.
Method	getCatalogHierarchyId
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	getCatalogHierarchy
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	canAccessCatalogHierarchy
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 application that may opt not to offer lookup operations.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeCatalogView
Description	The returns from the catalog 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 must be implemented.
Method	usePlenaryCatalogView
Description	A complete view of the `Catalog` 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 must be implemented.
Method	getRootCatalogIds
Description	Gets the root catalog `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root catalog `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getRootCatalogs
Description	Gets the root catalogs in the catalog hierarchy. A node with no parents is an orphan. While all catalog `Ids` are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.
Return	`osid.cataloging.CatalogList`		the root catalogs
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	hasParentCatalogs
Description	Tests if the `Catalog` has any parents.
Parameters	`osid.id.Id`	`catalogId`	a catalog `Id`
Return	`boolean`		`true` if the catalog has parents, `false` otherwise
Errors	NOT_FOUND		`catalogId` is not found
	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfCatalog
Description	Tests if an `Id` is a direct parent of a catalog.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`catalogId`	the `Id` of a catalog
Return	`boolean`		`true` if this `id` is a parent of `catalogId`, `false` otherwise
Errors	NOT_FOUND		`catalogId` is not found
	NULL_ARGUMENT		`id` or `catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false`.
Method	getParentCatalogIds
Description	Gets the parent `Ids` of the given catalog.
Parameters	`osid.id.Id`	`catalogId`	a catalog `Id`
Return	`osid.id.IdList`		the parent `Ids` of the catalog
Errors	NOT_FOUND		`catalogId` is not found
	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getParentCatalogs
Description	Gets the parent catalogs of the given `id`.
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `Catalog` to query
Return	`osid.cataloging.CatalogList`		the parent catalogs of the `id`
Errors	NOT_FOUND		a `Catalog` identified by `Id is` not found
	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfCatalog
Description	Tests if an `Id` is an ancestor of a catalog.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`catalogId`	the `Id` of a catalog
Return	`boolean`		`true` if this `id` is an ancestor of `catalogId`. `false` otherwise
Errors	NOT_FOUND		`catalogId` not found
	NULL_ARGUMENT		`catalogId` or `id` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false`.
Method	hasChildCatalogs
Description	Tests if a catalog has any children.
Parameters	`osid.id.Id`	`catalogId`	a `catalogId`
Return	`boolean`		`true` if the `catalogId` has children, `false` otherwise
Errors	NOT_FOUND		`catalogId` is not found
	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfCatalog
Description	Tests if a catalog is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`catalogId`	the `Id` of a catalog
Return	`boolean`		`true` if the `id` is a child of `catalogId`, `false` otherwise
Errors	NOT_FOUND		`catalogId` not found
	NULL_ARGUMENT		`catalogId` or `id` 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	getChildCatalogIds
Description	Gets the child `Ids` of the given catalog.
Parameters	`osid.id.Id`	`catalogId`	the `Id` to query
Return	`osid.id.IdList`		the children of the catalog
Errors	NOT_FOUND		`catalogId` is not found
	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildCatalogs
Description	Gets the child catalogs of the given `id`.
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `Catalog` to query
Return	`osid.cataloging.CatalogList`		the child catalogs of the `id`
Errors	NOT_FOUND		a `Catalog` identified by `Id is` not found
	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfCatalog
Description	Tests if an `Id` is a descendant of a catalog.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`catalogId`	the `Id` of a catalog
Return	`boolean`		`true` if the `id` is a descendant of the `catalogId`, `false` otherwise
Errors	NOT_FOUND		`catalogId` not found
	NULL_ARGUMENT		`catalogId` or `id` 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	getCatalogNodeIds
Description	Gets a portion of the hierarchy for the given catalog.
Parameters	`osid.id.Id`	`catalogId`	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		a `Catalog` identified by `Id is` not found
	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogNodes
Description	Gets a portion of the hierarchy for the given catalog.
Parameters	`osid.id.Id`	`catalogId`	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.cataloging.CatalogNode`		a catalog node
Errors	NOT_FOUND		a `Catalog` identified by `Id is` not found
	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.