Interface AuctionHouseQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface AuctionHouseQuery
extends OsidCatalogQuery

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 .

Method Summary

Modifier and Type	Method	Description
void	clearAncestorAuctionHouseIdTerms()	Clears the ancestor auction house Id query terms.
void	clearAncestorAuctionHouseTerms()	Clears the ancestor auction house query terms.
void	clearAuctionIdTerms()	Clears the auction Id query terms.
void	clearAuctionTerms()	Clears the auction query terms.
void	clearBidIdTerms()	Clears the bid Id query terms.
void	clearBidTerms()	Clears the bid query terms.
void	clearDescendantAuctionHouseIdTerms()	Clears the descendant auction house Id query terms.
void	clearDescendantAuctionHouseTerms()	Clears the descendant auction house query terms.
AuctionHouseQuery	getAncestorAuctionHouseQuery()	Gets the query for an AuctionHouse .
AuctionHouseQueryRecord	getAuctionHouseQueryRecord(Type auctionHouseRecordType)	Gets the auction house query record corresponding to the given AuctionHouse record Type .
AuctionQuery	getAuctionQuery()	Gets the query for an auction.
BidQuery	getBidQuery()	Gets the query for a bid.
AuctionHouseQuery	getDescendantAuctionHouseQuery()	Gets the query for an auction house.
void	matchAncestorAuctionHouseId(Id auctionHouseId, boolean match)	Sets the auction house Id for this query to match auction houses that have the specified auction house as an ancestor.
void	matchAnyAncestorAuctionHouse(boolean match)	Matches auction houses with any ancestor.
void	matchAnyAuction(boolean match)	Matches auction houses with any auction.
void	matchAnyBid(boolean match)	Matches auction houses that have any bid.
void	matchAnyDescendantAuctionHouse(boolean match)	Matches auction houses with any descendant.
void	matchAuctionId(Id auctionId, boolean match)	Sets the auction Id for this query.
void	matchBidId(Id bidId, boolean match)	Sets the bid Id for this query.
void	matchDescendantAuctionHouseId(Id auctionHouseId, boolean match)	Sets the auction house Id for this query to match auction houses that have the specified auction house as a descendant.
boolean	supportsAncestorAuctionHouseQuery()	Tests if an AuctionHouseQuery is available.
boolean	supportsAuctionQuery()	Tests if an AuctionQuery is available.
boolean	supportsBidQuery()	Tests if a BidQuery is available.
boolean	supportsDescendantAuctionHouseQuery()	Tests if an AuctionHouseQuery is available.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Modifier and Type	Method	Description
void	clearBrandingIdTerms()	Clears all asset Id terms.
void	clearBrandingTerms()	Clears all branding terms.
void	clearLicenseTerms()	Clears all license terms.
void	clearProviderIdTerms()	Clears all provider Id terms.
void	clearProviderTerms()	Clears all provider terms.
AssetQuery	getBrandingQuery(boolean match)	Gets the query for an asset.
ResourceQuery	getProviderQuery(boolean match)	Gets the query for the provider.
void	matchAnyBranding(boolean match)	Match sourceables with any branding.
void	matchAnyLicense(boolean match)	Matches any object with a license.
void	matchAnyProvider(boolean match)	Match sourceables with a provider value.
void	matchBrandingId(Id assetId, boolean match)	Match the Id of an asset used for branding.
void	matchLicense(String license, Type stringMatchType, boolean match)	Adds a license to match.
void	matchProviderId(Id resourceId, boolean match)	Match the Id of the provider resource.
boolean	supportsBrandingQuery()	Tests if an AssetQuery for the branding is available.
boolean	supportsProviderQuery()	Tests if a ResourceQuery for the provider is available.

Method Details

matchAuctionId

void matchAuctionId(Id auctionId,
 boolean match)

Sets the auction Id for this query.

Parameters:

auctionId - the auction Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - auctionId is null

Compliance:

mandatory - This method must be implemented.

clearAuctionIdTerms

void clearAuctionIdTerms()

Clears the auction Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAuctionQuery

boolean supportsAuctionQuery()

Tests if an AuctionQuery is available.

Returns:

