Interface BidEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BidEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply BidEnablers to Bids. Multiple BidEnablers applied to an Bid may be sequenced such that the first positive evaluation results in the BidEnablers used.

Method Summary

Modifier and Type	Method	Description
void	assignBidEnablerToBid(Id bidEnablerId, Id bidId)	Adds an existing BidEnabler to a Bid.
boolean	canAssignBidEnablers()	Tests if this user can alter bid enabler/bid mappings.
boolean	canSequenceBidEnablers()	Tests if this user can order BidEnablers.
AuctionHouse	getAuctionHouse()	Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId()	Gets the AuctionHouse Id associated with this session.
void	moveBidEnablerAhead(Id bidEnablerId, Id bidId, Id referenceId)	Reorders bid enablers for a bid by moving the specified bid enabler in front of a reference bid enabler.
void	moveBidEnablerBehind(Id bidEnablerId, Id bidId, Id referenceId)	Reorders bid enablers for a bid by moving the specified bid enabler behind a reference bid enabler.
void	orderBidEnablers(Id[] bidEnablerIds, Id bidId)	Reorders a set of bid enablers for a bid.
void	unassignBidEnablerFromBid(Id bidEnablerId, Id bidId)	Removes an existing BidEnabler from a Bid.

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

getAuctionHouseId

Id getAuctionHouseId()

Gets the AuctionHouse Id associated with this session.

Returns:

the AuctionHouse Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAuctionHouse

AuctionHouse getAuctionHouse()
                      throws OperationFailedException,
PermissionDeniedException

Gets the AuctionHouse associated with this session.

Returns:

the auction house

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignBidEnablers

boolean canAssignBidEnablers()

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

assignBidEnablerToBid

void assignBidEnablerToBid(Id bidEnablerId,
 Id bidId)
                    throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing BidEnabler to a Bid.

Parameters:

bidEnablerId - the Id of the BidEnabler

bidId - the Id of the Bid

Throws:

AlreadyExistsException - bidEnablerId already applied to bidId

NotFoundException - bidEnablerId or bidId not found

NullArgumentException - bidEnablerId or bidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignBidEnablerFromBid

void unassignBidEnablerFromBid(Id bidEnablerId,
 Id bidId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing BidEnabler from a Bid.

Parameters:

bidEnablerId - the Id of the BidEnabler

bidId - the Id of the Bid

Throws:

NotFoundException - bidEnablerId or bidId not found or bidEnablerId already applied to bidId

NullArgumentException - bidEnablerId or bidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceBidEnablers

boolean canSequenceBidEnablers()

Tests if this user can order BidEnablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returns:

false if BidEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveBidEnablerAhead

void moveBidEnablerAhead(Id bidEnablerId,
 Id bidId,
 Id referenceId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders bid enablers for a bid by moving the specified bid enabler in front of a reference bid enabler.

Parameters:

bidEnablerId - the Id of the BidEnabler

bidId - the Id of the Bid

referenceId - the reference bid enabler Id

Throws:

NotFoundException - bidEnablerId, bidId, or referenceId not found or, bidEnablerId or referenceId not related to bidId

NullArgumentException - bidEnablerId, bidId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveBidEnablerBehind

void moveBidEnablerBehind(Id bidEnablerId,
 Id bidId,
 Id referenceId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders bid enablers for a bid by moving the specified bid enabler behind a reference bid enabler.

Parameters:

bidEnablerId - the Id of the BidEnabler

bidId - the Id of the Bid

referenceId - the reference bid enabler Id

Throws:

NotFoundException - bidEnablerId, bidId, or referenceId not found or, bidEnablerId or referenceId not related to bidId

NullArgumentException - bidEnablerId, bidId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderBidEnablers

void orderBidEnablers(Id[] bidEnablerIds,
 Id bidId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of bid enablers for a bid.

Parameters:

bidEnablerIds - the Ids for a set of BidEnablers

bidId - the Id of the Bid

Throws:

NotFoundException - bidEnablerId, bidId, or referenceId not found or, bidEnablerId or referenceId not related to bidId

NullArgumentException - bidEnablerIds, bidId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.