Interface IngredientQueryInspector
- All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSubjugateableQueryInspector
public interface IngredientQueryInspector
extends OsidObjectQueryInspector, OsidSubjugateableQueryInspector
This is the query inspector for examining ingredient queries.
-
Method Summary
Modifier and TypeMethodDescriptiongetIngredientQueryInspectorRecord(Type ingredientRecordType) Gets the ingredient query inspector record corresponding to the givenIngredientrecordType.Gets the quantity query terms.IdTerm[]Gets the stock query terms.Gets the stock query terms.TypeTerm[]Gets the unit type query terms.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface OsidExtensibleQueryInspector
getRecordTypeTermsMethods inherited from interface OsidIdentifiableQueryInspector
getIdTermsMethods inherited from interface OsidObjectQueryInspector
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTermsModifier and TypeMethodDescriptionIdTerm[]Gets the commentIdquery terms.Gets the comment query terms.IdTerm[]Gets the creditIdquery terms.Gets the credit query terms.Gets the description query terms.Gets the display name query terms.TypeTerm[]Gets the genus type query terms.IdTerm[]Gets the journal entryIdquery terms.Gets the journal entry query terms.TypeTerm[]Gets the parent genus type query terms.IdTerm[]Gets the relationshipIdquery terms.IdTerm[]Gets the relationship peerIdquery terms.Gets the relationship query terms.IdTerm[]Gets the stateIdquery terms.Gets the state query terms.Gets the statistic query terms.IdTerm[]Gets the subjectIdquery terms.Gets the subject relevancy query terms.Gets the subject query terms.Methods inherited from interface OsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.
-
Method Details
-
getQuanityTerms
CardinalRangeTerm[] getQuanityTerms()Gets the quantity query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getUnitTypeTerms
TypeTerm[] getUnitTypeTerms()Gets the unit type query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getStockIdTerms
IdTerm[] getStockIdTerms()Gets the stock query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getStockTerms
StockQueryInspector[] getStockTerms()Gets the stock query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getIngredientQueryInspectorRecord
IngredientQueryInspectorRecord getIngredientQueryInspectorRecord(Type ingredientRecordType) throws OperationFailedException, PermissionDeniedException Gets the ingredient query inspector record corresponding to the givenIngredientrecordType.- Parameters:
ingredientRecordType- an ingredient record type- Returns:
- the ingredient query inspector record
- Throws:
NullArgumentException-ingredientRecordTypeisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure occurredUnsupportedException-hasRecordType(ingredientRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-