OSID Logo
OSID Specifications
bidding rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.rules.AuctionConstrainerQuery
Implementsosid.OsidConstrainerQuery
Description

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

MethodmatchRuledAuctionId
Description

Matches mapped to the auction.

Parametersosid.id.IdauctionIdthe auction Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT auctionId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledAuctionIdTerms
Description

Clears the auction Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledAuctionQuery
Description

Tests if an AuctionQuery is available.

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

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

Returnosid.bidding.AuctionQuerythe auction query
ErrorsUNIMPLEMENTED supportsRuledAuctionQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledAuctionQuery() is true.
MethodmatchAnyRuledAuction
Description

Matches mapped to any auction.

Parametersbooleanmatch true for mapped to any auction, false to match mapped to no auction
CompliancemandatoryThis method must be implemented.
MethodclearRuledAuctionTerms
Description

Clears the auction query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAuctionHouseId
Description

Matches 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.
MethodgetAuctionConstrainerQueryRecord
Description

Gets the auction constrainer query record corresponding to the given AuctionConstrainer record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeauctionConstrainerRecordTypean auction constrainer record type
Returnosid.bidding.rules.records.AuctionConstrainerQueryRecordthe auction constrainer query record
ErrorsNULL_ARGUMENT auctionConstrainerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(auctionConstrainerRecordType) is false
CompliancemandatoryThis method must be implemented.