org.osid.financials.posting

Interface PostQueryInspector

All Superinterfaces:

Extensible, OsidAggregateableQueryInspector, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface PostQueryInspector
extends OsidObjectQueryInspector, OsidAggregateableQueryInspector

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.
IdTerm[]	getCorrectedPostIdTerms() Gets the corrected post Id query terms.
PostQueryInspector[]	getCorrectedPostTerms() Gets the corrected post query terms.
DateTimeRangeTerm[]	getDateTerms() Gets the date query terms.
IdTerm[]	getFiscalPeriodIdTerms() Gets the fiscal period Id query terms.
FiscalPeriodQueryInspector[]	getFiscalPeriodTerms() Gets the fiscal period query terms.
BooleanTerm[]	getPostedTerms() Gets the posted query terms.
IdTerm[]	getPostEntryIdTerms() Gets the post entry Id query terms.
PostEntryQueryInspector[]	getPostEntryTerms() Gets the post entry query terms.
PostQueryInspectorRecord	getPostQueryInspectorRecord(Type postRecordType) Gets the post query inspector record corresponding to the given Post record Type.

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

getFiscalPeriodIdTerms

IdTerm[] getFiscalPeriodIdTerms()

Gets the fiscal period Id query terms.

Returns:

the fiscal period Id query terms

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodTerms

FiscalPeriodQueryInspector[] getFiscalPeriodTerms()

Gets the fiscal period query terms.

Returns:

the fiscal period query terms

Compliance:

mandatory - This method must be implemented.

getPostedTerms

BooleanTerm[] getPostedTerms()

Gets the posted query terms.

Returns:

the posted query terms

Compliance:

mandatory - This method must be implemented.

getDateTerms

DateTimeRangeTerm[] getDateTerms()

Gets the date query terms.

Returns:

the date query terms

Compliance:

mandatory - This method must be implemented.

getPostEntryIdTerms

IdTerm[] getPostEntryIdTerms()

Gets the post entry Id query terms.

Returns:

the post entry Id query terms

Compliance:

mandatory - This method must be implemented.

getPostEntryTerms

PostEntryQueryInspector[] getPostEntryTerms()

Gets the post entry query terms.

Returns:

the post entry query terms

Compliance:

mandatory - This method must be implemented.

getCorrectedPostIdTerms

IdTerm[] getCorrectedPostIdTerms()

Gets the corrected post Id query terms.

Returns:

the post Id query terms

Compliance:

mandatory - This method must be implemented.

getCorrectedPostTerms

PostQueryInspector[] getCorrectedPostTerms()

Gets the corrected post query terms.

Returns:

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

getPostQueryInspectorRecord

PostQueryInspectorRecord getPostQueryInspectorRecord(Type postRecordType)
                                                     throws OperationFailedException

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

Parameters:

postRecordType - a post record type

Returns:

the post query inspector record

Throws:

NullArgumentException - postRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(postRecordType) is false

Compliance:

mandatory - This method must be implemented.