public interface AuctionProcessorAuctionHouseAssignmentSession extends OsidSession
This session provides methods to re-assign AuctionProcessor
to AuctionHouse
mappings. An
AuctionProcessor
may appear in multiple AuctionHouse
objects and removing the last reference to an
AuctionProcessor
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 AuctionProcessor
to another
AuctionHouse
is not a copy operation (eg: does not change
its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignAuctionProcessorToAuctionHouse(Id auctionProcessorId,
Id auctionHouseId)
Adds an existing
AuctionProcessor to an
AuctionHouse. |
boolean |
canAssignAuctionProcessors()
Tests if this user can alter auction processor/auction house mappings.
|
boolean |
canAssignAuctionProcessorsToAuctionHouse(Id auctionHouseId)
Tests if this user can alter auction processor/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 processor can be assigned.
|
IdList |
getAssignableAuctionHouseIdsForAuctionProcessor(Id auctionHouseId,
Id auctionProcessorId)
Gets a list of auction houses including and under the given auction
house node in which a specific auction processor can be assigned.
|
void |
reassignAuctionProcessorToAuctionHouse(Id auctionProcessorId,
Id fromAuctionHouseId,
Id toAuctionHouseId)
Moves an
AuctionProcessor from one AuctionHouse
to another. |
void |
unassignAuctionProcessorFromAuctionHouse(Id auctionProcessorId,
Id auctionHouseId)
Removes an
AuctionProcessor from an
AuctionHouse. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignAuctionProcessors()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignAuctionProcessorsToAuctionHouse(Id auctionHouseId)
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup 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 getAssignableAuctionHouseIdsForAuctionProcessor(Id auctionHouseId, Id auctionProcessorId) throws OperationFailedException
auctionHouseId
- the Id
of the
AuctionHouse
auctionProcessorId
- the Id
of the
AuctionProcessor
Ids
NullArgumentException
- auctionHouseId
or auctionProcessorId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignAuctionProcessorToAuctionHouse(Id auctionProcessorId, Id auctionHouseId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
AuctionProcessor
to an
AuctionHouse.
auctionProcessorId
- the Id
of the
AuctionProcessor
auctionHouseId
- the Id
of the
AuctionHouse
AlreadyExistsException
- auctionProcessorId
already assigned to auctionHouseId
NotFoundException
- auctionProcessorId
or auctionHouseId
not foundNullArgumentException
- auctionProcessorId
or auctionHouseId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignAuctionProcessorFromAuctionHouse(Id auctionProcessorId, Id auctionHouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionProcessor
from an
AuctionHouse.
auctionProcessorId
- the Id
of the
AuctionProcessor
auctionHouseId
- the Id
of the
AuctionHouse
NotFoundException
- auctionProcessorId
or auctionHouseId
not found or
auctionProcessorId
not assigned to
auctionHouseId
NullArgumentException
- auctionProcessorId
or auctionHouseId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignAuctionProcessorToAuctionHouse(Id auctionProcessorId, Id fromAuctionHouseId, Id toAuctionHouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionProcessor
from one AuctionHouse
to another. Mappings to other AuctionHouses
are
unaffected.auctionProcessorId
- the Id
of the
AuctionProcessor
fromAuctionHouseId
- the Id
of the current
AuctionHouse
toAuctionHouseId
- the Id
of the destination
AuctionHouse
NotFoundException
- auctionProcessorId,
fromAuctionHouseId,
or toAuctionHouseId
not found or auctionProcessorId
not mapped to
fromAuctionHouseId
NullArgumentException
- auctionProcessorId,
fromAuctionHouseId,
or toAuctionHouseId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.