OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.ActivityQueryInspector
Implementsosid.OsidObjectQueryInspector
osid.OsidFederateableQueryInspector
osid.OsidTemporalQueryInspector
Description

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.

MethodgetOrganizationIdTerms
Description

Gets the organization Id query terms.

Returnosid.search.terms.IdTerm[]the organization Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetOrganizationTerms
Description

Gets the organization query terms.

Returnosid.resource.ResourceQueryInspector[]the organization query terms
CompliancemandatoryThis method must be implemented.
MethodgetSupervisorIdTerms
Description

Gets the supervisor Id query terms.

Returnosid.search.terms.IdTerm[]the supervisor Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetSupervisorTerms
Description

Gets the supervisor query terms.

Returnosid.resource.ResourceQueryInspector[]the supervisor query terms
CompliancemandatoryThis method must be implemented.
MethodgetCodeTerms
Description

Gets the code query terms.

Returnosid.search.terms.StringTerm[]the code query terms
CompliancemandatoryThis method must be implemented.
MethodgetSummaryTerms
Description

Gets the summary query terms.

Returnosid.financials.SummaryQueryInspector[]the summary query terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorActivityIdTerms
Description

Gets the ancestor activity Id query terms.

Returnosid.search.terms.IdTerm[]the ancestor activity Id terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorActivityTerms
Description

Gets the ancestor activity query terms.

Returnosid.financials.ActivityQueryInspector[]the ancestor activity terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantActivityIdTerms
Description

Gets the descendant activity Id query terms.

Returnosid.search.terms.IdTerm[]the descendant activity Id terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantActivityTerms
Description

Gets the descendant activity query terms.

Returnosid.financials.ActivityQueryInspector[]the descendant activity terms
CompliancemandatoryThis method must be implemented.
MethodgetBusinessIdTerms
Description

Gets the business Id query terms.

Returnosid.search.terms.IdTerm[]the business Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetBusinessTerms
Description

Gets the business query terms.

Returnosid.financials.BusinessQueryInspector[]the business query terms
CompliancemandatoryThis method must be implemented.
MethodgetActivityQueryInspectorRecord
Description

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

Parametersosid.type.TypeactivityRecordTypean activity record type
Returnosid.financials.records.ActivityQueryInspectorRecordthe activity query inspector record
ErrorsNULL_ARGUMENT activityRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(activityRecordType) is false
CompliancemandatoryThis method must be implemented.