Interface AuctionProcessorEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AuctionProcessorEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply AuctionProcessorEnablers to AuctionProcessors . An AuctionProcessor with multiple AuctionProcessorEnablers means any positive rule evaluation across the enablers result in an effective AuctionProcessor .

Method Summary

Modifier and Type	Method	Description
void	assignAuctionProcessorEnablerToAuctionProcessor(Id auctionProcessorEnablerId, Id auctionProcessorId)	Adds an existing AuctionProcessorEnabler to an AuctionProcessor .
boolean	canAssignAuctionProcessorEnablers()	Tests if this user can alter auction processor enabler/auction processor mappings.
boolean	canSequenceAuctionProcessorEnablers()	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	moveAuctionProcessorEnablerAhead(Id auctionProcessorEnablerId, Id auctionProcessorId, Id referenceId)	Reorders auction processor enablers for an auction processor by moving the specified auction processor enabler in front of a reference auction processor enabler.
void	moveAuctionProcessorEnablerBehind(Id auctionProcessorEnablerId, Id auctionProcessorId, Id referenceId)	Reorders auction processor enablers for an auction processor by moving the specified auction processor enabler behind a reference auction processor enabler.
void	orderAuctionProcessorEnablers(Id[] auctionProcessorEnablerIds, Id auctionProcessorId)	Reorders a set of auction processor enablers for an auction processor.
void	unassignAuctionProcessorEnablerFromAuctionProcessor(Id auctionProcessorEnablerId, Id auctionProcessorId)	Removes an AuctionProcessorEnabler from an AuctionProcessor .

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.

canAssignAuctionProcessorEnablers

boolean canAssignAuctionProcessorEnablers()

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

assignAuctionProcessorEnablerToAuctionProcessor

void assignAuctionProcessorEnablerToAuctionProcessor(Id auctionProcessorEnablerId,
 Id auctionProcessorId)
                                              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing AuctionProcessorEnabler to an AuctionProcessor .

Parameters:

auctionProcessorEnablerId - the Id of the AuctionProcessorEnabler

auctionProcessorId - the Id of the AuctionProcessor

Throws:

AlreadyExistsException - auctionProcessorEnablerId already applied to auctionProcessorId

NotFoundException - auctionProcessorEnablerId or auctionProcessorId not found

NullArgumentException - auctionProcessorEnablerId or auctionProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignAuctionProcessorEnablerFromAuctionProcessor

void unassignAuctionProcessorEnablerFromAuctionProcessor(Id auctionProcessorEnablerId,
 Id auctionProcessorId)
                                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an AuctionProcessorEnabler from an AuctionProcessor .

Parameters:

auctionProcessorEnablerId - the Id of the AuctionProcessorEnabler

auctionProcessorId - the Id of the AuctionProcessor

Throws:

NotFoundException - auctionProcessorEnablerId or auctionProcessorId not found or not mapped

NullArgumentException - auctionProcessorEnablerId or auctionProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceAuctionProcessorEnablers

boolean canSequenceAuctionProcessorEnablers()

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 AuctionProcessorEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveAuctionProcessorEnablerAhead

void moveAuctionProcessorEnablerAhead(Id auctionProcessorEnablerId,
 Id auctionProcessorId,
 Id referenceId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

auctionProcessorEnablerId - the Id of an AuctionProcessorEnabler

auctionProcessorId - the Id of an AuctionProcessor

referenceId - the reference auction processor Id

Throws:

NotFoundException - auctionProcessorEnablerId, auctionProcesorId , or referenceId not found or, auctionProcessorEnablerId or referenceId not related to auctionProcessorId

NullArgumentException - auctionProcessorEnablerId, auctionProcessorId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveAuctionProcessorEnablerBehind

void moveAuctionProcessorEnablerBehind(Id auctionProcessorEnablerId,
 Id auctionProcessorId,
 Id referenceId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

auctionProcessorEnablerId - the Id of an AuctionProcessorEnabler

auctionProcessorId - the Id of an AuctionProcessor

referenceId - the reference auction processor Id

Throws:

NotFoundException - auctionProcessorEnablerId, auctionProcesorId , or referenceId not found or, auctionProcessorEnablerId or referenceId not related to auctionProcessorId

NullArgumentException - auctionProcessorEnablerId, auctionProcessorId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderAuctionProcessorEnablers

void orderAuctionProcessorEnablers(Id[] auctionProcessorEnablerIds,
 Id auctionProcessorId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of auction processor enablers for an auction processor.

Parameters:

auctionProcessorEnablerIds - the Ids for a set of AuctionProcessorEnablers

auctionProcessorId - the Id of an AuctionProcessor

Throws:

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

NullArgumentException - auctionProcessorEnablerIds or auctionProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.