Interface AuctionConstrainerEnablerAuctionHouseAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

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 ).

Method Summary

Modifier and Type	Method	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 .

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

canAssignAuctionConstrainerEnablers

boolean canAssignAuctionConstrainerEnablers()

Tests if this user can alter auction constrainer enabler/auction house mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignAuctionConstrainerEnablersToAuctionHouse

boolean canAssignAuctionConstrainerEnablersToAuctionHouse(Id auctionHouseId)

Tests if this user can alter auction constrainer enabler/auction house mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Parameters:

auctionHouseId - the Id of the AuctionHouse

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - auctionHouseId is null

Compliance:

mandatory - This method must be implemented.

getAssignableAuctionHouseIds

IdList getAssignableAuctionHouseIds(Id auctionHouseId)
                             throws OperationFailedException

Gets a list of auction houses including and under the given auction house node in which any auction constrainer enabler can be assigned.

Parameters:

auctionHouseId - the Id of the AuctionHouse

Returns:

list of assignable auction house Ids

Throws:

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableAuctionHouseIdsForAuctionConstrainerEnabler

IdList getAssignableAuctionHouseIdsForAuctionConstrainerEnabler(Id auctionHouseId,
 Id auctionConstrainerEnablerId)
                                                         throws OperationFailedException

Gets a list of auction houses including and under the given auction house node in which a specific auction constrainer enabler can be assigned.

Parameters:

auctionHouseId - the Id of the AuctionHouse

auctionConstrainerEnablerId - the Id of the AuctionConstrainerEnabler

Returns:

list of assignable auction house Ids

Throws:

NullArgumentException - auctionHouseId or auctionConstrainerEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignAuctionConstrainerEnablerToAuctionHouse

void assignAuctionConstrainerEnablerToAuctionHouse(Id auctionConstrainerEnablerId,
 Id auctionHouseId)
                                            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing AuctionConstrainerEnabler to an AuctionHouse .

Parameters:

auctionConstrainerEnablerId - the Id of the AuctionConstrainerEnabler

auctionHouseId - the Id of the AuctionHouse

Throws:

AlreadyExistsException - auctionConstrainerEnablerId already assigned to auctionHouseId

NotFoundException - auctionConstrainerEnablerId or auctionHouseId not found

NullArgumentException - auctionConstrainerEnablerId or auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignAuctionConstrainerEnablerFromAuctionHouse

void unassignAuctionConstrainerEnablerFromAuctionHouse(Id auctionConstrainerEnablerId,
 Id auctionHouseId)
                                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an AuctionConstrainerEnabler from an AuctionHouse .

Parameters:

auctionConstrainerEnablerId - the Id of the AuctionConstrainerEnabler

auctionHouseId - the Id of the AuctionHouse

Throws:

NotFoundException - auctionConstrainerEnablerId or auctionHouseId not found or auctionConstrainerEnablerId already assigned to auctionHouseId

NullArgumentException - auctionConstrainerEnablerId or auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignAuctionConstrainerEnablerToAuctionHouse

void reassignAuctionConstrainerEnablerToAuctionHouse(Id auctionConstrainerEnablerId,
 Id fromAuctionHouseId,
 Id toAuctionHouseId)
                                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Moves an AuctionConstrainerEnabler from one AuctionHouse to another. Mappings to other AuctionHouses are unaffected.

Parameters:

auctionConstrainerEnablerId - the Id of the AuctionConstrainerEnabler

fromAuctionHouseId - the Id of the current AuctionHouse

toAuctionHouseId - the Id of the destination AuctionHouse

Throws:

NotFoundException - auctionConstrainerEnablerId, fromAuctionHouseId , or toAuctionHouseId not found or auctionConstrainerEnablerId not mapped to fromAuctionHouseId

NullArgumentException - auctionConstrainerEnablerId, fromAuctionHouseId , or toAuctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.