Interface ProductQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable

public interface ProductQuery
extends OsidObjectQuery

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

Method Summary

Modifier and Type	Method	Description
void	clearAvailabilityTerms()	Clears the availability terms.
void	clearCodeTerms()	Clears the code.
void	clearItemIdTerms()	Clears the item Id terms.
void	clearItemTerms()	Clears the item terms.
void	clearPriceScheduleIdTerms()	Clears the price schedule Id terms.
void	clearPriceScheduleTerms()	Clears the price schedule terms.
void	clearStoreIdTerms()	Clears the store Id terms.
void	clearStoreTerms()	Clears the store terms.
ItemQuery	getItemQuery()	Gets the query for an item.
PriceScheduleQuery	getPriceScheduleQuery()	Gets the query for a price schedule.
ProductQueryRecord	getProductQueryRecord(Type productRecordType)	Gets the product query record corresponding to the given Product record Type .Multiple record retrievals produce a nested boolean OR term.
StoreQuery	getStoreQuery()	Gets the query for a store query.
void	matchAnyAvailability(boolean match)	Matches products with any availability set.
void	matchAnyCode(boolean match)	Matches products with any code.
void	matchAnyItem(boolean match)	Matches prices used with any item.
void	matchAnyPriceSchedule(boolean match)	Matches products with any price schedule.
void	matchAvailability(long low, long high, boolean match)	Matches product availability between the given range inclusive.
void	matchCode(String code, Type stringMatchType, boolean match)	Matches product codes.
void	matchItemId(Id itemId, boolean match)	Sets the item Id for this query.
void	matchPriceScheduleId(Id priceScheduleId, boolean match)	Sets the price schedule Id for this query.
void	matchStoreId(Id storeId, boolean match)	Sets the product Id for this query to match orders assigned to stores.
boolean	supportsItemQuery()	Tests if an item query is available.
boolean	supportsPriceScheduleQuery()	Tests if a price schedule query is available.
boolean	supportsStoreQuery()	Tests if a StoreQuery 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.

Method Details

matchCode

void matchCode(String code,
 Type stringMatchType,
 boolean match)

Matches product codes.

Parameters:

code - a product code

stringMatchType - a string match type

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

Throws:

InvalidArgumentException - code not of stringMatchType

NullArgumentException - code or stringMatchType is null

Compliance:

mandatory - This method must be implemented.

matchAnyCode

void matchAnyCode(boolean match)

Matches products with any code.

Parameters:

match - true to match products with any code, false to match products with no code

Compliance:

mandatory - This method must be implemented.

clearCodeTerms

void clearCodeTerms()

Clears the code.

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.

matchAvailability

void matchAvailability(long low,
 long high,
 boolean match)

Matches product availability between the given range inclusive.

Parameters:

low - a product code

high - a string match type

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

Throws:

InvalidArgumentException - low is greater than high

Compliance:

mandatory - This method must be implemented.

matchAnyAvailability

void matchAnyAvailability(boolean match)

Matches products with any availability set.

Parameters:

match - true to match products with anyavailability value, false to match products with no availability value

Compliance:

mandatory - This method must be implemented.

clearAvailabilityTerms

void clearAvailabilityTerms()

Clears the availability terms.

Compliance:

mandatory - This method must be implemented.

matchItemId

void matchItemId(Id itemId,
 boolean match)

Sets the item Id for this query.

Parameters:

itemId - an item Id

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

Throws:

NullArgumentException - priceScheduleId is null

Compliance:

mandatory - This method must be implemented.

clearItemIdTerms

void clearItemIdTerms()

Clears the item Id terms.

Compliance:

mandatory - This method must be implemented.

supportsItemQuery

boolean supportsItemQuery()

Tests if an item query is available.

Returns:

true if an item query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getItemQuery

ItemQuery getItemQuery()

Gets the query for an item.

Returns:

the item query

Throws:

UnimplementedException - supportsItemQuery() is false

Compliance:

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

matchAnyItem

void matchAnyItem(boolean match)

Matches prices used with any item.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearItemTerms

void clearItemTerms()

Clears the item terms.

Compliance:

mandatory - This method must be implemented.

matchStoreId

void matchStoreId(Id storeId,
 boolean match)

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

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.

clearStoreIdTerms

void clearStoreIdTerms()

Clears the store Id terms.

Compliance:

mandatory - This method must be implemented.

supportsStoreQuery

boolean supportsStoreQuery()

Tests if a StoreQuery is available.

Returns:

true if a store query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStoreQuery

StoreQuery getStoreQuery()

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

Returns:

the store query

Throws:

UnimplementedException - supportsStoreQuery() is false

Compliance:

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

clearStoreTerms

void clearStoreTerms()

Clears the store terms.

Compliance:

mandatory - This method must be implemented.

getProductQueryRecord

ProductQueryRecord getProductQueryRecord(Type productRecordType)
                                  throws OperationFailedException

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

Parameters:

productRecordType - a product record type

Returns:

the product query record

Throws:

NullArgumentException - productRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(productRecordType) is false

Compliance:

mandatory - This method must be implemented.