org.osid.inventory.shipment

Interface EntryQueryInspector

All Superinterfaces:

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

public interface EntryQueryInspector
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
EntryQueryInspectorRecord	getEntryQueryInspectorRecord(Type entryRecordType) Gets the entry query inspector record corresponding to the given Entry record Type.
IdTerm[]	getItemIdTerms() Gets the item Id query terms.
ItemQueryInspector[]	getItemTerms() Gets the item query terms.
IdTerm[]	getModelIdTerms() Gets the model Id query terms.
ModelQueryInspector[]	getModelTerms() Gets the model query terms.
DecimalRangeTerm[]	getQuantityTerms() Gets the quantity terms.
IdTerm[]	getStockIdTerms() Gets the stock Id query terms.
StockQueryInspector[]	getStockTerms() Gets the stock query terms.
TypeTerm[]	getUnitTypeTerms() Gets the amount 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.

getModelIdTerms

IdTerm[] getModelIdTerms()

Gets the model Id query terms.

Returns:

the model Id query terms

Compliance:

mandatory - This method must be implemented.

getModelTerms

ModelQueryInspector[] getModelTerms()

Gets the model query terms.

Returns:

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

getQuantityTerms

DecimalRangeTerm[] getQuantityTerms()

Gets the quantity terms.

Returns:

the quantity terms

Compliance:

mandatory - This method must be implemented.

getUnitTypeTerms

TypeTerm[] getUnitTypeTerms()

Gets the amount query terms.

Returns:

the unit type 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.

getEntryQueryInspectorRecord

EntryQueryInspectorRecord getEntryQueryInspectorRecord(Type entryRecordType)
                                                       throws OperationFailedException

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

Parameters:

entryRecordType - an entry record type

Returns:

the entry query inspector record

Throws:

NullArgumentException - entryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(entryRecordType) is false

Compliance:

mandatory - This method must be implemented.