org.osid.bidding.rules

Interface AuctionConstrainerEnablerSmartAuctionHouseSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface AuctionConstrainerEnablerSmartAuctionHouseSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic auction houses. An AuctionConstrainerEnablerQuery can be retrieved from this session and mapped to this AuctionHouse to create a virtual collection of auction constrainer enablers. The auction constrainer enablers may be sequenced using the AuctionConstrainerEnablerSearchOrder from this session.

This AuctionHouse has a default query that matches any auction constrainer enabler and a default search order that specifies no sequencing. The queries may be examined using an AuctionConstrainerEnablerQueryInspector. The query may be modified by converting the inspector back to an AuctionConstrainerEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyAuctionConstrainerEnablerQuery(AuctionConstrainerEnablerQuery auctionConstrainerEnablerQuery) Applies an auction constrainer enabler query to this auction house.
void	applyAuctionConstrainerEnablerSequencing(AuctionConstrainerEnablerSearchOrder auctionConstrainerEnablerSearchOrder) Applies an auction constrainer enabler search order to this auction house.
boolean	canManageSmartAuctionHouses() Tests if this user can manage smart auction houses.
AuctionConstrainerEnablerQuery	getAuctionConstrainerEnablerQuery() Gets an auction constrainer enabler query.
AuctionConstrainerEnablerQuery	getAuctionConstrainerEnablerQueryFromInspector(AuctionConstrainerEnablerQueryInspector auctionConstrainerEnablerQueryInspector) Gets an auction constrainer enabler query from an inspector.
AuctionConstrainerEnablerSearchOrder	getAuctionConstrainerEnablerSearchOrder() Gets an auction constrainer enabler search order.
AuctionHouse	getAuctionHouse() Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId() Gets the AuctionHouse Id associated with this session.
AuctionConstrainerEnablerQueryInspector	inspectAuctionConstrainerEnablerQuery() Gets an auction constrainer enabler query inspector for this auction house.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.

canManageSmartAuctionHouses

boolean canManageSmartAuctionHouses()

Tests if this user can manage smart auction houses. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returns:

false if smart auction house management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getAuctionConstrainerEnablerQuery

AuctionConstrainerEnablerQuery getAuctionConstrainerEnablerQuery()

Gets an auction constrainer enabler query.

Returns:

the auction constrainer enabler query

Compliance:

mandatory - This method must be implemented.

getAuctionConstrainerEnablerSearchOrder

AuctionConstrainerEnablerSearchOrder getAuctionConstrainerEnablerSearchOrder()

Gets an auction constrainer enabler search order.

Returns:

the auction constrainer enabler search order

Compliance:

mandatory - This method must be implemented.

applyAuctionConstrainerEnablerQuery

void applyAuctionConstrainerEnablerQuery(AuctionConstrainerEnablerQuery auctionConstrainerEnablerQuery)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Applies an auction constrainer enabler query to this auction house.

Parameters:

auctionConstrainerEnablerQuery - the auction constrainer enabler query

Throws:

NullArgumentException - auctionConstrainerEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - auctionConstrainerEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectAuctionConstrainerEnablerQuery

AuctionConstrainerEnablerQueryInspector inspectAuctionConstrainerEnablerQuery()
                                                                              throws OperationFailedException,
                                                                                     PermissionDeniedException

Gets an auction constrainer enabler query inspector for this auction house.

Returns:

the auction constrainer enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyAuctionConstrainerEnablerSequencing

void applyAuctionConstrainerEnablerSequencing(AuctionConstrainerEnablerSearchOrder auctionConstrainerEnablerSearchOrder)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Applies an auction constrainer enabler search order to this auction house.

Parameters:

auctionConstrainerEnablerSearchOrder - the auction constrainer enabler search order

Throws:

NullArgumentException - auctionConstrainerEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - auctionConstrainerEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getAuctionConstrainerEnablerQueryFromInspector

AuctionConstrainerEnablerQuery getAuctionConstrainerEnablerQueryFromInspector(AuctionConstrainerEnablerQueryInspector auctionConstrainerEnablerQueryInspector)

Gets an auction constrainer enabler query from an inspector.

Parameters:

auctionConstrainerEnablerQueryInspector - an auction constrainer enabler query inspector

Returns:

the auction constrainer enabler query

Throws:

NullArgumentException - auctionConstrainerEnablerQueryInspector is null

UnsupportedException - auctionConstrainerEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.