OSID - osid.contact.AddressBookHierarchySession Service Interface Definition

Interface	osid.contact.AddressBookHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `AddressBook` objects. Each node in the hierarchy is a unique `AddressBook.` The hierarchy may be traversed recursively to establish the tree structure through `getParentAddressBooks()` and `getChildAddressBooks().` To relate these `Ids` to another OSID, `getAddressBookNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `AddressBook` available in the Contact 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 `getParentAddressBooks()` or `getChildAddressBooks()` 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: address book elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition
Method	getAddressBookHierarchyId
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	getAddressBookHierarchy
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	canAccessAddressBookHierarchy
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	useComparativeAddressBookView
Description	The returns from the address book 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	usePlenaryAddressBookView
Description	A complete view of the `AddressBook` 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	getRootAddressBookIds
Description	Gets the root address book `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root address book `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootAddressBooks
Description	Gets the root address books in the address book hierarchy. A node with no parents is an orphan. While all address book `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.contact.AddressBookList`		the root address books
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentAddressBooks
Description	Tests if the `AddressBook` has any parents.
Parameters	`osid.id.Id`	`addressBookId`	an address book `Id`
Return	`boolean`		`true` if the address book has parents, f `alse` otherwise
Errors	NOT_FOUND		`addressBookId` is not found
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfAddressBook
Description	Tests if an `Id` is a direct parent of address book.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of an address book
Return	`boolean`		`true` if this `id` is a parent of `addressBookId,` f `alse` otherwise
Errors	NOT_FOUND		`addressBookId` is not found
	NULL_ARGUMENT		`id` or `addressBookId` 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	getParentAddressBookIds
Description	Gets the parent `Ids` of the given address book.
Parameters	`osid.id.Id`	`addressBookId`	an address book `Id`
Return	`osid.id.IdList`		the parent `Ids` of the address book
Errors	NOT_FOUND		`addressBookId` is not found
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentAddressBooks
Description	Gets the parent address books of the given `id.`
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook` to query
Return	`osid.contact.AddressBookList`		the parent address books of the `id`
Errors	NOT_FOUND		an `AddressBook` identified by `Id is` not found
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfAddressBook
Description	Tests if an `Id` is an ancestor of an address book.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of an address book
Return	`boolean`		`tru` e if this `id` is an ancestor of `addressBookId,` `false` otherwise
Errors	NOT_FOUND		`addressBookId` is not found
	NULL_ARGUMENT		`id` or `addressBookId` 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	hasChildAddressBooks
Description	Tests if an address book has any children.
Parameters	`osid.id.Id`	`addressBookId`	an address book `Id`
Return	`boolean`		`true` if the `addressBookId` has children, `false` otherwise
Errors	NOT_FOUND		`addressBookId` is not found
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfAddressBook
Description	Tests if an address book is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of an address book
Return	`boolean`		`true` if the `id` is a child of `addressBookId,` `false` otherwise
Errors	NOT_FOUND		`addressBookId` is not found
	NULL_ARGUMENT		`id` or `addressBookId` 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	getChildAddressBookIds
Description	Gets the child `Ids` of the given address book.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` to query
Return	`osid.id.IdList`		the children of the address book
Errors	NOT_FOUND		`addressBookId` is not found
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildAddressBooks
Description	Gets the child address books of the given `id.`
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook` to query
Return	`osid.contact.AddressBookList`		the child address books of the `id`
Errors	NOT_FOUND		an `AddressBook` identified by `Id is` not found
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfAddressBook
Description	Tests if an `Id` is a descendant of an address book.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of an address book
Return	`boolean`		`true` if the `id` is a descendant of the `addressBookId,` `false` otherwise
Errors	NOT_FOUND		`addressBookId` is not found
	NULL_ARGUMENT		`id` or `addressBookId` 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	getAddressBookNodeIds
Description	Gets a portion of the hierarchy for the given address book.
Parameters	`osid.id.Id`	`addressBookId`	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`		an address book node
Errors	NOT_FOUND		`addressBookId` is not found
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAddressBookNodes
Description	Gets a portion of the hierarchy for the given address book.
Parameters	`osid.id.Id`	`addressBookId`	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.contact.AddressBookNode`		an address book node
Errors	NOT_FOUND		`addressBookId` is not found
	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.