org.osid.inventory

Interface InventoryQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSubjugateableQueryInspector

public interface InventoryQueryInspector
extends OsidObjectQueryInspector, OsidSubjugateableQueryInspector

The query inspectors provide a means of accessing the match terms of a query. These interfaces are used to examine the actual query terms used in a search or that may be used to create a smart catalog. Query inspectors may be converted to OsidQuery interfaces for reuse or modification in the search sessions.

Method Summary

Methods

Modifier and Type	Method and Description
DateTimeRangeTerm[]	getDateInclusiveTerms() Gets the date query terms.
DateTimeTerm[]	getDateTerms() Gets the date query terms.
InventoryQueryInspectorRecord	getInventoryQueryInspectorRecord(Type inventoryRecordType) Gets the inventory query inspector record corresponding to the given Inventory record Type.
DecimalRangeTerm[]	getQuantityTerms() Gets the quantity terms.
IdTerm[]	getStockIdTerms() Gets the stock Id query terms.
StockQueryInspector[]	getStockTerms() Gets the stock query terms.
IdTerm[]	getWarehouseIdTerms() Gets the warehouse Id query terms.
WarehouseQueryInspector[]	getWarehouseTerms() Gets the warehouse 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

getStockIdTerms

IdTerm[] getStockIdTerms()

Gets the stock Id query terms.

Returns:

the stock Id query terms

Compliance:

mandatory - This method must be implemented.

getStockTerms

StockQueryInspector[] getStockTerms()

Gets the stock query terms.

Returns:

the stock query terms

Compliance:

mandatory - This method must be implemented.

getDateTerms

DateTimeTerm[] getDateTerms()

Gets the date query terms.

Returns:

the date query terms

Compliance:

mandatory - This method must be implemented.

getDateInclusiveTerms

DateTimeRangeTerm[] getDateInclusiveTerms()

Gets the date query terms.

Returns:

the date range query terms

Compliance:

mandatory - This method must be implemented.

getQuantityTerms

DecimalRangeTerm[] getQuantityTerms()

Gets the quantity terms.

Returns:

the quantity query terms

Compliance:

mandatory - This method must be implemented.

getWarehouseIdTerms

IdTerm[] getWarehouseIdTerms()

Gets the warehouse Id query terms.

Returns:

the warehouse Id query terms

Compliance:

mandatory - This method must be implemented.

getWarehouseTerms

WarehouseQueryInspector[] getWarehouseTerms()

Gets the warehouse query terms.

Returns:

the warehouse query terms

Compliance:

mandatory - This method must be implemented.

getInventoryQueryInspectorRecord

InventoryQueryInspectorRecord getInventoryQueryInspectorRecord(Type inventoryRecordType)
                                                               throws OperationFailedException

Gets the inventory query inspector record corresponding to the given Inventory record Type. Multiple record retrievals produce a nested OR term.

Parameters:

inventoryRecordType - an inventory record type

Returns:

the inventory query inspector record

Throws:

NullArgumentException - inventoryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inventoryRecordType) is false

Compliance:

mandatory - This method must be implemented.