public interface AuctionHouseHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of
AuctionHouse
objects. Each node in the hierarchy is a unique
AuctionHouse.
Modifier and Type | Method and 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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getAuctionHouseHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getAuctionHouseHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyAuctionHouseHierarchy()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations to an
unauthorized user. false
if changing this hierarchy is not
authorized, true
otherwisemandatory
- This method must be implemented. void addRootAuctionHouse(Id auctionHouseId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
auctionHouseId
- the Id
of an auction houseAlreadyExistsException
- auctionHouseId
is already in hierarchyNotFoundException
- auctionHouseId
not
foundNullArgumentException
- auctionHouseId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootAuctionHouse(Id auctionHouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
auctionHouseId
- the Id
of an auction houseNotFoundException
- auctionHouseId
is
not a rootNullArgumentException
- auctionHouseId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildAuctionHouse(Id auctionHouseId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
auctionHouseId
- the Id
of an auction housechildId
- the Id
of the new childAlreadyExistsException
- auctionHouseId
is already a parent of childId
NotFoundException
- auctionHouseId
or
childId
not foundNullArgumentException
- auctionHouseId
or childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildAuctionHouse(Id auctionHouseId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
auctionHouseId
- the Id
of an auction housechildId
- the Id
of the new childNotFoundException
- auctionHouseId
is
not parent of childId
NullArgumentException
- auctionHouseId
or childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildAuctionHouses(Id auctionHouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
auctionHouseId
- the Id
of an auction houseNotFoundException
- auctionHouseId
is
not foundNullArgumentException
- auctionHouseId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.