org.osid.bidding

Interface BidQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface BidQueryInspector
extends OsidRelationshipQueryInspector

This is the query inspector for examining bid queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAuctionHouseIdTerms() Gets the auction house Id query terms.
AuctionHouseQueryInspector[]	getAuctionHouseTerms() Gets the auction house query terms.
IdTerm[]	getAuctionIdTerms() Gets the auction Id query terms.
AuctionQueryInspector[]	getAuctionTerms() Gets the auction query terms.
IdTerm[]	getBidderIdTerms() Gets the resource Id query terms.
ResourceQueryInspector[]	getBidderTerms() Gets the resource query terms.
IdTerm[]	getBiddingAgentIdTerms() Gets the agent Id query terms.
AgentQueryInspector[]	getBiddingAgentTerms() Gets the agent query terms.
BidQueryInspectorRecord	getBidQueryInspectorRecord(Type bidRecordType) Gets the bid query inspector record corresponding to the given Bid record Type.
CurrencyRangeTerm[]	getCurrentBidTerms() Gets the current bid query terms.
CurrencyRangeTerm[]	getMaximumBidTerms() Gets the maximum bid query terms.
CardinalRangeTerm[]	getQuantityTerms() Gets the quantity query terms.
CurrencyRangeTerm[]	getSettlementAmountTerms() Gets the settlement amount query terms.
BooleanTerm[]	getWinnerTerms() Gets the winning bid query terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getAuctionIdTerms

IdTerm[] getAuctionIdTerms()

Gets the auction Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAuctionTerms

AuctionQueryInspector[] getAuctionTerms()

Gets the auction query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getBidderIdTerms

IdTerm[] getBidderIdTerms()

Gets the resource Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getBidderTerms

ResourceQueryInspector[] getBidderTerms()

Gets the resource query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getBiddingAgentIdTerms

IdTerm[] getBiddingAgentIdTerms()

Gets the agent Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getBiddingAgentTerms

AgentQueryInspector[] getBiddingAgentTerms()

Gets the agent query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getQuantityTerms

CardinalRangeTerm[] getQuantityTerms()

Gets the quantity query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCurrentBidTerms

CurrencyRangeTerm[] getCurrentBidTerms()

Gets the current bid query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getMaximumBidTerms

CurrencyRangeTerm[] getMaximumBidTerms()

Gets the maximum bid query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getWinnerTerms

BooleanTerm[] getWinnerTerms()

Gets the winning bid query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSettlementAmountTerms

CurrencyRangeTerm[] getSettlementAmountTerms()

Gets the settlement amount query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAuctionHouseIdTerms

IdTerm[] getAuctionHouseIdTerms()

Gets the auction house Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAuctionHouseTerms

AuctionHouseQueryInspector[] getAuctionHouseTerms()

Gets the auction house query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getBidQueryInspectorRecord

BidQueryInspectorRecord getBidQueryInspectorRecord(Type bidRecordType)
                                                   throws OperationFailedException

Gets the bid query inspector record corresponding to the given Bid record Type.

Parameters:

bidRecordType - a bid record type

Returns:

the bid query inspector record

Throws:

NullArgumentException - bidRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(bidRecordType) is false

Compliance:

mandatory - This method must be implemented.