org.osid.billing

Interface CategoryQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface CategoryQueryInspector
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[]	getBusinessIdTerms() Gets the business Id query terms.
BusinessQueryInspector[]	getBusinessTerms() Gets the business query terms.
CategoryQueryInspectorRecord	getCategoryQueryInspectorRecord(Type categoryRecordType) Gets the category query inspector record corresponding to the given Category record Type.
IdTerm[]	getEntryIdTerms() Gets the entry Id query terms.
EntryQueryInspector[]	getEntryTerms() Gets the entry 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

getEntryIdTerms

IdTerm[] getEntryIdTerms()

Gets the entry Id query terms.

Returns:

the entry Id query terms

Compliance:

mandatory - This method must be implemented.

getEntryTerms

EntryQueryInspector[] getEntryTerms()

Gets the entry query terms.

Returns:

the entry query terms

Compliance:

mandatory - This method must be implemented.

getBusinessIdTerms

IdTerm[] getBusinessIdTerms()

Gets the business Id query terms.

Returns:

the business Id query terms

Compliance:

mandatory - This method must be implemented.

getBusinessTerms

BusinessQueryInspector[] getBusinessTerms()

Gets the business query terms.

Returns:

the business query terms

Compliance:

mandatory - This method must be implemented.

getCategoryQueryInspectorRecord

CategoryQueryInspectorRecord getCategoryQueryInspectorRecord(Type categoryRecordType)
                                                             throws OperationFailedException

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

Parameters:

categoryRecordType - a category record type

Returns:

the category query inspector record

Throws:

NullArgumentException - categoryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(categoryRecordType) is false

Compliance:

mandatory - This method must be implemented.