org.osid.inventory

Interface ItemQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface ItemQueryInspector
extends OsidObjectQueryInspector

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
IdTerm[]	getItemIdTerms() Gets the item Id query terms.
ItemQueryInspectorRecord	getItemQueryInspectorRecord(Type itemRecordType) Gets the item query inspector record corresponding to the given Item record Type.
ItemQueryInspector[]	getItemTerms() Gets the item query terms.
StringTerm[]	getLocationDescriptionTerms() Gets the location description query terms.
IdTerm[]	getLocationIdTerms() Gets the location Id query terms.
LocationQueryInspector[]	getLocationTerms() Gets the location query terms.
StringTerm[]	getPropertyTagTerms() Gets the property tag query terms.
StringTerm[]	getSerialNumberTerms() Gets the serial number query 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.

getPropertyTagTerms

StringTerm[] getPropertyTagTerms()

Gets the property tag query terms.

Returns:

the property tag query terms

Compliance:

mandatory - This method must be implemented.

getSerialNumberTerms

StringTerm[] getSerialNumberTerms()

Gets the serial number query terms.

Returns:

the serial number query terms

Compliance:

mandatory - This method must be implemented.

getLocationDescriptionTerms

StringTerm[] getLocationDescriptionTerms()

Gets the location description query terms.

Returns:

the location description query terms

Compliance:

mandatory - This method must be implemented.

getLocationIdTerms

IdTerm[] getLocationIdTerms()

Gets the location Id query terms.

Returns:

the location Id query terms

Compliance:

mandatory - This method must be implemented.

getLocationTerms

LocationQueryInspector[] getLocationTerms()

Gets the location query terms.

Returns:

the location query terms

Compliance:

mandatory - This method must be implemented.

getItemIdTerms

IdTerm[] getItemIdTerms()

Gets the item Id query terms.

Returns:

the item Id query terms

Compliance:

mandatory - This method must be implemented.

getItemTerms

ItemQueryInspector[] getItemTerms()

Gets the item query terms.

Returns:

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

getItemQueryInspectorRecord

ItemQueryInspectorRecord getItemQueryInspectorRecord(Type itemRecordType)
                                                     throws OperationFailedException

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

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.