true if an auction query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAuctionQuery

AuctionQuery getAuctionQuery()

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

Returns:

the auction query

Throws:

UnimplementedException - supportsAuctionQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAuctionQuery()} is {@code true} .

matchAnyAuction

void matchAnyAuction(boolean match)

Matches auction houses with any auction.

Parameters:

match - true to match auction houses with any auction, false to match auction houses with no auction

Compliance:

mandatory - This method must be implemented.

clearAuctionTerms

void clearAuctionTerms()

Clears the auction query terms.

Compliance:

mandatory - This method must be implemented.

matchBidId

void matchBidId(Id bidId,
 boolean match)

Sets the bid Id for this query.

Parameters:

bidId - the bid Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - bidId is null

Compliance:

mandatory - This method must be implemented.

clearBidIdTerms

void clearBidIdTerms()

Clears the bid Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsBidQuery

boolean supportsBidQuery()

Tests if a BidQuery is available.

Returns:

true if a bid query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBidQuery

BidQuery getBidQuery()

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

Returns:

the bid query

Throws:

UnimplementedException - supportsBidQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsBidQuery()} is {@code true} .

matchAnyBid

void matchAnyBid(boolean match)

Matches auction houses that have any bid.

Parameters:

match - true to match auction houses with any bid, false to match auction houses with no bid

Compliance:

mandatory - This method must be implemented.

clearBidTerms

void clearBidTerms()

Clears the bid query terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorAuctionHouseId

void matchAncestorAuctionHouseId(Id auctionHouseId,
 boolean match)

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

Parameters:

auctionHouseId - an auction house Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - auctionHouseId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorAuctionHouseIdTerms

void clearAncestorAuctionHouseIdTerms()

Clears the ancestor auction house Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorAuctionHouseQuery

boolean supportsAncestorAuctionHouseQuery()

Tests if an AuctionHouseQuery is available.

Returns:

true if an auction house query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorAuctionHouseQuery

AuctionHouseQuery getAncestorAuctionHouseQuery()

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

Returns:

the auction house query

Throws:

UnimplementedException - supportsAncestorAuctionHouseQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAncestorAuctionHouseQuery()} is {@code true} .

matchAnyAncestorAuctionHouse

void matchAnyAncestorAuctionHouse(boolean match)

Matches auction houses with any ancestor.

Parameters:

match - true to match auction houses with any ancestor, false to match root auction houses

Compliance:

mandatory - This method must be implemented.

clearAncestorAuctionHouseTerms

void clearAncestorAuctionHouseTerms()

Clears the ancestor auction house query terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantAuctionHouseId

void matchDescendantAuctionHouseId(Id auctionHouseId,
 boolean match)

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

Parameters:

auctionHouseId - an auction house Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - auctionHouseId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantAuctionHouseIdTerms

void clearDescendantAuctionHouseIdTerms()

Clears the descendant auction house Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantAuctionHouseQuery

boolean supportsDescendantAuctionHouseQuery()

Tests if an AuctionHouseQuery is available.

Returns:

true if an auction house query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantAuctionHouseQuery

AuctionHouseQuery getDescendantAuctionHouseQuery()

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

Returns:

the auction house query

Throws:

UnimplementedException - supportsDescendantAuctionHouseQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsDescendantAuctionHouseQuery()} is {@code true} .

matchAnyDescendantAuctionHouse

void matchAnyDescendantAuctionHouse(boolean match)

Matches auction houses with any descendant.

Parameters:

match - true to match auction houses with any descendant, false to match leaf auction houses

Compliance:

mandatory - This method must be implemented.

clearDescendantAuctionHouseTerms

void clearDescendantAuctionHouseTerms()

Clears the descendant auction house query terms.

Compliance:

mandatory - This method must be implemented.

getAuctionHouseQueryRecord

AuctionHouseQueryRecord getAuctionHouseQueryRecord(Type auctionHouseRecordType)
                                            throws OperationFailedException

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

Parameters:

auctionHouseRecordType - an auction house record type

Returns:

the auction house query record

Throws:

NullArgumentException - auctionHouseRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionHouseRecordType) is false

Compliance:

mandatory - This method must be implemented.