org.osid.bidding.rules

Interface AuctionProcessorEnablerSmartAuctionHouseSession

All Superinterfaces:

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

public interface AuctionProcessorEnablerSmartAuctionHouseSession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyAuctionProcessorEnablerQuery(AuctionProcessorEnablerQuery auctionProcessorEnablerQuery) Applies an auction processor enabler query to this auction house.
void	applyAuctionProcessorEnablerSequencing(AuctionProcessorEnablerSearchOrder auctionProcessorEnablerSearchOrder) Applies an auction processor enabler search order to this auction house.
boolean	canManageSmartAuctionHouses() Tests if this user can manage smart auction houses.
AuctionHouse	getAuctionHouse() Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId() Gets the AuctionHouse Id associated with this session.
AuctionProcessorEnablerQuery	getAuctionProcessorEnablerQuery() Gets an auction processor enabler query.
AuctionProcessorEnablerQuery	getAuctionProcessorEnablerQueryFromInspector(AuctionProcessorEnablerQueryInspector auctionProcessorEnablerQueryInspector) Gets an auction processor enabler query from an inspector.
AuctionProcessorEnablerSearchOrder	getAuctionProcessorEnablerSearchOrder() Gets an auction processor enabler search order.
AuctionProcessorEnablerQueryInspector	inspectAuctionProcessorEnablerQuery() Gets an auction processor 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.

getAuctionProcessorEnablerQuery

AuctionProcessorEnablerQuery getAuctionProcessorEnablerQuery()

Gets an auction processor enabler query.

Returns:

the auction processor enabler query

Compliance:

mandatory - This method must be implemented.

getAuctionProcessorEnablerSearchOrder

AuctionProcessorEnablerSearchOrder getAuctionProcessorEnablerSearchOrder()

Gets an auction processor enabler search order.

Returns:

the auction processor enabler search order

Compliance:

mandatory - This method must be implemented.

applyAuctionProcessorEnablerQuery

void applyAuctionProcessorEnablerQuery(AuctionProcessorEnablerQuery auctionProcessorEnablerQuery)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Applies an auction processor enabler query to this auction house.

Parameters:

auctionProcessorEnablerQuery - the auction processor enabler query

Throws:

NullArgumentException - auctionProcessorEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - auctionProcessorEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectAuctionProcessorEnablerQuery

AuctionProcessorEnablerQueryInspector inspectAuctionProcessorEnablerQuery()
                                                                          throws OperationFailedException,
                                                                                 PermissionDeniedException

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

Returns:

the auction processor enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyAuctionProcessorEnablerSequencing

void applyAuctionProcessorEnablerSequencing(AuctionProcessorEnablerSearchOrder auctionProcessorEnablerSearchOrder)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

auctionProcessorEnablerSearchOrder - the auction processor enabler search order

Throws:

NullArgumentException - auctionProcessorEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - auctionProcessorEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getAuctionProcessorEnablerQueryFromInspector

AuctionProcessorEnablerQuery getAuctionProcessorEnablerQueryFromInspector(AuctionProcessorEnablerQueryInspector auctionProcessorEnablerQueryInspector)

Gets an auction processor enabler query from an inspector.

Parameters:

auctionProcessorEnablerQueryInspector - an auction processor enabler query inspector

Returns:

the auction processor enabler query

Throws:

NullArgumentException - auctionProcessorEnablerQueryInspector is null

UnsupportedException - auctionProcessorEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.