org.osid.bidding.rules

Interface AuctionProcessorEnablerAuctionHouseAssignmentSession

All Superinterfaces:

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

public interface AuctionProcessorEnablerAuctionHouseAssignmentSession
extends OsidSession

This session provides methods to re-assign AuctionProcessorEnabler to AuctionHouse mappings. An AuctionProcessorEnabler may appear in multiple AuctionHouse objects and removing the last reference to an AuctionProcessorEnabler 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 AuctionProcessorEnabler to another AuctionHouse is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignAuctionProcessorEnablerToAuctionHouse(Id auctionProcessorEnablerId, Id auctionHouseId) Adds an existing AuctionProcessorEnabler to an AuctionHouse.
boolean	canAssignAuctionProcessorEnablers() Tests if this user can alter auction processor enabler/auction house mappings.
boolean	canAssignAuctionProcessorEnablersToAuctionHouse(Id auctionHouseId) Tests if this user can alter auction processor 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 processor enabler can be assigned.
IdList	getAssignableAuctionHouseIdsForAuctionProcessorEnabler(Id auctionHouseId, Id auctionProcessorEnablerId) Gets a list of auction houses including and under the given auction house node in which a specific auction processor enabler can be assigned.
void	unassignAuctionProcessorEnablerFromAuctionHouse(Id auctionProcessorEnablerId, Id auctionHouseId) Removes an AuctionProcessorEnabler 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

canAssignAuctionProcessorEnablers

boolean canAssignAuctionProcessorEnablers()

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

canAssignAuctionProcessorEnablersToAuctionHouse

boolean canAssignAuctionProcessorEnablersToAuctionHouse(Id auctionHouseId)

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

getAssignableAuctionHouseIdsForAuctionProcessorEnabler

IdList getAssignableAuctionHouseIdsForAuctionProcessorEnabler(Id auctionHouseId,
                                                            Id auctionProcessorEnablerId)
                                                              throws OperationFailedException

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

Parameters:

auctionHouseId - the Id of the AuctionHouse

auctionProcessorEnablerId - the Id of the AuctionProcessorEnabler

Returns:

list of assignable auction house Ids

Throws:

NullArgumentException - auctionHouseId or auctionProcessorEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignAuctionProcessorEnablerToAuctionHouse

void assignAuctionProcessorEnablerToAuctionHouse(Id auctionProcessorEnablerId,
                                               Id auctionHouseId)
                                                 throws AlreadyExistsException,
                                                        NotFoundException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

Adds an existing AuctionProcessorEnabler to an AuctionHouse.

Parameters:

auctionProcessorEnablerId - the Id of the AuctionProcessorEnabler

auctionHouseId - the Id of the AuctionHouse

Throws:

AlreadyExistsException - auctionProcessorEnablerId already assigned to auctionHouseId

NotFoundException - auctionProcessorEnablerId or auctionHouseId not found

NullArgumentException - auctionProcessorEnablerId or auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignAuctionProcessorEnablerFromAuctionHouse

void unassignAuctionProcessorEnablerFromAuctionHouse(Id auctionProcessorEnablerId,
                                                   Id auctionHouseId)
                                                     throws NotFoundException,
                                                            OperationFailedException,
                                                            PermissionDeniedException

Removes an AuctionProcessorEnabler from an AuctionHouse.

Parameters:

auctionProcessorEnablerId - the Id of the AuctionProcessorEnabler

auctionHouseId - the Id of the AuctionHouse

Throws:

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

NullArgumentException - auctionProcessorEnablerId or auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.