org.osid.inventory

Interface ModelQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface ModelQueryInspector
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
StringTerm[]	getArchetypeTerms() Gets the archetype query terms.
IdTerm[]	getManufacturerIdTerms() Gets the manufacturer Id query terms.
ResourceQueryInspector[]	getManufacturerTerms() Gets the manufacturer query terms.
ModelQueryInspectorRecord	getModelQueryInspectorRecord(Type modelRecordType) Gets the model query inspector record corresponding to the given Model record Type.
StringTerm[]	getNumberTerms() Gets the model number 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

getManufacturerIdTerms

IdTerm[] getManufacturerIdTerms()

Gets the manufacturer Id query terms.

Returns:

the resource Id query terms

Compliance:

mandatory - This method must be implemented.

getManufacturerTerms

ResourceQueryInspector[] getManufacturerTerms()

Gets the manufacturer query terms.

Returns:

the resource query terms

Compliance:

mandatory - This method must be implemented.

getArchetypeTerms

StringTerm[] getArchetypeTerms()

Gets the archetype query terms.

Returns:

the archetype query terms

Compliance:

mandatory - This method must be implemented.

getNumberTerms

StringTerm[] getNumberTerms()

Gets the model number query terms.

Returns:

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

getModelQueryInspectorRecord

ModelQueryInspectorRecord getModelQueryInspectorRecord(Type modelRecordType)
                                                       throws OperationFailedException

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

Parameters:

modelRecordType - a model record type

Returns:

the model query inspector record

Throws:

NullArgumentException - modelRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(modelRecordType) is false

Compliance:

mandatory - This method must be implemented.