org.osid.bidding.rules

Interface AuctionProcessorQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidProcessorQueryInspector, OsidQueryInspector, OsidRuleQueryInspector

public interface AuctionProcessorQueryInspector
extends OsidProcessorQueryInspector

This is the query inspector for examining auction processor 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.
AuctionProcessorQueryInspectorRecord	getAuctionProcessorQueryInspectorRecord(Type auctionProcessorRecordType) Gets the auction processor query inspector record corresponding to the given AuctionProcessor record Type.
IdTerm[]	getRuledAuctionIdTerms() Gets the auction Id query terms.
AuctionQueryInspector[]	getRuledAuctionTerms() Gets the auction query terms.

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

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.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Method Detail

getRuledAuctionIdTerms

IdTerm[] getRuledAuctionIdTerms()

Gets the auction Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledAuctionTerms

AuctionQueryInspector[] getRuledAuctionTerms()

Gets the auction 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.

getAuctionProcessorQueryInspectorRecord

AuctionProcessorQueryInspectorRecord getAuctionProcessorQueryInspectorRecord(Type auctionProcessorRecordType)
                                                                             throws OperationFailedException

Gets the auction processor query inspector record corresponding to the given AuctionProcessor record Type.

Parameters:

auctionProcessorRecordType - an auction processor record type

Returns:

the auction processor query inspector record

Throws:

NullArgumentException - auctionProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.