public interface BidLookupSession extends OsidSession
This session provides methods for retrieving Bid
relationships.
This session defines views that offer differing behaviors when retrieving multiple objects.
Bids
with the BidAdminSession.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. The
methods useFederatedAuctionHouseView()
and
useIsolatedAuctionHouseView()
behave as a radio group and one
should be selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupBids()
Tests if this user can perform
Bid lookups. |
AuctionHouse |
getAuctionHouse()
Gets the
AuctionHouse associated with this session. |
Id |
getAuctionHouseId()
Gets the
AuctionHouse Id associated with
this session. |
Bid |
getBid(Id bidId)
Gets the
Bid specified by its Id. |
BidList |
getBids()
Gets all
Bids. |
BidList |
getBidsByGenusType(Type bidGenusType)
Gets a
BidList corresponding to the given bid genus
Type which does not include bids of genus types derived
from the specified Type. |
BidList |
getBidsByIds(IdList bidIds)
Gets a
BidList corresponding to the given
IdList. |
BidList |
getBidsByParentGenusType(Type bidGenusType)
Gets a
BidList corresponding to the given bid genus
Type and include any additional bids with genus types
derived from the specified Type. |
BidList |
getBidsByRecordType(Type bidRecordType)
Gets a
BidList containing the given bid record
Type. |
BidList |
getBidsForAuction(Id auctionId)
Gets a list of bids for an auction.
|
BidList |
getBidsForAuctionAndBidder(Id auctionId,
Id resourceId)
Gets a list of bids for an auction and bidder.
|
BidList |
getBidsForAuctionAndBidderOnDate(Id auctionId,
Id resourceId,
DateTime from,
DateTime to)
Gets a list of bids for an auction and bidder and effective during the
entire given date range inclusive but not confined to the date range.
|
BidList |
getBidsForAuctionOnDate(Id auctionId,
DateTime from,
DateTime to)
Gets a list of bids for an auction and effective during the entire
given date range inclusive but not confined to the date range.
|
BidList |
getBidsForBidder(Id resourceId)
Gets a list of bids for a bidder.
|
BidList |
getBidsForBidderOnDate(Id resourceId,
DateTime from,
DateTime to)
Gets a list of bids for a bidder and effective during the entire given
date range inclusive but not confined to the date range.
|
BidList |
getBidsOnDate(DateTime from,
DateTime to)
Gets a
BidList effective during the entire given date
range inclusive but not confined to the date range. |
BidList |
getWinningBids()
Gets all winning
Bids. |
BidList |
getWinningBidsForAuction(Id auctionId)
Gets a list of all winning bids for an auction.
|
BidList |
getWinningBidsForAuctionOnDate(Id auctionId,
DateTime from,
DateTime to)
Gets a list of winning bids for an auction and effectiveduring the
entire given date range inclusive but not confined to the date range.
|
BidList |
getWinningBidsForBidder(Id resourceId)
Gets a list of all winning bids for a bidder.
|
BidList |
getWinningBidsForBidderOnDate(Id resourceId,
DateTime from,
DateTime to)
Gets a list of winning bids for a bidder and effective during the
entire given date range inclusive but not confined to the date range.
|
BidList |
getWinningBidsOnDate(DateTime from,
DateTime to)
Gets a list of all winning bids effective during the entire given date
range inclusive but not confined to the date range.
|
void |
useAnyEffectiveBidView()
All bids of any effective dates are returned by methods in this
session.
|
void |
useComparativeBidView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useEffectiveBidView()
Only bids whose effective dates are current are returned by methods in
this session.
|
void |
useFederatedAuctionHouseView()
Federates the view for methods in this session.
|
void |
useIsolatedAuctionHouseView()
Isolates the view for methods in this session.
|
void |
usePlenaryBidView()
A complete view of the
Bid returns is desired. |
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 canLookupBids()
Bid
lookups. A return of
true does not guarantee successful authorization. A return of false
indicates that it is known all 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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeBidView()
mandatory
- This method is must be implemented. void usePlenaryBidView()
Bid
returns is desired. Methods
will return what is requested or result in an error. This view is used
when greater precision is desired at the expense of interoperability.mandatory
- This method is must be implemented. void useFederatedAuctionHouseView()
mandatory
- This method is must be implemented. void useIsolatedAuctionHouseView()
mandatory
- This method is must be implemented. void useEffectiveBidView()
mandatory
- This method is must be implemented. void useAnyEffectiveBidView()
mandatory
- This method is must be implemented. Bid getBid(Id bidId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Bid
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Bid
may have a different Id
than requested,
such as the case where a duplicate Id
was assigned to a
Bid
and retained for compatibility.
In effective mode, bids are returned that are currently effective. In
any effective mode, effective bids and those currently expired are
returned.bidId
- Id
of the Bid
NotFoundException
- bidId
not foundNullArgumentException
- bidId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. BidList getBidsByIds(IdList bidIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
BidList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
bids specified in the Id
list, in the order of the
list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Bids
may be omitted from the list and may
present the elements in any order including returning a unique set.
In effective mode, bids are returned that are currently effective. In
any effective mode, effective bids and those currently expired are
returned.bidIds
- the list of Ids
to retrieve Bid
listNotFoundException
- an Id was
not foundNullArgumentException
- bidIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BidList getBidsByGenusType(Type bidGenusType) throws OperationFailedException, PermissionDeniedException
BidList
corresponding to the given bid genus
Type
which does not include bids of genus types derived
from the specified Type.
In plenary mode, the returned list contains all known
bids or an error results. Otherwise, the returned list may contain
only those bids that are accessible through this session.
In effective mode, bids are returned that are currently effective. In
any effective mode, effective bids and those currently expired are
returned.bidGenusType
- a bid genus type Bid
listNullArgumentException
- bidGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BidList getBidsByParentGenusType(Type bidGenusType) throws OperationFailedException, PermissionDeniedException
BidList
corresponding to the given bid genus
Type
and include any additional bids with genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
bids or an error results. Otherwise, the returned list may contain
only those bids that are accessible through this session.
In effective mode, bids are returned that are currently effective. In
any effective mode, effective bids and those currently expired are
returned.bidGenusType
- a bid genus type Bid
listNullArgumentException
- bidGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BidList getBidsByRecordType(Type bidRecordType) throws OperationFailedException, PermissionDeniedException
BidList
containing the given bid record
Type.
In plenary mode, the returned list contains all known
bids or an error results. Otherwise, the returned list may contain
only those bids that are accessible through this session.
In effective mode, bids are returned that are currently effective. In
any effective mode, effective bids and those currently expired are
returned.bidRecordType
- a bid record type Bid
listNullArgumentException
- bidRecordType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BidList getBidsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
BidList
effective during the entire given date
range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known bids or an error
results. Otherwise, the returned list may contain only those bids that
are accessible through this session.
In effective mode, bids are returned that are currently effective. In
any effective mode, effective bids and those currently expired are
returned.from
- start of date rangeto
- end of date range Bid
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BidList getBidsForAuction(Id auctionId) throws OperationFailedException, PermissionDeniedException
auctionId
- an auction Id
Bid
listNullArgumentException
- auctionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BidList getBidsForAuctionOnDate(Id auctionId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
auctionId
- an auction Id
from
- start of date rangeto
- end of date range Bid
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- auctionId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BidList getBidsForBidder(Id resourceId) throws OperationFailedException, PermissionDeniedException
resourceId
- a resource Id
ommission
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BidList getBidsForBidderOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
resourceId
- a resource Id
from
- start of date rangeto
- end of date range ommission
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BidList getBidsForAuctionAndBidder(Id auctionId, Id resourceId) throws OperationFailedException, PermissionDeniedException
auctionId
- an auction Id
resourceId
- a resource Id
ommission
listNullArgumentException
- auctionId
or
resourceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BidList getBidsForAuctionAndBidderOnDate(Id auctionId, Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
auctionId
- an auction Id
resourceId
- a resource Id
from
- start of date rangeto
- end of date range ommission
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- auctionId, resourceId,
from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BidList getWinningBids() throws OperationFailedException, PermissionDeniedException
Bids.
In plenary mode, the returned list contains all known
bids or an error results. Otherwise, the returned list may contain
only those bids that are accessible through this session. In both
cases, the order of the set is by start effective date.
In effective mode, bids are returned that are currently effective. In
any effective mode, effective bids and those currently expired are
returned. Bids
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BidList getWinningBidsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
from
- start of date rangeto
- end of date range Bid
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BidList getWinningBidsForAuction(Id auctionId) throws OperationFailedException, PermissionDeniedException
auctionId
- an auction Id
Bid
listNullArgumentException
- auctionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BidList getWinningBidsForAuctionOnDate(Id auctionId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
auctionId
- an auction Id
from
- start of date rangeto
- end of date range Bid
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- auctionId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BidList getWinningBidsForBidder(Id resourceId) throws OperationFailedException, PermissionDeniedException
resourceId
- a resourceId Id
Bid
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BidList getWinningBidsForBidderOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
resourceId
- a resource Id
from
- start of date rangeto
- end of date range ommission
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BidList getBids() throws OperationFailedException, PermissionDeniedException
Bids.
In plenary mode, the returned list contains all known bids or an error
results. Otherwise, the returned list may contain only those bids that
are accessible through this session.
In effective mode, bids are returned that are currently effective. In
any effective mode, effective bids and those currently expired are
returned. Bids
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.