public interface AuctionAuctionHouseAssignmentSession extends OsidSession
This session provides methods to re-assign Auctions
to
AuctionHouse
mappings. An Auction
may appear
in multiple AuctionHouse
objects and removing the last
reference to an Auction
is the equivalent of deleting it.
Each AuctionHouse
may have its own authorizations governing
who is allowed to operate on it.
Adding a reference of an Auction
to another
AuctionHouse
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignAuctionToAuctionHouse(Id auctionId,
Id auctionHouseId)
Adds an existing
Auction to an AuctionHouse. |
boolean |
canAssignAuctions()
Tests if this user can alter auction/auction house mappings.
|
boolean |
canAssignAuctionsToAuctionHouse(Id auctionHouseId)
Tests if this user can alter auction/auction house mappings.
|
IdList |
getAssignableAuctionHouseIds(Id auctionHouseId)
Gets a list of auction houses including and under the given auction
house node in which any auction can be assigned.
|
IdList |
getAssignableAuctionHouseIdsForAuction(Id auctionHouseId,
Id auctionId)
Gets a list of auction houses including and under the given auction
house node in which a specific auction can be assigned.
|
void |
reassignAuctionToAuctionHouse(Id auctionId,
Id fromAuctionHouseId,
Id toAuctionHouseId)
Moves an
Auction from one AuctionHouse
to another. |
void |
unassignAuctionFromAuctionHouse(Id auctionId,
Id auctionHouseId)
Removes an
Auction from an AuctionHouse. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignAuctions()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignAuctionsToAuctionHouse(Id auctionHouseId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users.auctionHouseId
- the Id
of the
AuctionHouse
false
if mapping is not authorized, true
otherwiseNullArgumentException
- auctionHouseId
is null
mandatory
- This method must be implemented. IdList getAssignableAuctionHouseIds(Id auctionHouseId) throws OperationFailedException
auctionHouseId
- the Id
of the
AuctionHouse
Ids
NullArgumentException
- auctionHouseId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableAuctionHouseIdsForAuction(Id auctionHouseId, Id auctionId) throws OperationFailedException
auctionHouseId
- the Id
of the
AuctionHouse
auctionId
- the Id
of the Auction
Ids
NullArgumentException
- auctionHouseId
or auctionId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignAuctionToAuctionHouse(Id auctionId, Id auctionHouseId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Auction
to an AuctionHouse.
auctionId
- the Id
of the Auction
auctionHouseId
- the Id
of the
AuctionHouse
AlreadyExistsException
- auctionId
is
already assigned to auctionHouseId
NotFoundException
- auctionId
or
auctionHouseId
not foundNullArgumentException
- auctionId
or
auctionHouseId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignAuctionFromAuctionHouse(Id auctionId, Id auctionHouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Auction
from an AuctionHouse.
auctionId
- the Id
of the Auction
auctionHouseId
- the Id
of the
AuctionHouse
NotFoundException
- auctionId
or
auctionHouseId
not found or auctionId
not assigned to auctionHouseId
NullArgumentException
- auctionId
or
auctionHouseId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignAuctionToAuctionHouse(Id auctionId, Id fromAuctionHouseId, Id toAuctionHouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Auction
from one AuctionHouse
to another. Mappings to other AuctionHouses
are
unaffected.auctionId
- the Id
of the Auction
fromAuctionHouseId
- the Id
of the current
AuctionHouse
toAuctionHouseId
- the Id
of the destination
AuctionHouse
NotFoundException
- auctionId,
fromAuctionHouseId,
or toAuctionHouseId
not found or auctionId
not mapped to
fromAuctionHouseId
NullArgumentException
- auctionId,
fromAuctionHouseId,
or toAuctionHouseId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.