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

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

MethodmatchRuledAuctionConstrainerId
Description

Matches enablers mapped to the auction constrainer.

Parametersosid.id.IdauctionConstrainerIdthe auction constrainer Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT auctionConstrainerId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledAuctionConstrainerIdTerms
Description

Clears the auction constrainer Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledAuctionConstrainerQuery
Description

Tests if an AuctionConstrainerQuery is available.

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

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

Returnosid.bidding.rules.AuctionConstrainerQuerythe auction constrainer query
ErrorsUNIMPLEMENTED supportsRuledAuctionConstrainerQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledAuctionConstrainerQuery() is true.
MethodmatchAnyRuledAuctionConstrainer
Description

Matches enablers mapped to any auction constrainer.

Parametersbooleanmatch true for enablers mapped to any auction constrainer, false to match enablers mapped to no auction constrainers
CompliancemandatoryThis method must be implemented.
MethodclearRuledAuctionConstrainerTerms
Description

Clears the auction constrainer 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.
MethodgetAuctionConstrainerEnablerQueryRecord
Description

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

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