Interface AuctionConstrainerEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AuctionConstrainerEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply AuctionConstrainerEnablers to AuctionConstrainers. An AuctionConstrainer with multiple AuctionConstrainerEnablers means any positive rule evaluation across the enablers result in an effective AuctionConstrainer.

Method Summary

Modifier and Type	Method	Description
void	assignAuctionConstrainerEnablerToAuctionConstrainer(Id auctionConstrainerEnablerId, Id auctionConstrainerId)	Adds an existing AuctionConstrainerEnabler to an AuctionConstrainer.
boolean	canAssignAuctionConstrainerEnablers()	Tests if this user can alter auction constrainer enabler/auction constrainer mappings.
boolean	canSequenceAuctionConstrainerEnablers()	Tests if this user can order AuctionConstrainerEnablers.
AuctionHouse	getAuctionHouse()	Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId()	Gets the AuctionHouse Id associated with this session.
void	moveAuctionConstrainerEnablerAhead(Id auctionConstrainerEnablerId, Id auctionConstrainerId, Id referenceId)	Reorders auction constrainer enablers for an auction constrainer by moving the specified auction constrainer enabler in front of a reference auction constrainer enabler.
void	moveAuctionConstrainerEnablerBehind(Id auctionConstrainerEnablerId, Id auctionConstrainerId, Id referenceId)	Reorders auction constrainer enablers for an auction by moving the specified auction constrainer enabler behind a reference auction constrainer enabler.
void	orderAuctionConstrainerEnablers(Id[] auctionConstrainerEnablerIds, Id auctionConstrainerId)	Reorders a set of auction constrainer enablers for an auction constrainer.
void	unassignAuctionConstrainerEnablerFromAuctionConstrainer(Id auctionConstrainerEnablerId, Id auctionConstrainerId)	Removes an AuctionConstrainerEnabler from an AuctionConstrainer.

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.

canAssignAuctionConstrainerEnablers

boolean canAssignAuctionConstrainerEnablers()

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

assignAuctionConstrainerEnablerToAuctionConstrainer

void assignAuctionConstrainerEnablerToAuctionConstrainer(Id auctionConstrainerEnablerId,
 Id auctionConstrainerId)
                                                  throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing AuctionConstrainerEnabler to an AuctionConstrainer.

Parameters:

auctionConstrainerEnablerId - the Id of the AuctionConstrainerEnabler

auctionConstrainerId - the Id of the AuctionConstrainer

Throws:

AlreadyExistsException - auctionConstrainerEnablerId already applied to auctionConstrainerId

NotFoundException - auctionConstrainerEnablerId or auctionConstrainerId not found

NullArgumentException - auctionConstrainerEnablerId or auctionConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignAuctionConstrainerEnablerFromAuctionConstrainer

void unassignAuctionConstrainerEnablerFromAuctionConstrainer(Id auctionConstrainerEnablerId,
 Id auctionConstrainerId)
                                                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an AuctionConstrainerEnabler from an AuctionConstrainer.

Parameters:

auctionConstrainerEnablerId - the Id of the AuctionConstrainerEnabler

auctionConstrainerId - the Id of the AuctionConstrainer

Throws:

NotFoundException - auctionConstrainerEnablerId or auctionConstrainerId not found or auctionConstrainerEnablerId not applied to auctionConstrainerId

NullArgumentException - auctionConstrainerEnablerId or auctionConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceAuctionConstrainerEnablers

boolean canSequenceAuctionConstrainerEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveAuctionConstrainerEnablerAhead

void moveAuctionConstrainerEnablerAhead(Id auctionConstrainerEnablerId,
 Id auctionConstrainerId,
 Id referenceId)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

auctionConstrainerEnablerId - the Id of an AuctionConstrainerEnabler

auctionConstrainerId - the Id of an AuctionConstrainer

referenceId - the reference auction constrainer enabler Id

Throws:

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

NullArgumentException - auctionConstrainerEnablerId, auctionConstrainerId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveAuctionConstrainerEnablerBehind

void moveAuctionConstrainerEnablerBehind(Id auctionConstrainerEnablerId,
 Id auctionConstrainerId,
 Id referenceId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

auctionConstrainerEnablerId - the Id of an AuctionConstrainerEnabler

auctionConstrainerId - the Id of an AuctionConstrainer

referenceId - the reference auction constrainer enabler Id

Throws:

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

NullArgumentException - auctionConstrainerEnablerId, auctionConstrainerId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderAuctionConstrainerEnablers

void orderAuctionConstrainerEnablers(Id[] auctionConstrainerEnablerIds,
 Id auctionConstrainerId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

auctionConstrainerEnablerIds - the Ids for a set of AuctionConstrainerEnablers

auctionConstrainerId - the Id of an AuctionConstrainer

Throws:

NotFoundException - auctionConstraienrId not found or, an auctionConstrainerEnablerId not related to auctionConstrainerId

NullArgumentException - auctionConstrainerEnablerIds or auctionConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.