org.osid.recipe

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

Methods

Modifier and Type	Method and Description
IngredientQueryInspectorRecord	getIngredientQueryInspectorRecord(Type ingredientRecordType) Gets the ingredient query inspector record corresponding to the given Ingredient record Type.
CardinalRangeTerm[]	getQuanityTerms() Gets the quantity query terms.
IdTerm[]	getStockIdTerms() Gets the stock query terms.
StockQueryInspector[]	getStockTerms() Gets the stock query terms.
TypeTerm[]	getUnitTypeTerms() Gets the unit type query terms.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Method Detail

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 given Ingredient record Type.

Parameters:

ingredientRecordType - an ingredient record type

Returns:

the ingredient query inspector record

Throws:

NullArgumentException - ingredientRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(ingredientRecordType) is false

Compliance:

mandatory - This method must be implemented.