OSID Logo
OSID Specifications
bidding package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.AuctionHouseQuery
Implementsosid.OsidCatalogQuery
Description

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

MethodmatchAuctionId
Description

Sets the auction Id for this query.

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

Clears the auction Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAuctionQuery
Description

Tests if an AuctionQuery is available.

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

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

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

Matches auction houses with any auction.

Parametersbooleanmatch true to match auction houses with any auction, false to match auction houses with no auction
CompliancemandatoryThis method must be implemented.
MethodclearAuctionTerms
Description

Clears the auction query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBidId
Description

Sets the bid Id for this query.

Parametersosid.id.IdbidIdthe bid Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT bidId is null
CompliancemandatoryThis method must be implemented.
MethodclearBidIdTerms
Description

Clears the bid Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsBidQuery
Description

Tests if a BidQuery is available.

Returnboolean true if a bid query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBidQuery
Description

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

Returnosid.bidding.BidQuerythe bid query
ErrorsUNIMPLEMENTED supportsBidQuery() is false
ComplianceoptionalThis method must be implemented if supportsBidQuery() is true.
MethodmatchAnyBid
Description

Matches auction houses that have any bid.

Parametersbooleanmatch true to match auction houses with any bid, false to match auction houses with no bid
CompliancemandatoryThis method must be implemented.
MethodclearBidTerms
Description

Clears the bid query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorAuctionHouseId
Description

Sets the auction house Id for this query to match auction houses that have the specified auction house as an ancestor.

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

Clears the ancestor auction house Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorAuctionHouseQuery
Description

Tests if an AuctionHouseQuery is available.

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

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

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

Matches auction houses with any ancestor.

Parametersbooleanmatch true to match auction houses with any ancestor, false to match root auction houses
CompliancemandatoryThis method must be implemented.
MethodclearAncestorAuctionHouseTerms
Description

Clears the ancestor auction house query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantAuctionHouseId
Description

Sets the auction house Id for this query to match auction houses that have the specified auction house as a descendant.

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

Clears the descendant auction house Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantAuctionHouseQuery
Description

Tests if an AuctionHouseQuery is available.

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

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

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

Matches auction houses with any descendant.

Parametersbooleanmatch true to match auction houses with any descendant, false to match leaf auction houses
CompliancemandatoryThis method must be implemented.
MethodclearDescendantAuctionHouseTerms
Description

Clears the descendant auction house query terms.

CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouseQueryRecord
Description

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

Parametersosid.type.TypeauctionHouseRecordTypean auction house record type
Returnosid.bidding.records.AuctionHouseQueryRecordthe auction house query record
ErrorsNULL_ARGUMENT auctionHouseRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(auctionHouseRecordType) is false
CompliancemandatoryThis method must be implemented.