public interface AuctionConstrainerEnablerAuctionHouseAssignmentSession extends OsidSession
This session provides methods to re-assign
AuctionConstrainerEnabler
to AuctionHouse
mappings.
An AuctionConstrainerEnabler
may appear in multiple
AuctionHouse
objects and removing the last reference to an
AuctionConstrainerEnabler
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 AuctionConstrainerEnabler
to
another AuctionHouse
is not a copy operation (eg: does not
change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignAuctionConstrainerEnablerToAuctionHouse(Id auctionConstrainerEnablerId,
Id auctionHouseId)
Adds an existing
AuctionConstrainerEnabler to an
AuctionHouse. |
boolean |
canAssignAuctionConstrainerEnablers()
Tests if this user can alter auction constrainer enabler/auction house
mappings.
|
boolean |
canAssignAuctionConstrainerEnablersToAuctionHouse(Id auctionHouseId)
Tests if this user can alter auction constrainer enabler/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 constrainer enabler can be assigned.
|
IdList |
getAssignableAuctionHouseIdsForAuctionConstrainerEnabler(Id auctionHouseId,
Id auctionConstrainerEnablerId)
Gets a list of auction houses including and under the given auction
house node in which a specific auction constrainer enabler can be
assigned.
|
void |
reassignAuctionConstrainerEnablerToAuctionHouse(Id auctionConstrainerEnablerId,
Id fromAuctionHouseId,
Id toAuctionHouseId)
Moves an
AuctionConstrainerEnabler from one
AuctionHouse to another. |
void |
unassignAuctionConstrainerEnablerFromAuctionHouse(Id auctionConstrainerEnablerId,
Id auctionHouseId)
Removes an
AuctionConstrainerEnabler from an
AuctionHouse. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignAuctionConstrainerEnablers()
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 canAssignAuctionConstrainerEnablersToAuctionHouse(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 getAssignableAuctionHouseIdsForAuctionConstrainerEnabler(Id auctionHouseId, Id auctionConstrainerEnablerId) throws OperationFailedException
auctionHouseId
- the Id
of the
AuctionHouse
auctionConstrainerEnablerId
- the Id
of the
AuctionConstrainerEnabler
Ids
NullArgumentException
- auctionHouseId
or auctionConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignAuctionConstrainerEnablerToAuctionHouse(Id auctionConstrainerEnablerId, Id auctionHouseId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
AuctionConstrainerEnabler
to an
AuctionHouse.
auctionConstrainerEnablerId
- the Id
of the
AuctionConstrainerEnabler
auctionHouseId
- the Id
of the
AuctionHouse
AlreadyExistsException
-
auctionConstrainerEnablerId
already assigned to
auctionHouseId
NotFoundException
- auctionConstrainerEnablerId
or auctionHouseId
not foundNullArgumentException
-
auctionConstrainerEnablerId
or auctionHouseId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignAuctionConstrainerEnablerFromAuctionHouse(Id auctionConstrainerEnablerId, Id auctionHouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionConstrainerEnabler
from an
AuctionHouse.
auctionConstrainerEnablerId
- the Id
of the
AuctionConstrainerEnabler
auctionHouseId
- the Id
of the
AuctionHouse
NotFoundException
- auctionConstrainerEnablerId
or auctionHouseId
not found or
auctionConstrainerEnablerId
already assigned to
auctionHouseId
NullArgumentException
-
auctionConstrainerEnablerId
or auctionHouseId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignAuctionConstrainerEnablerToAuctionHouse(Id auctionConstrainerEnablerId, Id fromAuctionHouseId, Id toAuctionHouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionConstrainerEnabler
from one
AuctionHouse
to another. Mappings to other
AuctionHouses
are unaffected.auctionConstrainerEnablerId
- the Id
of the
AuctionConstrainerEnabler
fromAuctionHouseId
- the Id
of the current
AuctionHouse
toAuctionHouseId
- the Id
of the destination
AuctionHouse
NotFoundException
- auctionConstrainerEnablerId,
fromAuctionHouseId,
or toAuctionHouseId
not found or auctionConstrainerEnablerId
not
mapped to fromAuctionHouseId
NullArgumentException
-
auctionConstrainerEnablerId, fromAuctionHouseId,
or
toAuctionHouseId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.