org.osid.financials.posting

Interface PostEntryQueryInspector

All Superinterfaces:

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

public interface PostEntryQueryInspector
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
IdTerm[]	getAccountIdTerms() Gets the account Id query terms.
AccountQueryInspector[]	getAccountTerms() Gets the account query terms.
IdTerm[]	getActivityIdTerms() Gets the activity Id query terms.
ActivityQueryInspector[]	getActivityTerms() Gets the activity query terms.
CurrencyRangeTerm[]	getAmountTerms() Gets the amount query terms.
IdTerm[]	getBusinessIdTerms() Gets the business Id query terms.
BusinessQueryInspector[]	getBusinessTerms() Gets the business query terms.
BooleanTerm[]	getDebitTerms() Gets the debit query terms.
PostEntryQueryInspectorRecord	getPostEntryQueryInspectorRecord(Type postEntryRecordType) Gets the post entry query inspector record corresponding to the given PostEntry record Type.
IdTerm[]	getPostIdTerms() Gets the post Id query terms.
PostQueryInspector[]	getPostTerms() Gets the post 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

getPostIdTerms

IdTerm[] getPostIdTerms()

Gets the post Id query terms.

Returns:

the post Id query terms

Compliance:

mandatory - This method must be implemented.

getPostTerms

PostQueryInspector[] getPostTerms()

Gets the post query terms.

Returns:

the post query terms

Compliance:

mandatory - This method must be implemented.

getAccountIdTerms

IdTerm[] getAccountIdTerms()

Gets the account Id query terms.

Returns:

the account Id query terms

Compliance:

mandatory - This method must be implemented.

getAccountTerms

AccountQueryInspector[] getAccountTerms()

Gets the account query terms.

Returns:

the account query terms

Compliance:

mandatory - This method must be implemented.

getActivityIdTerms

IdTerm[] getActivityIdTerms()

Gets the activity Id query terms.

Returns:

the activity Id query terms

Compliance:

mandatory - This method must be implemented.

getActivityTerms

ActivityQueryInspector[] getActivityTerms()

Gets the activity query terms.

Returns:

the activity query terms

Compliance:

mandatory - This method must be implemented.

getAmountTerms

CurrencyRangeTerm[] getAmountTerms()

Gets the amount query terms.

Returns:

the date range query terms

Compliance:

mandatory - This method must be implemented.

getDebitTerms

BooleanTerm[] getDebitTerms()

Gets the debit query terms.

Returns:

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

getPostEntryQueryInspectorRecord

PostEntryQueryInspectorRecord getPostEntryQueryInspectorRecord(Type postEntryRecordType)
                                                               throws OperationFailedException

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

Parameters:

postEntryRecordType - a post entry record type

Returns:

the post entry query inspector record

Throws:

NullArgumentException - postEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(postEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.