Interface IngredientQuery

All Superinterfaces:

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

public interface IngredientQuery
extends OsidObjectQuery, OsidSubjugateableQuery

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

Like all OsidQueries, IngredientQuery is stateful and must not be accessed by multiple processing threads.

Method Summary

Modifier and Type	Method	Description
void	clearQuantityTerms()	Clears the quantity query terms.
void	clearStockIdTerms()	Clears the stock Id query terms.
void	clearStockTerms()	Clears the stock query terms.
void	clearUnitTypeTerms()	Clears the unit type query terms.
IngredientQueryRecord	getIngredientQueryRecord(Type ingredientRecordType)	Gets the ingredient query record corresponding to the given Ingredient record Type.
StockQuery	getStockQuery()	Gets the query for a stock.
void	matchAnyQuantity(boolean match)	Matches ingredients with any quantity.
void	matchAnyStock(boolean match)	Matches ingredients with any stock.
void	matchAnyUnitType(boolean match)	Matches ingredients with any unit type.
void	matchQuantity(long low, long high, boolean match)	Matches ingredients with quantity between the given range inclusive.
void	matchStockId(Id stockId, boolean match)	Sets the stock Id for this query.
void	matchUnitType(Type unitType, boolean match)	Matches ingredients with a unit type.
boolean	supportsStockQuery()	Tests if a StockQuery is available.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

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

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Method Details

matchQuantity

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

Matches ingredients with quantity between the given range inclusive.

Parameters:

low - starting of range

high - end of 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.

matchAnyQuantity

void matchAnyQuantity(boolean match)

Matches ingredients with any quantity.

Parameters:

match - true to match ingredients with any quantity, false to match ingredients with no quantity

Compliance:

mandatory - This method must be implemented.

clearQuantityTerms

void clearQuantityTerms()

Clears the quantity query terms.

Compliance:

mandatory - This method must be implemented.

matchUnitType

void matchUnitType(Type unitType,
 boolean match)

Matches ingredients with a unit type.

Parameters:

unitType - a unit type

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

Throws:

NullArgumentException - unitType is null

Compliance:

mandatory - This method must be implemented.

matchAnyUnitType

void matchAnyUnitType(boolean match)

Matches ingredients with any unit type.

Parameters:

match - true to match ingredients with any unit type, false to match ingredients with no unit type

Compliance:

mandatory - This method must be implemented.

clearUnitTypeTerms

void clearUnitTypeTerms()

Clears the unit type query terms.

Compliance:

mandatory - This method must be implemented.

matchStockId

void matchStockId(Id stockId,
 boolean match)

Sets the stock Id for this query.

Parameters:

stockId - the stock Id

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

Throws:

NullArgumentException - stockId is null

Compliance:

mandatory - This method must be implemented.

clearStockIdTerms

void clearStockIdTerms()

Clears the stock Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsStockQuery

boolean supportsStockQuery()

Tests if a StockQuery is available.

Returns:

true if a stock query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStockQuery

StockQuery getStockQuery()

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

Returns:

the stock query

Throws:

UnimplementedException - supportsStockQuery() is false

Compliance:

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

matchAnyStock

void matchAnyStock(boolean match)

Matches ingredients with any stock.

Parameters:

match - true to match ingredients with any stock, false to match ingredients with no stock

Compliance:

mandatory - This method must be implemented.

clearStockTerms

void clearStockTerms()

Clears the stock query terms.

Compliance:

mandatory - This method must be implemented.

getIngredientQueryRecord

IngredientQueryRecord getIngredientQueryRecord(Type ingredientRecordType)
                                        throws OperationFailedException

Gets the ingredient query record corresponding to the given Ingredient record Type. Multiple record retrievals produce a nested OR term.

Parameters:

ingredientRecordType - an ingredient record type

Returns:

the ingredient query record

Throws:

NullArgumentException - ingredientRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ingredientRecordType) is false

Compliance:

mandatory - This method must be implemented.