OSID - osid.bidding.AuctionHouseHierarchySession Service Interface Definition

Interface	osid.bidding.AuctionHouseHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `AuctionHouse` objects. Each node in the hierarchy is a unique `AuctionHouse.` The hierarchy may be traversed recursively to establish the tree structure through `getParentAuctionHouses()` and `getChildAuctionHouses().` To relate these `Ids` to another OSID, `getAuctionHouseNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `AuctionHouse` available in the Bidding OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root item or a child of another item. 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 `getParentAuctionHouses()` or `getChildAuctionHouses()` in lieu of a `PERMISSION_DENIED` error that may disrupt the traversal through authorized auctionways. This session defines views that offer differing behaviors when retrieving multiple objects. comparative auction house view: auction house elements may be silently omitted or re-ordered plenary auction house view: provides a complete set or is an error condition
Method	getAuctionHouseHierarchyId
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	getAuctionHouseHierarchy
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	canAccessAuctionHouseHierarchy
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	useComparativeAuctionHouseView
Description	The returns from the auction house 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	usePlenaryAuctionHouseView
Description	A complete view of the `Auction Houses` 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	getRootAuctionHouseIds
Description	Gets the root auction house `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root auction house `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootAuctionHouses
Description	Gets the root auction house in the auction house hierarchy. A item with no parents is an orphan. While all auction house `Ids` are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root item or child of another item.
Return	`osid.bidding.AuctionHouseList`		the root auction houses
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentAuctionHouses
Description	Tests if the `AuctionHouse` has any parents.
Parameters	`osid.id.Id`	`auctionHouseId`	an auction house `Id`
Return	`boolean`		`true` if the auction house has parents, f `alse` otherwise
Errors	NOT_FOUND		`auctionHouseId` is not found
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfAuctionHouse
Description	Tests if an `Id` is a direct parent of auction house.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of an auction house
Return	`boolean`		`true` if this `id` is a parent of `auctionHouseId,` f `alse` otherwise
Errors	NOT_FOUND		`auctionHouseId` is not found
	NULL_ARGUMENT		`id` or `auctionHouseId` 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	getParentAuctionHouseIds
Description	Gets the parent `Ids` of the given auction house.
Parameters	`osid.id.Id`	`auctionHouseId`	an auction house `Id`
Return	`osid.id.IdList`		the parent `Ids` of the auction house
Errors	NOT_FOUND		`auctionHouseId` is not found
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentAuctionHouses
Description	Gets the parents of the given auction house.
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` to query
Return	`osid.bidding.AuctionHouseList`		the parents of the auction house
Errors	NOT_FOUND		`auctionHouseId` not found
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfAuctionHouse
Description	Tests if an `Id` is an ancestor of an auction house.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of an auction house
Return	`boolean`		`tru` e if this `id` is an ancestor of `auctionHouseId,` `false` otherwise
Errors	NOT_FOUND		`auctionHouseId` not found
	NULL_ARGUMENT		`auctionHouseId` 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	hasChildAuctionHouses
Description	Tests if an auction house has any children.
Parameters	`osid.id.Id`	`auctionHouseId`	an auction house `Id`
Return	`boolean`		`true` if the `auctionHouseId` has children, `false` otherwise
Errors	NOT_FOUND		`auctionHouseId` not found
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfAuctionHouse
Description	Tests if an auction house is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of an auction house
Return	`boolean`		`true` if the `id` is a child of `auctionHouseId,` `false` otherwise
Errors	NOT_FOUND		`auctionHouseId` not found
	NULL_ARGUMENT		`id` or `auctionHouseId` 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	getChildAuctionHouseIds
Description	Gets the child `Ids` of the given auction house.
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` to query
Return	`osid.id.IdList`		the children of the auction house
Errors	NOT_FOUND		`auctionHouseId` not found
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildAuctionHouses
Description	Gets the children of the given auction house.
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` to query
Return	`osid.bidding.AuctionHouseList`		the children of the auction house
Errors	NOT_FOUND		`auctionHouseId` not found
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfAuctionHouse
Description	Tests if an `Id` is a descendant of an auction house.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of an auction house
Return	`boolean`		`true` if the `id` is a descendant of the `auctionHouseId,` `false` otherwise
Errors	NOT_FOUND		`auctionHouseId` not found
	NULL_ARGUMENT		`id` or `auctionHouseId` 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	getAuctionHouseNodeIds
Description	Gets a portion of the hierarchy for the given auction house.
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the item.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the item.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given item, `false` to omit the siblings
Return	`osid.hierarchy.Node`		an auction house node
Errors	NOT_FOUND		`auctionHouseId` not found
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionHouseNodes
Description	Gets a portion of the hierarchy for the given auction house.
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the item.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the item.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given item, `false` to omit the siblings
Return	`osid.bidding.AuctionHouseNode`		an auction house node
Errors	NOT_FOUND		`auctionHouseId` not found
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.