Interface AuctionHouseHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AuctionHouseHierarchyDesignSession
extends OsidSession

This session defines methods for managing a hierarchy of AuctionHouses . Each node in the hierarchy is a unique AuctionHouse .

Method Summary

Modifier and Type	Method	Description
void	addChildAuctionHouse(Id auctionHouseId, Id childId)	Adds a child to an auction house.
void	addRootAuctionHouse(Id auctionHouseId)	Adds a root auction house.
boolean	canModifyAuctionHouseHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getAuctionHouseHierarchy()	Gets the hierarchy associated with this session.
Id	getAuctionHouseHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildAuctionHouse(Id auctionHouseId, Id childId)	Removes a child from an auction house.
void	removeChildAuctionHouses(Id auctionHouseId)	Removes all children from an auction house.
void	removeRootAuctionHouse(Id auctionHouseId)	Removes a root auction house.

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.

canModifyAuctionHouseHierarchy

boolean canModifyAuctionHouseHierarchy()

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returns:

false if changing this hierarchy is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addRootAuctionHouse

void addRootAuctionHouse(Id auctionHouseId)
                  throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root auction house.

Parameters:

auctionHouseId - the Id of an auction house

Throws:

AlreadyExistsException - auctionHouseId is already in hierarchy

NotFoundException - auctionHouseId not found

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootAuctionHouse

void removeRootAuctionHouse(Id auctionHouseId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root auction house.

Parameters:

auctionHouseId - the Id of an auction house

Throws:

NotFoundException - auctionHouseId is not a root

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildAuctionHouse

void addChildAuctionHouse(Id auctionHouseId,
 Id childId)
                   throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to an auction house.

Parameters:

auctionHouseId - the Id of an auction house

childId - the Id of the new child

Throws:

AlreadyExistsException - auctionHouseId is already a parent of childId

NotFoundException - auctionHouseId or childId not found

NullArgumentException - auctionHouseId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildAuctionHouse

void removeChildAuctionHouse(Id auctionHouseId,
 Id childId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from an auction house.

Parameters:

auctionHouseId - the Id of an auction house

childId - the Id of the new child

Throws:

NotFoundException - auctionHouseId is not parent of childId

NullArgumentException - auctionHouseId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildAuctionHouses

void removeChildAuctionHouses(Id auctionHouseId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from an auction house.

Parameters:

auctionHouseId - the Id of an 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.