org.osid.bidding.rules

Interface AuctionProcessorAuctionHouseAssignmentSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canAssignAuctionProcessors

boolean canAssignAuctionProcessors()

Tests if this user can alter auction processor/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.

canAssignAuctionProcessorsToAuctionHouse

boolean canAssignAuctionProcessorsToAuctionHouse(Id auctionHouseId)

Tests if this user can alter auction processor/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 processor 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.

getAssignableAuctionHouseIdsForAuctionProcessor

IdList getAssignableAuctionHouseIdsForAuctionProcessor(Id auctionHouseId,
                                                     Id auctionProcessorId)
                                                       throws OperationFailedException

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

Parameters:

auctionHouseId - the Id of the AuctionHouse

auctionProcessorId - the Id of the AuctionProcessor

Returns:

list of assignable auction house Ids

Throws:

NullArgumentException - auctionHouseId or auctionProcessorId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignAuctionProcessorToAuctionHouse

void assignAuctionProcessorToAuctionHouse(Id auctionProcessorId,
                                        Id auctionHouseId)
                                          throws AlreadyExistsException,
                                                 NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Adds an existing AuctionProcessor to an AuctionHouse.

Parameters:

auctionProcessorId - the Id of the AuctionProcessor

auctionHouseId - the Id of the AuctionHouse

Throws:

AlreadyExistsException - auctionProcessorId already assigned to auctionHouseId

NotFoundException - auctionProcessorId or auctionHouseId not found

NullArgumentException - auctionProcessorId or auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignAuctionProcessorFromAuctionHouse

void unassignAuctionProcessorFromAuctionHouse(Id auctionProcessorId,
                                            Id auctionHouseId)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Removes an AuctionProcessor from an AuctionHouse.

Parameters:

auctionProcessorId - the Id of the AuctionProcessor

auctionHouseId - the Id of the AuctionHouse

Throws:

NotFoundException - auctionProcessorId or auctionHouseId not found or auctionProcessorId not assigned to auctionHouseId

NullArgumentException - auctionProcessorId or auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignAuctionProcessorToAuctionHouse

void reassignAuctionProcessorToAuctionHouse(Id auctionProcessorId,
                                          Id fromAuctionHouseId,
                                          Id toAuctionHouseId)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

auctionProcessorId - the Id of the AuctionProcessor

fromAuctionHouseId - the Id of the current AuctionHouse

toAuctionHouseId - the Id of the destination AuctionHouse

Throws:

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

NullArgumentException - auctionProcessorId, fromAuctionHouseId, or toAuctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.