org.osid.bidding.rules

Interface AuctionConstrainerAuctionHouseAssignmentSession

All Superinterfaces:

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

public interface AuctionConstrainerAuctionHouseAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignAuctionConstrainerToAuctionHouse(Id auctionConstrainerId, Id auctionHouseId) Adds an existing AuctionConstrainer to an AuctionHouse.
boolean	canAssignAuctionConstrainers() Tests if this user can alter auction constrainer/auction house mappings.
boolean	canAssignAuctionConstrainersToAuctionHouse(Id auctionHouseId) Tests if this user can alter auction constrainer/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 can be assigned.
IdList	getAssignableAuctionHouseIdsForAuctionConstrainer(Id auctionHouseId, Id auctionConstrainerId) Gets a list of auction houses including and under the given auction house node in which a specific auction constrainer can be assigned.
void	unassignAuctionConstrainerFromAuctionHouse(Id auctionConstrainerId, Id auctionHouseId) Removes an AuctionConstrainer 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

canAssignAuctionConstrainers

boolean canAssignAuctionConstrainers()

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

canAssignAuctionConstrainersToAuctionHouse

boolean canAssignAuctionConstrainersToAuctionHouse(Id auctionHouseId)

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

getAssignableAuctionHouseIdsForAuctionConstrainer

IdList getAssignableAuctionHouseIdsForAuctionConstrainer(Id auctionHouseId,
                                                       Id auctionConstrainerId)
                                                         throws OperationFailedException

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

Parameters:

auctionHouseId - the Id of the AuctionHouse

auctionConstrainerId - the Id of the AuctionConstrainer

Returns:

list of assignable auction house Ids

Throws:

NullArgumentException - auctionHouseId or auctionConstrainerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignAuctionConstrainerToAuctionHouse

void assignAuctionConstrainerToAuctionHouse(Id auctionConstrainerId,
                                          Id auctionHouseId)
                                            throws AlreadyExistsException,
                                                   NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Adds an existing AuctionConstrainer to an AuctionHouse.

Parameters:

auctionConstrainerId - the Id of the AuctionConstrainer

auctionHouseId - the Id of the AuctionHouse

Throws:

AlreadyExistsException - auctionConstrainerId already assigned to auctionHouseId

NotFoundException - auctionConstrainerId or auctionHouseId not found

NullArgumentException - auctionConstrainerId or auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignAuctionConstrainerFromAuctionHouse

void unassignAuctionConstrainerFromAuctionHouse(Id auctionConstrainerId,
                                              Id auctionHouseId)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Removes an AuctionConstrainer from an AuctionHouse.

Parameters:

auctionConstrainerId - the Id of the AuctionConstrainer

auctionHouseId - the Id of the AuctionHouse

Throws:

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

NullArgumentException - auctionConstrainerId or auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.