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

This session provides methods for retrieving AuctionProcessors.

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 processor methods in this session operate, retrieve and pertain to auction processor defined explicitly in the current auction house. Using an isolated view is useful for managing AuctionProcessors with the AuctionProcessorAdminSession.
  • federated auction house view: All auction processor methods in this session operate, retrieve and pertain to all auction processor defined in this auction house and any other auction processor implicitly available in this auction house through auction house inheritence.
  • active auction processor view: All auction processor lookup methods return active auction processors.
  • any status auction processor view: Auction processors of any active or inactive status 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 useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

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.
MethodcanLookupAuctionProcessors
Description

Tests if this user can perform AuctionProcessors 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.
MethoduseComparativeAuctionProcessorView
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.
MethodusePlenaryAuctionProcessorView
Description

A complete view of the AuctionProcessor 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 auction processor 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.
MethoduseActiveAuctionProcessorView
Description

Only active auction processors are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusAuctionProcessorView
Description

All active and inactive auction processors are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetAuctionProcessor
Description

Gets the AuctionProcessor specified by its Id.

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

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

Parametersosid.id.IdauctionProcessorId Id of the AuctionProcessor
Returnosid.bidding.rules.AuctionProcessorthe auction processor
ErrorsNOT_FOUND auctionProcessorId not found
NULL_ARGUMENT auctionProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetAuctionProcessorsByIds
Description

Gets an AuctionProcessorList corresponding to the given IdList.

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

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

Parametersosid.id.IdListauctionProcessorIdsthe list of Ids to retrieve
Returnosid.bidding.rules.AuctionProcessorListthe returned AuctionProcessor list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT auctionProcessorIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionProcessorsByGenusType
Description

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

In plenary mode, the returned list contains all known auction processor or an error results. Otherwise, the returned list may contain only those auction processor that are accessible through this session.

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

Parametersosid.type.TypeauctionProcessorGenusTypean auction processor genus type
Returnosid.bidding.rules.AuctionProcessorListthe returned AuctionProcessor list
ErrorsNULL_ARGUMENT auctionProcessorGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionProcessorsByParentGenusType
Description

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

In plenary mode, the returned list contains all known auction processor or an error results. Otherwise, the returned list may contain only those auction processor that are accessible through this session.

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

Parametersosid.type.TypeauctionProcessorGenusTypean auction processor genus type
Returnosid.bidding.rules.AuctionProcessorListthe returned AuctionProcessor list
ErrorsNULL_ARGUMENT auctionProcessorGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionProcessorsByRecordType
Description

Gets an AuctionProcessorList containing the given auction processor record Type.

In plenary mode, the returned list contains all known auction processor or an error results. Otherwise, the returned list may contain only those auction processor that are accessible through this session.

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

Parametersosid.type.TypeauctionProcessorRecordTypean auction processor record type
Returnosid.bidding.rules.AuctionProcessorListthe returned AuctionProcessor list
ErrorsNULL_ARGUMENT auctionProcessorRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionProcessors
Description

Gets all AuctionProcessors.

In plenary mode, the returned list contains all known auction processor or an error results. Otherwise, the returned list may contain only those auction processor that are accessible through this session.

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

Returnosid.bidding.rules.AuctionProcessorListthe returned AuctionProcessor list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.