org.osid.ordering

Interface ItemQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface ItemQueryInspector
extends OsidRelationshipQueryInspector

This is the query inspector for examining item queries.

Method Summary

Methods

Modifier and Type	Method and Description
CurrencyRangeTerm[]	getCostTerms() Gets the cost terms.
BooleanTerm[]	getDerivedTerms() Gets the derived terms.
ItemQueryInspectorRecord	getItemQueryInspectorRecord(Type itemRecordType) Gets the item query inspector record corresponding to the given Item record Type.
CurrencyTerm[]	getMinimumCostTerms() Gets the minimum cost terms.
IdTerm[]	getOrderIdTerms() Gets the order Id terms.
OrderQueryInspector[]	getOrderTerms() Gets the order terms.
IdTerm[]	getProductIdTerms() Gets the product Id terms.
ProductQueryInspector[]	getProductTerms() Gets the product terms.
CardinalRangeTerm[]	getQuantityTerms() Gets the quantity terms.
IdTerm[]	getStoreIdTerms() Gets the store Id terms.
StoreQueryInspector[]	getStoreTerms() Gets the store terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

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

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getOrderIdTerms

IdTerm[] getOrderIdTerms()

Gets the order Id terms.

Returns:

the order Id terms

Compliance:

mandatory - This method must be implemented.

getOrderTerms

OrderQueryInspector[] getOrderTerms()

Gets the order terms.

Returns:

the order terms

Compliance:

mandatory - This method must be implemented.

getDerivedTerms

BooleanTerm[] getDerivedTerms()

Gets the derived terms.

Returns:

the derived terms

Compliance:

mandatory - This method must be implemented.

getProductIdTerms

IdTerm[] getProductIdTerms()

Gets the product Id terms.

Returns:

the product Id terms

Compliance:

mandatory - This method must be implemented.

getProductTerms

ProductQueryInspector[] getProductTerms()

Gets the product terms.

Returns:

the product terms

Compliance:

mandatory - This method must be implemented.

getQuantityTerms

CardinalRangeTerm[] getQuantityTerms()

Gets the quantity terms.

Returns:

the quantity terms

Compliance:

mandatory - This method must be implemented.

getCostTerms

CurrencyRangeTerm[] getCostTerms()

Gets the cost terms.

Returns:

the cost terms

Compliance:

mandatory - This method must be implemented.

getMinimumCostTerms

CurrencyTerm[] getMinimumCostTerms()

Gets the minimum cost terms.

Returns:

the minimum cost terms

Compliance:

mandatory - This method must be implemented.

getStoreIdTerms

IdTerm[] getStoreIdTerms()

Gets the store Id terms.

Returns:

the store Id terms

Compliance:

mandatory - This method must be implemented.

getStoreTerms

StoreQueryInspector[] getStoreTerms()

Gets the store terms.

Returns:

the store terms

Compliance:

mandatory - This method must be implemented.

getItemQueryInspectorRecord

ItemQueryInspectorRecord getItemQueryInspectorRecord(Type itemRecordType)
                                                     throws OperationFailedException

Gets the item query inspector record corresponding to the given Item record Type.

Parameters:

itemRecordType - an item record type

Returns:

the item query inspector record

Throws:

NullArgumentException - itemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(itemRecordType) is false

Compliance:

mandatory - This method must be implemented.