Interface StoreQuery

All Superinterfaces:

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

public interface StoreQuery
extends OsidCatalogQuery

This is the query for searching for stores. Each method specifies an AND term while multiple terms of the same method produce a nested OR .

Method Summary

Modifier and Type	Method	Description
void	clearAncestorStoreIdTerms()	Clears the ancestor store Id terms.
void	clearAncestorStoreTerms()	Clears the ancestor store terms.
void	clearDescendantStoreIdTerms()	Clears the descendant store Id terms.
void	clearDescendantStoreTerms()	Clears the descendant store terms.
void	clearOrderIdTerms()	Clears the order Id terms.
void	clearOrderTerms()	Clears the order terms.
void	clearPriceScheduleIdTerms()	Clears the price schedule Id terms.
void	clearPriceScheduleTerms()	Clears the price schedule terms.
void	clearProductIdTerms()	Clears the product Id terms.
void	clearProductTerms()	Clears the product terms.
StoreQuery	getAncestorStoreQuery()	Gets the query for a store.
StoreQuery	getDescendantStoreQuery()	Gets the query for a store.
OrderQuery	getOrderQuery()	Gets the query for an order.
PriceScheduleQuery	getPriceScheduleQuery()	Gets the query for a price schedule.
ProductQuery	getProductQuery()	Gets the query for a product.
StoreQueryRecord	getStoreQueryRecord(Type storeRecordType)	Gets the store query record corresponding to the given Store record Type .Multiple record retrievals produce a nested boolean OR term.
void	matchAncestorStoreId(Id storeId, boolean match)	Sets the store Id for this query to match stores that have the specified store as an ancestor.
void	matchAnyAncestorStore(boolean match)	Matches stores with any ancestor.
void	matchAnyDescendantStore(boolean match)	Matches stores with any descendant.
void	matchAnyOrder(boolean match)	Matches stores with any order.
void	matchAnyPriceSchedule(boolean match)	Matches products with any price schedule.
void	matchAnyProduct(boolean match)	Matches stores with any product.
void	matchDescendantStoreId(Id storeId, boolean match)	Sets the store Id for this query to match stores that have the specified store as a descendant.
void	matchOrderId(Id orderId, boolean match)	Sets the order Id for this query to match orders assigned to stores.
void	matchPriceScheduleId(Id priceScheduleId, boolean match)	Sets the price schedule Id for this query.
void	matchProductId(Id productId, boolean match)	Sets the product Id for this query.
boolean	supportsAncestorStoreQuery()	Tests if a StoreQuery is available.
boolean	supportsDescendantStoreQuery()	Tests if a StoreQuery is available.
boolean	supportsOrderQuery()	Tests if an order query is available.
boolean	supportsPriceScheduleQuery()	Tests if a price schedule query is available.
boolean	supportsProductQuery()	Tests if a product query 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

matchOrderId

void matchOrderId(Id orderId,
 boolean match)

Sets the order Id for this query to match orders assigned to stores.

Parameters:

orderId - an order Id

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

Throws:

NullArgumentException - orderId is null

Compliance:

mandatory - This method must be implemented.

clearOrderIdTerms

void clearOrderIdTerms()

Clears the order Id terms.

Compliance:

mandatory - This method must be implemented.

supportsOrderQuery

boolean supportsOrderQuery()

Tests if an order query is available.

Returns:

true if an order query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOrderQuery

OrderQuery getOrderQuery()

Gets the query for an order.

Returns:

the order query

Throws:

UnimplementedException - supportsOrderQuery() is false

Compliance:

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

matchAnyOrder

void matchAnyOrder(boolean match)

Matches stores with any order.

Parameters:

match - true to match stores with any order, false to match stores with no orders

Compliance:

mandatory - This method must be implemented.

clearOrderTerms

void clearOrderTerms()

Clears the order terms.

Compliance:

mandatory - This method must be implemented.

matchProductId

void matchProductId(Id productId,
 boolean match)

Sets the product Id for this query.

Parameters:

productId - a product Id

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

Throws:

NullArgumentException - productId is null

Compliance:

mandatory - This method must be implemented.

clearProductIdTerms

void clearProductIdTerms()

Clears the product Id terms.

Compliance:

mandatory - This method must be implemented.

