public interface AuctionConstrainerSmartAuctionHouseSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
auction houses. An AuctionConstrainerQuery
can be retrieved
from this session and mapped to this AuctionHouse
to create
a virtual collection of auction constrainers. The auction constrainer may
be sequenced using the AuctionConstrainerSearchOrder
from
this session.
This AuctionHouse
has a default query that matches any
auction constrainer and a default search order that specifies no
sequencing. The queries may be examined using an
AuctionConstrainerQueryInspector.
The query may be modified by
converting the inspector back to an AuctionConstrainerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyAuctionConstrainerQuery(AuctionConstrainerQuery auctionConstrainerQuery)
Applies an auction constrainer query to this auction house.
|
void |
applyAuctionConstrainerSequencing(AuctionConstrainerSearchOrder auctionConstrainerSearchOrder)
Applies an auction constrainer search order to this auction house.
|
boolean |
canManageSmartAuctionHouses()
Tests if this user can manage smart auction houses.
|
AuctionConstrainerQuery |
getAuctionConstrainerQuery()
Gets an auction constrainer query.
|
AuctionConstrainerQuery |
getAuctionConstrainerQueryFromInspector(AuctionConstrainerQueryInspector auctionConstrainerQueryInspector)
Gets an auction constrainer query from an inspector.
|
AuctionConstrainerSearchOrder |
getAuctionConstrainerSearchOrder()
Gets an auction constrainer search order.
|
AuctionHouse |
getAuctionHouse()
Gets the
AuctionHouse associated with this session. |
Id |
getAuctionHouseId()
Gets the
AuctionHouse Id associated with
this session. |
AuctionConstrainerQueryInspector |
inspectAuctionConstrainerQuery()
Gets an auction constrainer 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. AuctionConstrainerQuery getAuctionConstrainerQuery()
mandatory
- This method must be implemented. AuctionConstrainerSearchOrder getAuctionConstrainerSearchOrder()
mandatory
- This method must be implemented. void applyAuctionConstrainerQuery(AuctionConstrainerQuery auctionConstrainerQuery) throws OperationFailedException, PermissionDeniedException
auctionConstrainerQuery
- the auction constrainer queryNullArgumentException
- auctionConstrainerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- auctionConstrainerQuery
not of this servicemandatory
- This method must be implemented. AuctionConstrainerQueryInspector inspectAuctionConstrainerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyAuctionConstrainerSequencing(AuctionConstrainerSearchOrder auctionConstrainerSearchOrder) throws OperationFailedException, PermissionDeniedException
auctionConstrainerSearchOrder
- the auction constrainer search
orderNullArgumentException
-
auctionConstrainerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
auctionConstrainerSearchOrder
not of this servicemandatory
- This method must be implemented. AuctionConstrainerQuery getAuctionConstrainerQueryFromInspector(AuctionConstrainerQueryInspector auctionConstrainerQueryInspector)
auctionConstrainerQueryInspector
- an auction constrainer query
inspectorNullArgumentException
-
auctionConstrainerQueryInspector
is null
UnsupportedException
-
auctionConstrainerQueryInspector
is not of this
servicemandatory
- This method must be implemented.