org.osid.financials

Interface ActivityQueryInspector

All Superinterfaces:

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

public interface ActivityQueryInspector
extends OsidObjectQueryInspector, OsidFederateableQueryInspector, OsidTemporalQueryInspector

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
ActivityQueryInspectorRecord	getActivityQueryInspectorRecord(Type activityRecordType) Gets the activity query inspector record corresponding to the given Activity record Type.
IdTerm[]	getAncestorActivityIdTerms() Gets the ancestor activity Id query terms.
ActivityQueryInspector[]	getAncestorActivityTerms() Gets the ancestor activity query terms.
IdTerm[]	getBusinessIdTerms() Gets the business Id query terms.
BusinessQueryInspector[]	getBusinessTerms() Gets the business query terms.
StringTerm[]	getCodeTerms() Gets the code query terms.
IdTerm[]	getDescendantActivityIdTerms() Gets the descendant activity Id query terms.
ActivityQueryInspector[]	getDescendantActivityTerms() Gets the descendant activity query terms.
IdTerm[]	getOrganizationIdTerms() Gets the organization Id query terms.
ResourceQueryInspector[]	getOrganizationTerms() Gets the organization query terms.
SummaryQueryInspector[]	getSummaryTerms() Gets the summary query terms.
IdTerm[]	getSupervisorIdTerms() Gets the supervisor Id query terms.
ResourceQueryInspector[]	getSupervisorTerms() Gets the supervisor 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.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getOrganizationIdTerms

IdTerm[] getOrganizationIdTerms()

Gets the organization Id query terms.

Returns:

the organization Id query terms

Compliance:

mandatory - This method must be implemented.

getOrganizationTerms

ResourceQueryInspector[] getOrganizationTerms()

Gets the organization query terms.

Returns:

the organization query terms

Compliance:

mandatory - This method must be implemented.

getSupervisorIdTerms

IdTerm[] getSupervisorIdTerms()

Gets the supervisor Id query terms.

Returns:

the supervisor Id query terms

Compliance:

mandatory - This method must be implemented.

getSupervisorTerms

ResourceQueryInspector[] getSupervisorTerms()

Gets the supervisor query terms.

Returns:

the supervisor query terms

Compliance:

mandatory - This method must be implemented.

getCodeTerms

StringTerm[] getCodeTerms()

Gets the code query terms.

Returns:

the code query terms

Compliance:

mandatory - This method must be implemented.

getSummaryTerms

SummaryQueryInspector[] getSummaryTerms()

Gets the summary query terms.

Returns:

the summary query terms

Compliance:

mandatory - This method must be implemented.

getAncestorActivityIdTerms

IdTerm[] getAncestorActivityIdTerms()

Gets the ancestor activity Id query terms.

Returns:

the ancestor activity Id terms

Compliance:

mandatory - This method must be implemented.

getAncestorActivityTerms

ActivityQueryInspector[] getAncestorActivityTerms()

Gets the ancestor activity query terms.

Returns:

the ancestor activity terms

Compliance:

mandatory - This method must be implemented.

getDescendantActivityIdTerms

IdTerm[] getDescendantActivityIdTerms()

Gets the descendant activity Id query terms.

Returns:

the descendant activity Id terms

Compliance:

mandatory - This method must be implemented.

getDescendantActivityTerms

ActivityQueryInspector[] getDescendantActivityTerms()

Gets the descendant activity query terms.

Returns:

the descendant activity 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.

getActivityQueryInspectorRecord

ActivityQueryInspectorRecord getActivityQueryInspectorRecord(Type activityRecordType)
                                                             throws OperationFailedException

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

Parameters:

activityRecordType - an activity record type

Returns:

the activity query inspector record

Throws:

NullArgumentException - activityRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityRecordType) is false

Compliance:

mandatory - This method must be implemented.