Interface AuctionHouseHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AuctionHouseHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of AuctionHouses . 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 Summary

Modifier and Type	Method	Description
boolean	canAccessAuctionHouseHierarchy()	Tests if this user can perform hierarchy queries.
Hierarchy	getAuctionHouseHierarchy()	Gets the hierarchy associated with this session.
Id	getAuctionHouseHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getAuctionHouseNodeIds(Id auctionHouseId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given auction house.
AuctionHouseNode	getAuctionHouseNodes(Id auctionHouseId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given auction house.
IdList	getChildAuctionHouseIds(Id auctionHouseId)	Gets the child Ids of the given auction house.
AuctionHouseList	getChildAuctionHouses(Id auctionHouseId)	Gets the children of the given auction house.
IdList	getParentAuctionHouseIds(Id auctionHouseId)	Gets the parent Ids of the given auction house.
AuctionHouseList	getParentAuctionHouses(Id auctionHouseId)	Gets the parents of the given auction house.
IdList	getRootAuctionHouseIds()	Gets the root auction house Ids in this hierarchy.
AuctionHouseList	getRootAuctionHouses()	Gets the root auction house in the auction house hierarchy.
boolean	hasChildAuctionHouses(Id auctionHouseId)	Tests if an auction house has any children.
boolean	hasParentAuctionHouses(Id auctionHouseId)	Tests if the AuctionHouse has any parents.
boolean	isAncestorOfAuctionHouse(Id id, Id auctionHouseId)	Tests if an Id is an ancestor of an auction house.
boolean	isChildOfAuctionHouse(Id id, Id auctionHouseId)	Tests if an auction house is a direct child of another.
boolean	isDescendantOfAuctionHouse(Id id, Id auctionHouseId)	Tests if an Id is a descendant of an auction house.
boolean	isParentOfAuctionHouse(Id id, Id auctionHouseId)	Tests if an Id is a direct parent of auction house.
void	useComparativeAuctionHouseView()	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.
void	usePlenaryAuctionHouseView()	A complete view of the AuctionHouses 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

getAuctionHouseHierarchyId

Id getAuctionHouseHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAuctionHouseHierarchy

Hierarchy getAuctionHouseHierarchy()
                            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.

canAccessAuctionHouseHierarchy

boolean canAccessAuctionHouseHierarchy()

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.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeAuctionHouseView

void useComparativeAuctionHouseView()

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.

usePlenaryAuctionHouseView

void usePlenaryAuctionHouseView()

A complete view of the AuctionHouses 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.

getRootAuctionHouseIds

IdList getRootAuctionHouseIds()
                       throws OperationFailedException,
PermissionDeniedException

Gets the root auction house Ids in this hierarchy.

Returns:

the root auction house Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootAuctionHouses

AuctionHouseList getRootAuctionHouses()
                               throws OperationFailedException,
PermissionDeniedException

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.

Returns:

the root auction houses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentAuctionHouses

boolean hasParentAuctionHouses(Id auctionHouseId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the AuctionHouse has any parents.

Parameters:

auctionHouseId - an auction house Id

Returns:

true if the auction house has parents, f alse otherwise

Throws:

NotFoundException - auctionHouseId is not found

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfAuctionHouse

boolean isParentOfAuctionHouse(Id id,
 Id auctionHouseId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of auction house.

Parameters:

id - an Id

auctionHouseId - the Id of an auction house

Returns:

true if this id is a parent of auctionHouseId , f alse otherwise

Throws:

NotFoundException - auctionHouseId is not found

NullArgumentException - id or auctionHouseId 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} .

getParentAuctionHouseIds

IdList getParentAuctionHouseIds(Id auctionHouseId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given auction house.

Parameters:

auctionHouseId - an auction house Id

Returns:

the parent Ids of the auction house

Throws:

NotFoundException - auctionHouseId is not found

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentAuctionHouses

AuctionHouseList getParentAuctionHouses(Id auctionHouseId)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given auction house.

Parameters:

auctionHouseId - the Id to query

Returns:

the parents of the auction house

Throws:

NotFoundException - auctionHouseId not found

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfAuctionHouse

boolean isAncestorOfAuctionHouse(Id id,
 Id auctionHouseId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of an auction house.

Parameters:

id - an Id

auctionHouseId - the Id of an auction house

Returns:

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

Throws:

NotFoundException - auctionHouseId not found

NullArgumentException - auctionHouseId or id 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} .

hasChildAuctionHouses

boolean hasChildAuctionHouses(Id auctionHouseId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an auction house has any children.

Parameters:

auctionHouseId - an auction house Id

Returns:

true if the auctionHouseId has children, false otherwise

Throws:

NotFoundException - auctionHouseId not found

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfAuctionHouse

boolean isChildOfAuctionHouse(Id id,
 Id auctionHouseId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an auction house is a direct child of another.

Parameters:

id - an Id

auctionHouseId - the Id of an auction house

Returns:

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

Throws:

NotFoundException - auctionHouseId not found

NullArgumentException - id or auctionHouseId 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} .

getChildAuctionHouseIds

IdList getChildAuctionHouseIds(Id auctionHouseId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given auction house.

Parameters:

auctionHouseId - the Id to query

Returns:

the children of the auction house

Throws:

NotFoundException - auctionHouseId not found

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildAuctionHouses

AuctionHouseList getChildAuctionHouses(Id auctionHouseId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given auction house.

Parameters:

auctionHouseId - the Id to query

Returns:

the children of the auction house

Throws:

NotFoundException - auctionHouseId not found

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfAuctionHouse

boolean isDescendantOfAuctionHouse(Id id,
 Id auctionHouseId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of an auction house.

Parameters:

id - an Id

auctionHouseId - the Id of an auction house

Returns:

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

Throws:

NotFoundException - auctionHouseId not found

NullArgumentException - id or auctionHouseId 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} .

getAuctionHouseNodeIds

Node getAuctionHouseNodeIds(Id auctionHouseId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given auction house.

Parameters:

auctionHouseId - the Id to query

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

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

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

Returns:

an auction house node

Throws:

NotFoundException - auctionHouseId not found

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuctionHouseNodes

AuctionHouseNode getAuctionHouseNodes(Id auctionHouseId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given auction house.

Parameters:

auctionHouseId - the Id to query

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

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

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

Returns:

an auction house node

Throws:

NotFoundException - auctionHouseId not found

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.