public interface AuctionProcessorSmartAuctionHouseSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
auction houses. An AuctionProcessorQuery
can be retrieved
from this session and mapped to this AuctionHouse
to create
a virtual collection of auction processors. The auction processor may be
sequenced using the AuctionProcessorSearchOrder
from this
session.
This AuctionHouse
has a default query that matches any
auction processor and a default search order that specifies no sequencing.
The queries may be examined using an
AuctionProcessorQueryInspector.
The query may be modified by
converting the inspector back to an AuctionProcessorQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyAuctionProcessorQuery(AuctionProcessorQuery auctionProcessorQuery)
Applies an auction processor query to this auction house.
|
void |
applyAuctionProcessorSequencing(AuctionProcessorSearchOrder auctionProcessorSearchOrder)
Applies an auction processor 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. |
AuctionProcessorQuery |
getAuctionProcessorQuery()
Gets an auction processor query.
|
AuctionProcessorQuery |
getAuctionProcessorQueryFromInspector(AuctionProcessorQueryInspector auctionProcessorQueryInspector)
Gets an auction processor query from an inspector.
|
AuctionProcessorSearchOrder |
getAuctionProcessorSearchOrder()
Gets an auction processor search order.
|
AuctionProcessorQueryInspector |
inspectAuctionProcessorQuery()
Gets an auction processor query inspector for this auction house.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getAuctionHouseId()
AuctionHouse
Id
associated with
this session. AuctionHouse Id
associated with this
sessionmandatory
- This method must be implemented. AuctionHouse getAuctionHouse() throws OperationFailedException, PermissionDeniedException
AuctionHouse
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartAuctionHouses()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart auction house management is not
authorized, true
otherwisemandatory
- This method must be implemented. AuctionProcessorQuery getAuctionProcessorQuery()
mandatory
- This method must be implemented. AuctionProcessorSearchOrder getAuctionProcessorSearchOrder()
mandatory
- This method must be implemented. void applyAuctionProcessorQuery(AuctionProcessorQuery auctionProcessorQuery) throws OperationFailedException, PermissionDeniedException
auctionProcessorQuery
- the auction processor queryNullArgumentException
- auctionProcessorQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- auctionProcessorQuery
not of this servicemandatory
- This method must be implemented. AuctionProcessorQueryInspector inspectAuctionProcessorQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyAuctionProcessorSequencing(AuctionProcessorSearchOrder auctionProcessorSearchOrder) throws OperationFailedException, PermissionDeniedException
auctionProcessorSearchOrder
- the auction processor search orderNullArgumentException
-
auctionProcessorSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
auctionProcessorSearchOrder
not of this servicemandatory
- This method must be implemented. AuctionProcessorQuery getAuctionProcessorQueryFromInspector(AuctionProcessorQueryInspector auctionProcessorQueryInspector)
auctionProcessorQueryInspector
- an auction processor query
inspectorNullArgumentException
-
auctionProcessorQueryInspector
is null
UnsupportedException
-
auctionProcessorQueryInspector
is not of this servicemandatory
- This method must be implemented.