OSID Logo
OSID Specifications
bidding package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.BidLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving Bid relationships.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated auction house view: All bid methods in this session operate, retrieve and pertain to bids defined explicitly in the current auction house. Using an isolated view is useful for managing Bids with the BidAdminSession.
  • federated auction house view: All bid methods in this session operate, retrieve and pertain to all bids defined in this auction house and any other bids implicitly available in this auction house through auction house inheritence.
  • effective bid view: All bid lookup methods return bids where the current date falls in between the effective dates inclusive.
  • any effective bid view: Bids of any effective date are returned from methods.

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.

MethodgetAuctionHouseId
Description

Gets the AuctionHouse Id associated with this session.

Returnosid.id.Idthe AuctionHouse Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouse
Description

Gets the AuctionHouse associated with this session.

Returnosid.bidding.AuctionHousethe auction house
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupBids
Description

Tests if this user can perform 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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeBidView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryBidView
Description

A complete view of the 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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedAuctionHouseView
Description

Federates the view for methods in this session. A federated view will include bids in auction houses which are children of this auction house in the auction house hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedAuctionHouseView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this auction house only.

CompliancemandatoryThis method is must be implemented.
MethoduseEffectiveBidView
Description

Only bids whose effective dates are current are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyEffectiveBidView
Description

All bids of any effective dates are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetBid
Description

Gets the 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.

Parametersosid.id.IdbidId Id of the Bid
Returnosid.bidding.Bidthe bid
ErrorsNOT_FOUND bidId not found
NULL_ARGUMENT bidId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetBidsByIds
Description

Gets a 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.

Parametersosid.id.IdListbidIdsthe list of Ids to retrieve
Returnosid.bidding.BidListthe returned Bid list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT bidIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBidsByGenusType
Description

Gets a 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.

Parametersosid.type.TypebidGenusTypea bid genus type
Returnosid.bidding.BidListthe returned Bid list
ErrorsNULL_ARGUMENT bidGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBidsByParentGenusType
Description

Gets a 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.

Parametersosid.type.TypebidGenusTypea bid genus type
Returnosid.bidding.BidListthe returned Bid list
ErrorsNULL_ARGUMENT bidGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBidsByRecordType
Description

Gets a 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.

Parametersosid.type.TypebidRecordTypea bid record type
Returnosid.bidding.BidListthe returned Bid list
ErrorsNULL_ARGUMENT bidRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBidsOnDate
Description

Gets a 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.

Parametersosid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.bidding.BidListthe returned Bid list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBidsForAuction
Description

Gets a list of bids for an auction.

In plenary mode, the returned list contains all known auctions or an error results. Otherwise, the returned list may contain only those auctions 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.

Parametersosid.id.IdauctionIdan auction Id
Returnosid.bidding.BidListthe returned Bid list
ErrorsNULL_ARGUMENT auctionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBidsForAuctionOnDate
Description

Gets a list of bids for an auction and 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.

Parametersosid.id.IdauctionIdan auction Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.bidding.BidListthe returned Bid list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT auctionId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBidsForBidder
Description

Gets a list of bids for a bidder.

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.

Parametersosid.id.IdresourceIda resource Id
Returnosid.bidding.BidListthe returned C ommission list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBidsForBidderOnDate
Description

Gets a list of bids for a bidder and 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.

Parametersosid.id.IdresourceIda resource Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.bidding.BidListthe returned C ommission list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT resourceId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBidsForAuctionAndBidder
Description

Gets a list of bids for an auction and bidder.

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.

Parametersosid.id.IdauctionIdan auction Id
osid.id.IdresourceIda resource Id
Returnosid.bidding.BidListthe returned C ommission list
ErrorsNULL_ARGUMENT auctionId or resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBidsForAuctionAndBidderOnDate
Description

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.

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.

Parametersosid.id.IdauctionIdan auction Id
osid.id.IdresourceIda resource Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.bidding.BidListthe returned C ommission list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT auctionId, resourceId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWinningBids
Description

Gets all winning 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.

Returnosid.bidding.BidLista list of Bids
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWinningBidsOnDate
Description

Gets a list of all winning bids 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 both cases, the order of the set is by the start of the effective date.

In effective mode, bids are returned that are currently effective. In any effective mode, effective bids and those currently expired are returned.

Parametersosid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.bidding.BidListthe returned Bid list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWinningBidsForAuction
Description

Gets a list of all winning bids for an auction.

In plenary mode, the returned list contains all known auctions or an error results. Otherwise, the returned list may contain only those auctions 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.

Parametersosid.id.IdauctionIdan auction Id
Returnosid.bidding.BidListthe returned Bid list
ErrorsNULL_ARGUMENT auctionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWinningBidsForAuctionOnDate
Description

Gets a list of winning bids for an auction and effectiveduring 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.

Parametersosid.id.IdauctionIdan auction Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.bidding.BidListthe returned Bid list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT auctionId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWinningBidsForBidder
Description

Gets a list of all winning bids for a bidder.

In plenary mode, the returned list contains all known auctions or an error results. Otherwise, the returned list may contain only those auctions 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.

Parametersosid.id.IdresourceIda resourceId Id
Returnosid.bidding.BidListthe returned Bid list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWinningBidsForBidderOnDate
Description

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.

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.

Parametersosid.id.IdresourceIda resource Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.bidding.BidListthe returned C ommission list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT resourceId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBids
Description

Gets all 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.

Returnosid.bidding.BidLista list of Bids
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.