supportsProductQuery

boolean supportsProductQuery()

Tests if a product query is available.

Returns:

true if a product query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProductQuery

ProductQuery getProductQuery()

Gets the query for a product.

Returns:

the product query

Throws:

UnimplementedException - supportsProductQuery() is false

Compliance:

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

matchAnyProduct

void matchAnyProduct(boolean match)

Matches stores with any product.

Parameters:

match - true to match stores with any product, false to match stores with no products

Compliance:

mandatory - This method must be implemented.

clearProductTerms

void clearProductTerms()

Clears the product terms.

Compliance:

mandatory - This method must be implemented.

matchPriceScheduleId

void matchPriceScheduleId(Id priceScheduleId,
 boolean match)

Sets the price schedule Id for this query.

Parameters:

priceScheduleId - a price schedule Id

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

Throws:

NullArgumentException - priceScheduleId is null

Compliance:

mandatory - This method must be implemented.

clearPriceScheduleIdTerms

void clearPriceScheduleIdTerms()

Clears the price schedule Id terms.

Compliance:

mandatory - This method must be implemented.

supportsPriceScheduleQuery

boolean supportsPriceScheduleQuery()

Tests if a price schedule query is available.

Returns:

true if a price schedule query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPriceScheduleQuery

PriceScheduleQuery getPriceScheduleQuery()

Gets the query for a price schedule.

Returns:

the price schedule query

Throws:

UnimplementedException - supportsPriceScheduleQuery() is false

Compliance:

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

matchAnyPriceSchedule

void matchAnyPriceSchedule(boolean match)

Matches products with any price schedule.

Parameters:

match - true to match products with any price schedule, false to match products with no price schedule

Compliance:

mandatory - This method must be implemented.

clearPriceScheduleTerms

void clearPriceScheduleTerms()

Clears the price schedule terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorStoreId

void matchAncestorStoreId(Id storeId,
 boolean match)

Sets the store Id for this query to match stores that have the specified store as an ancestor.

Parameters:

storeId - a store Id

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

Throws:

NullArgumentException - storeId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorStoreIdTerms

void clearAncestorStoreIdTerms()

Clears the ancestor store Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorStoreQuery

boolean supportsAncestorStoreQuery()

Tests if a StoreQuery is available.

Returns:

true if a store query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorStoreQuery

StoreQuery getAncestorStoreQuery()

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

Returns:

the store query

Throws:

UnimplementedException - supportsAncestorStoreQuery() is false

Compliance:

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

matchAnyAncestorStore

void matchAnyAncestorStore(boolean match)

Matches stores with any ancestor.

Parameters:

match - true to match stores with any ancestor, false to match root stores

Compliance:

mandatory - This method must be implemented.

clearAncestorStoreTerms

void clearAncestorStoreTerms()

Clears the ancestor store terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantStoreId

void matchDescendantStoreId(Id storeId,
 boolean match)

Sets the store Id for this query to match stores that have the specified store as a descendant.

Parameters:

storeId - a store Id

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

Throws:

NullArgumentException - storeId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantStoreIdTerms

void clearDescendantStoreIdTerms()

Clears the descendant store Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantStoreQuery

boolean supportsDescendantStoreQuery()

Tests if a StoreQuery is available.

Returns:

true if a store query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantStoreQuery

StoreQuery getDescendantStoreQuery()

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

Returns:

the store query

Throws:

UnimplementedException - supportsDescendantStoreQuery() is false

Compliance:

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

matchAnyDescendantStore

void matchAnyDescendantStore(boolean match)

Matches stores with any descendant.

Parameters:

match - true to match stores with any descendant, false to match leaf stores

Compliance:

mandatory - This method must be implemented.

clearDescendantStoreTerms

void clearDescendantStoreTerms()

Clears the descendant store terms.

Compliance:

mandatory - This method must be implemented.

getStoreQueryRecord

StoreQueryRecord getStoreQueryRecord(Type storeRecordType)
                              throws OperationFailedException

Gets the store query record corresponding to the given Store record Type .Multiple record retrievals produce a nested boolean OR term.

Parameters:

storeRecordType - a store record type

Returns:

the store query record

Throws:

NullArgumentException - storeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(storeRecordType) is false

Compliance:

mandatory - This method must be implemented.