org.osid.financials

Interface BusinessQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface BusinessQueryInspector
extends OsidCatalogQueryInspector

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.
IdTerm[]	getAncestorBusinessIdTerms() Gets the ancestor business Id query terms.
BusinessQueryInspector[]	getAncestorBusinessTerms() Gets the ancestor business query terms.
BusinessQueryInspectorRecord	getBusinessQueryInspectorRecord(Type businessRecordType) Gets the business query inspector record corresponding to the given Business record Type.
IdTerm[]	getDescendantBusinessIdTerms() Gets the descendant business Id query terms.
BusinessQueryInspector[]	getDescendantBusinessTerms() Gets the descendant business query terms.
IdTerm[]	getFiscalPeriodIdTerms() Gets the fiscal period Id query terms.
FiscalPeriodQueryInspector[]	getFiscalPeriodTerms() Gets the fiscal period 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

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

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.

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.

getAncestorBusinessIdTerms

IdTerm[] getAncestorBusinessIdTerms()

Gets the ancestor business Id query terms.

Returns:

the ancestor business Id terms

Compliance:

mandatory - This method must be implemented.

getAncestorBusinessTerms

BusinessQueryInspector[] getAncestorBusinessTerms()

Gets the ancestor business query terms.

Returns:

the ancestor business terms

Compliance:

mandatory - This method must be implemented.

getDescendantBusinessIdTerms

IdTerm[] getDescendantBusinessIdTerms()

Gets the descendant business Id query terms.

Returns:

the descendant business Id terms

Compliance:

mandatory - This method must be implemented.

getDescendantBusinessTerms

BusinessQueryInspector[] getDescendantBusinessTerms()

Gets the descendant business query terms.

Returns:

the descendant business terms

Compliance:

mandatory - This method must be implemented.

getBusinessQueryInspectorRecord

BusinessQueryInspectorRecord getBusinessQueryInspectorRecord(Type businessRecordType)
                                                             throws OperationFailedException

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

Parameters:

businessRecordType - a business record type

Returns:

the business query inspector record

Throws:

NullArgumentException - businessRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(businessRecordType) is false

Compliance:

mandatory - This method must be implemented.