org.osid.ordering

Interface StoreQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface StoreQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining store queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorStoreIdTerms() Gets the ancestor store Id terms.
StoreQueryInspector[]	getAncestorStoreTerms() Gets the ancestor store terms.
IdTerm[]	getDescendantStoreIdTerms() Gets the descendant store Id terms.
StoreQueryInspector[]	getDescendantStoreTerms() Gets the descendant store terms.
IdTerm[]	getOrderIdTerms() Gets the order Id terms.
OrderQueryInspector[]	getOrderTerms() Gets the order terms.
IdTerm[]	getPriceScheduleIdTerms() Gets the price schedule Id terms.
PriceScheduleQueryInspector[]	getPriceScheduleTerms() Gets the price schedule terms.
IdTerm[]	getProductIdTerms() Gets the product Id terms.
ProductQueryInspector[]	getProductTerms() Gets the product terms.
StoreQueryInspectorRecord	getStoreQueryInspectorRecord(Type storeRecordType) Gets the store query inspector record corresponding to the given Store record Type.

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.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

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.

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.

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.

getAncestorStoreIdTerms

IdTerm[] getAncestorStoreIdTerms()

Gets the ancestor store Id terms.

Returns:

the ancestor store Id terms

Compliance:

mandatory - This method must be implemented.

getAncestorStoreTerms

StoreQueryInspector[] getAncestorStoreTerms()

Gets the ancestor store terms.

Returns:

the ancestor store terms

Compliance:

mandatory - This method must be implemented.

getDescendantStoreIdTerms

IdTerm[] getDescendantStoreIdTerms()

Gets the descendant store Id terms.

Returns:

the descendant store Id terms

Compliance:

mandatory - This method must be implemented.

getDescendantStoreTerms

StoreQueryInspector[] getDescendantStoreTerms()

Gets the descendant store terms.

Returns:

the descendant store terms

Compliance:

mandatory - This method must be implemented.

getStoreQueryInspectorRecord

StoreQueryInspectorRecord getStoreQueryInspectorRecord(Type storeRecordType)
                                                       throws OperationFailedException

Gets the store query inspector record corresponding to the given Store record Type.

Parameters:

storeRecordType - a store record type

Returns:

the store query inspector record

Throws:

NullArgumentException - storeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(storeRecordType) is false

Compliance:

mandatory - This method must be implemented.