org.osid.acknowledgement

Interface CreditQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface CreditQueryInspector
extends OsidRelationshipQueryInspector

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[]	getBillingIdTerms() Gets the billing Id query terms.
BillingQueryInspector[]	getBillingTerms() Gets the billing query terms.
CreditQueryInspectorRecord	getCreditQueryInspectorRecord(Type creditRecordType) Gets the credit query inspector record corresponding to the given Credit record Type.
IdTerm[]	getReferenceIdTerms() Gets the reference Id query terms.
IdTerm[]	getResourceIdTerms() Gets the resource Id query terms.
ResourceQueryInspector[]	getResourceTerms() Gets the resource query terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

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

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getReferenceIdTerms

IdTerm[] getReferenceIdTerms()

Gets the reference Id query terms.

Returns:

the reference Id terms

Compliance:

mandatory - This method must be implemented.

getResourceIdTerms

IdTerm[] getResourceIdTerms()

Gets the resource Id query terms.

Returns:

the resource Id terms

Compliance:

mandatory - This method must be implemented.

getResourceTerms

ResourceQueryInspector[] getResourceTerms()

Gets the resource query terms.

Returns:

the resource terms

Compliance:

mandatory - This method must be implemented.

getBillingIdTerms

IdTerm[] getBillingIdTerms()

Gets the billing Id query terms.

Returns:

the billing Id terms

Compliance:

mandatory - This method must be implemented.

getBillingTerms

BillingQueryInspector[] getBillingTerms()

Gets the billing query terms.

Returns:

the billing terms

Compliance:

mandatory - This method must be implemented.

getCreditQueryInspectorRecord

CreditQueryInspectorRecord getCreditQueryInspectorRecord(Type creditRecordType)
                                                         throws OperationFailedException

Gets the credit query inspector record corresponding to the given Credit record Type.

Parameters:

creditRecordType - a credit record type

Returns:

the credit inspector query record

Throws:

NullArgumentException - creditRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(creditRecordType) is false

Compliance:

mandatory - This method must be implemented.