OSID Logo
OSID Specifications
bidding rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.rules.AuctionProcessorEnablerQuery
Implementsosid.OsidEnablerQuery
Description

This is the query for searching auction processor enablers. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchRuledAuctionProcessorId
Description

Matches enablers mapped to the auction processor.

Parametersosid.id.IdauctionProcessorIdthe auction Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT auctionProcessorId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledAuctionProcessorIdTerms
Description

Clears the auction processor Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledAuctionProcessorQuery
Description

Tests if an AuctionProcessorQuery is available.

Returnboolean true if an auction processor query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRuledAuctionProcessorQuery
Description

Gets the query for an auction processor. Multiple retrievals produce a nested OR term.

Returnosid.bidding.rules.AuctionProcessorQuerythe auction processor query
ErrorsUNIMPLEMENTED supportsRuledAuctionProcessorQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledAuctionProcessorQuery() is true.
MethodmatchAnyRuledAuctionProcessor
Description

Matches enablers mapped to any auction processor.

Parametersbooleanmatch true for enablers mapped to any auction processor, false to match enablers mapped to no auction processors
CompliancemandatoryThis method must be implemented.
MethodclearRuledAuctionProcessorTerms
Description

Clears the auction processor query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAuctionHouseId
Description

Matches enablers mapped to the auction house.

Parametersosid.id.IdauctionHouseIdthe auction house Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT auctionHouseId is null
CompliancemandatoryThis method must be implemented.
MethodclearAuctionHouseIdTerms
Description

Clears the auction house Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAuctionHouseQuery
Description

Tests if a AuctionHouseQuery is available.

Returnboolean true if a auction house query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouseQuery
Description

Gets the query for a auction house. Multiple retrievals produce a nested OR term.

Returnosid.bidding.AuctionHouseQuerythe auction house query
ErrorsUNIMPLEMENTED supportsAuctionHouseQuery() is false
ComplianceoptionalThis method must be implemented if supportsAuctionHouseQuery() is true.
MethodclearAuctionHouseTerms
Description

Clears the auction house query terms.

CompliancemandatoryThis method must be implemented.
MethodgetAuctionProcessorEnablerQueryRecord
Description

Gets the auction processor enabler query record corresponding to the given AuctionProcessorEnabler record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeauctionProcessorEnablerRecordTypean auction processor enabler record type
Returnosid.bidding.rules.records.AuctionProcessorEnablerQueryRecordthe auction processor enabler query record
ErrorsNULL_ARGUMENT auctionProcessorEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(auctionProcessorEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.