org.osid.bidding

Interface AuctionHouseQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface AuctionHouseQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector interface for examining auction house queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorAuctionHouseIdTerms() Gets the ancestor auction house Id query terms.
AuctionHouseQueryInspector[]	getAncestorAuctionHouseTerms() Gets the ancestor auction house query terms.
AuctionHouseQueryInspectorRecord	getAuctionHouseQueryInspectorRecord(Type auctionHouseRecordType) Gets the auction house query inspector record corresponding to the given AuctionHouse record Type.
IdTerm[]	getAuctionIdTerms() Gets the auction Id query terms.
AuctionQueryInspector[]	getAuctionTerms() Gets the auction query terms.
IdTerm[]	getBidIdTerms() Gets the bid Id query terms.
BidQueryInspector[]	getBidTerms() Gets the bid query terms.
IdTerm[]	getDescendantAuctionHouseIdTerms() Gets the descendant auction house Id query terms.
AuctionHouseQueryInspector[]	getDescendantAuctionHouseTerms() Gets the descendant auction house query terms.

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

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

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.

getBidIdTerms

IdTerm[] getBidIdTerms()

Gets the bid Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getBidTerms

BidQueryInspector[] getBidTerms()

Gets the bid query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorAuctionHouseIdTerms

IdTerm[] getAncestorAuctionHouseIdTerms()

Gets the ancestor auction house Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorAuctionHouseTerms

AuctionHouseQueryInspector[] getAncestorAuctionHouseTerms()

Gets the ancestor auction house query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantAuctionHouseIdTerms

IdTerm[] getDescendantAuctionHouseIdTerms()

Gets the descendant auction house Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantAuctionHouseTerms

AuctionHouseQueryInspector[] getDescendantAuctionHouseTerms()

Gets the descendant auction house query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAuctionHouseQueryInspectorRecord

AuctionHouseQueryInspectorRecord getAuctionHouseQueryInspectorRecord(Type auctionHouseRecordType)
                                                                     throws OperationFailedException

Gets the auction house query inspector record corresponding to the given AuctionHouse record Type.

Parameters:

auctionHouseRecordType - an auction house record type

Returns:

the auction house query inspector record

Throws:

NullArgumentException - auctionHouseRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionHouseRecordType) is false

Compliance:

mandatory - This method must be implemented.