Interface AuctionConstrainerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AuctionConstrainerRuleApplicationSession
extends OsidSession

This session provides methods to apply AuctionConstrainers to Auctions .

Method Summary

Modifier and Type	Method	Description
void	assignAuctionConstrainerToAuction(Id auctionConstrainerId, Id auctionId)	Adds an existing AuctionConstrainer to an Auction .
boolean	canAssignAuctionConstrainers()	Tests if this user can alter auction constrainer/auction mappings.
boolean	canSequenceAuctionConstrainers()	Tests if this user can order AuctionConstrainers .
AuctionHouse	getAuctionHouse()	Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId()	Gets the AuctionHouse Id associated with this session.
void	moveAuctionConstrainerAhead(Id auctionConstrainerId, Id auctionId, Id referenceId)	Reorders auction constrainers for an auction by moving the specified auction constrainer in front of a reference auction constrainer.
void	moveAuctionConstrainerBehind(Id auctionConstrainerId, Id auctionId, Id referenceId)	Reorders auction constrainers for an auction by moving the specified auction constrainer behind a reference auction constrainer.
void	orderAuctionConstrainers(Id[] auctionConstrainerIds, Id auctionId)	Reorders a set of auction constrainers for an auction.
void	unassignAuctionConstrainerFromAuction(Id auctionConstrainerId, Id auctionId)	Removes an AuctionConstrainer 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.

canAssignAuctionConstrainers

boolean canAssignAuctionConstrainers()

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

assignAuctionConstrainerToAuction

void assignAuctionConstrainerToAuction(Id auctionConstrainerId,
 Id auctionId)
                                throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing AuctionConstrainer to an Auction .

Parameters:

auctionConstrainerId - the Id of the AuctionConstrainer

auctionId - the Id of the Auction

Throws:

AlreadyExistsException - auctionConstrainerId already applied to auctionId

NotFoundException - auctionConstrainerId or auctionId not found

NullArgumentException - auctionConstrainerId or auctionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignAuctionConstrainerFromAuction

void unassignAuctionConstrainerFromAuction(Id auctionConstrainerId,
 Id auctionId)
                                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an AuctionConstrainer from an Auction .

Parameters:

auctionConstrainerId - the Id of the AuctionConstrainer

auctionId - the Id of the Auction

Throws:

NotFoundException - auctionConstrainerId or auctionId not found or auctionConstrainerId already applied to auctionId

NullArgumentException - auctionConstrainerId or auctionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceAuctionConstrainers

boolean canSequenceAuctionConstrainers()

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

Compliance:

mandatory - This method must be implemented.

moveAuctionConstrainerAhead

void moveAuctionConstrainerAhead(Id auctionConstrainerId,
 Id auctionId,
 Id referenceId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders auction constrainers for an auction by moving the specified auction constrainer in front of a reference auction constrainer.

Parameters:

auctionConstrainerId - the Id of an AuctionConstrainer

auctionId - the Id of an Auction

referenceId - the reference auction constrainer Id

Throws:

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

NullArgumentException - auctionConstrainerId, auctionId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveAuctionConstrainerBehind

void moveAuctionConstrainerBehind(Id auctionConstrainerId,
 Id auctionId,
 Id referenceId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders auction constrainers for an auction by moving the specified auction constrainer behind a reference auction constrainer.

Parameters:

auctionConstrainerId - the Id of an AuctionConstrainer

auctionId - the Id of an Auction

referenceId - the reference auction constrainer Id

Throws:

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

NullArgumentException - auctionConstrainerId, auctionId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderAuctionConstrainers

void orderAuctionConstrainers(Id[] auctionConstrainerIds,
 Id auctionId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of auction constrainers for an auction.

Parameters:

auctionConstrainerIds - the Ids for a set of AuctionConstrainers

auctionId - the Id of an Auction

Throws:

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

NullArgumentException - auctionConstrainerIds or auctionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.