Interface AuctionProcessorRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AuctionProcessorRuleApplicationSession
extends OsidSession

This session provides methods to apply AuctionProcessors to Auctions .

Method Summary

Modifier and Type	Method	Description
void	assignAuctionProcessorToAuction(Id auctionProcessorId, Id auctionId)	Adds an existing AuctionProcessor to an Auction .
boolean	canAssignAuctionProcessors()	Tests if this user can alter auction processor/auction mappings.
boolean	canSequenceAuctionProcessors()	Tests if this user can order AuctionProcessors .
AuctionHouse	getAuctionHouse()	Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId()	Gets the AuctionHouse Id associated with this session.
void	moveAuctionProcessorAhead(Id auctionProcessorId, Id auctionId, Id referenceId)	Reorders auction processors for an auction by moving the specified auction processor in front of a reference auction processor.
void	moveAuctionProcessorBehind(Id auctionProcessorId, Id auctionId, Id referenceId)	Reorders auction processors for an auction by moving the specified auction processor behind a reference auction processor.
void	orderAuctionProcessors(Id[] auctionProcessorIds, Id auctionId)	Reorders a set of auction processors for an auction.
void	unassignAuctionProcessorFromAuction(Id auctionProcessorId, Id auctionId)	Removes an AuctionProcessor from an Auction .

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.

canAssignAuctionProcessors

boolean canAssignAuctionProcessors()

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

assignAuctionProcessorToAuction

void assignAuctionProcessorToAuction(Id auctionProcessorId,
 Id auctionId)
                              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing AuctionProcessor to an Auction .

Parameters:

auctionProcessorId - the Id of the AuctionProcessor

auctionId - the Id of the Auction

Throws:

AlreadyExistsException - auctionProcessorId already applied to auctionId

NotFoundException - auctionProcessorId or auctionId not found

NullArgumentException - auctionProcessorId or auctionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignAuctionProcessorFromAuction

void unassignAuctionProcessorFromAuction(Id auctionProcessorId,
 Id auctionId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an AuctionProcessor from an Auction .

Parameters:

auctionProcessorId - the Id of the AuctionProcessor

auctionId - the Id of the Auction

Throws:

NotFoundException - auctionProcessorId or auctionId not found or auctionProcessorId not applied to auctionId

NullArgumentException - auctionProcessorId or auctionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceAuctionProcessors

boolean canSequenceAuctionProcessors()

Tests if this user can order AuctionProcessors . 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 AuctionProcessor ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveAuctionProcessorAhead

void moveAuctionProcessorAhead(Id auctionProcessorId,
 Id auctionId,
 Id referenceId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders auction processors for an auction by moving the specified auction processor in front of a reference auction processor.

Parameters:

auctionProcessorId - the Id of an AuctionProcessor

auctionId - the Id of an Auction

referenceId - the reference auction processor Id

Throws:

NotFoundException - auctionProcessorId, auctionId , or referenceId not found or, auctionProcessorId or referenceId not related to auctionId

NullArgumentException - auctionProcessorId, auctionId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveAuctionProcessorBehind

void moveAuctionProcessorBehind(Id auctionProcessorId,
 Id auctionId,
 Id referenceId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders auction processors for an auction by moving the specified auction processor behind a reference auction processor.

Parameters:

auctionProcessorId - the Id of an AuctionProcessor

auctionId - the Id of an Auction

referenceId - the reference auction processor Id

Throws:

NotFoundException - auctionProcessorId, auctionId , or referenceId not found or, auctionProcessorId or referenceId not related to auctionId

NullArgumentException - auctionProcessorId, auctionId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderAuctionProcessors

void orderAuctionProcessors(Id[] auctionProcessorIds,
 Id auctionId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of auction processors for an auction.

Parameters:

auctionProcessorIds - the Ids for a set of AuctionProcessors

auctionId - the Id of an Auction

Throws:

NotFoundException - auctionId not found or, an auctionProcessorId not related to auctionId

NullArgumentException - auctionProcessorIds or auctionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.