org.osid.ordering

Interface ProductQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface ProductQueryInspector
extends OsidObjectQueryInspector

This is the query inspector for examining product queries.

Method Summary

Methods

Modifier and Type	Method and Description
CardinalRangeTerm[]	getAvailabilityTerms() Gets the availability terms.
StringTerm[]	getCodeTerms() Gets the code terms.
IdTerm[]	getItemIdTerms() Gets the item Id terms.
ItemQueryInspector[]	getItemTerms() Gets the item terms.
IdTerm[]	getPriceScheduleIdTerms() Gets the price schedule Id terms.
PriceScheduleQueryInspector[]	getPriceScheduleTerms() Gets the price schedule terms.
ProductQueryInspectorRecord	getProductQueryInspectorRecord(Type productRecordType) Gets the product query inspector record corresponding to the given Product record Type.
IdTerm[]	getStoreIdTerms() Gets the store Id terms.
StoreQueryInspector[]	getStoreTerms() Gets the store 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

getCodeTerms

StringTerm[] getCodeTerms()

Gets the code terms.

Returns:

the code terms

Compliance:

mandatory - This method must be implemented.

getPriceScheduleIdTerms

IdTerm[] getPriceScheduleIdTerms()

Gets the price schedule Id terms.

Returns:

the price schedule Id terms

Compliance:

mandatory - This method must be implemented.

getPriceScheduleTerms

PriceScheduleQueryInspector[] getPriceScheduleTerms()

Gets the price schedule terms.

Returns:

the price schedule terms

Compliance:

mandatory - This method must be implemented.

getAvailabilityTerms

CardinalRangeTerm[] getAvailabilityTerms()

Gets the availability terms.

Returns:

the availability terms

Compliance:

mandatory - This method must be implemented.

getItemIdTerms

IdTerm[] getItemIdTerms()

Gets the item Id terms.

Returns:

the item Id terms

Compliance:

mandatory - This method must be implemented.

getItemTerms

ItemQueryInspector[] getItemTerms()

Gets the item terms.

Returns:

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

getProductQueryInspectorRecord

ProductQueryInspectorRecord getProductQueryInspectorRecord(Type productRecordType)
                                                           throws OperationFailedException

Gets the product query inspector record corresponding to the given Product record Type.

Parameters:

productRecordType - an product record type

Returns:

the product query inspector record

Throws:

NullArgumentException - productRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(productRecordType) is false

Compliance:

mandatory - This method must be implemented.