Interface ItemQuery

All Superinterfaces:

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

public interface ItemQuery
extends OsidRelationshipQuery

This is the query for searching for items. 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	clearCostTerms()	Clears the cost terms.
void	clearDerivedTerms()	Clears the derived terms.
void	clearMinimumCostTerms()	Clears the minimum cost terms.
void	clearOrderIdTerms()	Clears the order Id terms.
void	clearOrderTerms()	Clears the order terms.
void	clearProductIdTerms()	Clears the product Id terms.
void	clearProductTerms()	Clears the product terms.
void	clearQuantityTerms()	Clears the quantity terms.
void	clearStoreIdTerms()	Clears the store Id terms.
void	clearStoreTerms()	Clears the store terms.
ItemQueryRecord	getItemQueryRecord(Type itemRecordType)	Gets the item query record corresponding to the given Item record Type .Multiple record retrievals produce a nested boolean OR term.
OrderQuery	getOrderQuery()	Gets the query for an item.
ProductQuery	getProductQuery()	Gets the query for a product.
StoreQuery	getStoreQuery()	Gets the query for a store query.
void	matchCost(Currency low, Currency high, boolean match)	Matches costs between the given range inclusive.
void	matchDerived(boolean match)	Matches items that are derived.
void	matchMinimumCost(Currency cost, boolean match)	Matches minimum costs between the given range inclusive.
void	matchOrderId(Id orderId, boolean match)	Sets the order Id for this query to match orders assigned to items.
void	matchProductId(Id productId, boolean match)	Sets the product Id for this query.
void	matchQuantity(long low, long high, boolean match)	Matches quantities between the given range inclusive.
void	matchStoreId(Id storeId, boolean match)	Sets the item Id for this query to match orders assigned to stores.
boolean	supportsOrderQuery()	Tests if an order query is available.
boolean	supportsProductQuery()	Tests if a product 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.

Methods inherited from interface OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Modifier and Type	Method	Description
void	clearEndReasonIdTerms()	Clears all state Id terms.
void	clearEndReasonTerms()	Clears all end reason state terms.
StateQuery	getEndReasonQuery(boolean match)	Gets the query for the end reason state.
void	matchAnyEndReason(boolean match)	Match any end reason state.
void	matchEndReasonId(Id stateId, boolean match)	Match the Id of the end reason state.
boolean	supportsEndReasonQuery()	Tests if a StateQuery for the end reason is available.

Methods inherited from interface OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Modifier and Type	Method	Description
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date range falls entirely between the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.

Method Details

matchOrderId

void matchOrderId(Id orderId,
 boolean match)

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

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

Returns:

the order query

Throws:

UnimplementedException - supportsOrderQuery() is false

Compliance:

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

clearOrderTerms

void clearOrderTerms()

Clears the order terms.

Compliance:

mandatory - This method must be implemented.

matchDerived

void matchDerived(boolean match)

Matches items that are derived.

Parameters:

match - true to match derived items, false to match selected items

Compliance:

mandatory - This method must be implemented.

clearDerivedTerms

void clearDerivedTerms()

Clears the derived 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} .

clearProductTerms

void clearProductTerms()

Clears the product terms.

Compliance:

mandatory - This method must be implemented.

matchQuantity

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

Matches quantities between the given range inclusive.

Parameters:

low - low range

high - high range

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.

clearQuantityTerms

void clearQuantityTerms()

Clears the quantity terms.

Compliance:

mandatory - This method must be implemented.

matchCost

void matchCost(Currency low,
 Currency high,
 boolean match)

Matches costs between the given range inclusive.

Parameters:

low - low range

high - high range

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

Throws:

InvalidArgumentException - low is greater than high

NullArgumentException - low or high is null

Compliance:

mandatory - This method must be implemented.

clearCostTerms

void clearCostTerms()

Clears the cost terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumCost

void matchMinimumCost(Currency cost,
 boolean match)

Matches minimum costs between the given range inclusive.

Parameters:

cost - cost

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

Throws:

NullArgumentException - cost is null

Compliance:

mandatory - This method must be implemented.

clearMinimumCostTerms

void clearMinimumCostTerms()

Clears the minimum cost terms.

Compliance:

mandatory - This method must be implemented.

matchStoreId

void matchStoreId(Id storeId,
 boolean match)

Sets the item 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.

getItemQueryRecord

ItemQueryRecord getItemQueryRecord(Type itemRecordType)
                            throws OperationFailedException

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

Parameters:

itemRecordType - an item record type

Returns:

the item query record

Throws:

NullArgumentException - itemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(itemRecordType) is false

Compliance:

mandatory - This method must be implemented.