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

This session provides methods for retrieving Auction objects. The Auction represents a fixed connection between two Items.

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 auction methods in this session operate, retrieve and pertain to auctions defined explicitly in the current auction house. Using an isolated view is useful for managing Auctions with the AuctionAdminSession.
  • federated auction house view: All auction methods in this session operate, retrieve and pertain to all auctions defined in this auction house and any other auctions implicitly available in this auction house through auction house inheritence.
  • active auction view: All auction lookup methods return active auctions.
  • any status auction view: Active and inactive auctions 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.
MethodcanLookupAuctions
Description

Tests if this user can perform Auction 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.
MethoduseComparativeAuctionView
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.
MethodusePlenaryAuctionView
Description

A complete view of the Auction 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 auctions 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.
MethoduseActiveAuctionView
Description

Only active auctions are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusAuctionView
Description

Active and inactive auctions are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetAuction
Description

Gets the Auction specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Auction may have a different Id than requested, such as the case where a duplicate Id was assigned to an Auction and retained for compatibility.

In active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned.

Parametersosid.id.IdauctionId Id of the Auction
Returnosid.bidding.Auctionthe auction
ErrorsNOT_FOUND auctionId not found
NULL_ARGUMENT auctionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetAuctionsByIds
Description

Gets an AuctionList corresponding to the given IdList.

In plenary mode, the returned list contains all of the auctions 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 Auctions may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned.

Parametersosid.id.IdListauctionIdsthe list of Ids to retrieve
Returnosid.bidding.AuctionListthe returned Auction list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT auctionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionsByGenusType
Description

Gets an AuctionList corresponding to the given auction genus Type which does not include auctions of genus types derived from the specified Type.

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 active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned.

Parametersosid.type.TypeauctionGenusTypean auction genus type
Returnosid.bidding.AuctionListthe returned Auction list
ErrorsNULL_ARGUMENT auctionGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionsByParentGenusType
Description

Gets an AuctionList corresponding to the given auction genus Type and include any additional auctions with genus types derived from the specified Type.

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 active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned.

Parametersosid.type.TypeauctionGenusTypean auction genus type
Returnosid.bidding.AuctionListthe returned Auction list
ErrorsNULL_ARGUMENT auctionGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionsByRecordType
Description

Gets an AuctionList containing the given auction record Type.

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 active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned.

Parametersosid.type.TypeauctionRecordTypean auction record type
Returnosid.bidding.AuctionListthe returned Auction list
ErrorsNULL_ARGUMENT auctionRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionsByProvider
Description

Gets an AuctionList from the given provider.

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 active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned.

Parametersosid.id.IdresourceIda resource Id
Returnosid.bidding.AuctionListthe returned Auction list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionsOnDate
Description

Gets an AuctionList effective during the entire given date range inclusive but not confined to the date range.

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 active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned.

Parametersosid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.bidding.AuctionListthe returned Auction 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.
MethodgetAuctionsByItem
Description

Gets a list of auctions for an item.

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 active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned.

Parametersosid.id.IditemIda resource Id
Returnosid.bidding.AuctionListthe returned Auction list
ErrorsNULL_ARGUMENT itemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionsByItemGenusType
Description

Gets a list of auctions for an item genus type.

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 active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned.

Parametersosid.type.TypeitemGenusTypean item genus type
Returnosid.bidding.AuctionListthe returned Auction list
ErrorsNULL_ARGUMENT itemGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionsByItemGenusTypeOnDate
Description

Gets an AuctionList for an item genus type 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 auctions or an error results. Otherwise, the returned list may contain only those auctions that are accessible through this session.

In active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned.

Parametersosid.type.TypeitemGenusTypean item genus type
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.bidding.AuctionListthe returned Auction list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT itemGenusType, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctions
Description

Gets all Auctions.

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 active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned.

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