OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.ActivityQuery
Implementsosid.OsidObjectQuery
osid.OsidFederateableQuery
osid.OsidTemporalQuery
Description

This is the query for searching activities. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchOrganizationId
Description

Sets the organization Id for this query.

Parametersosid.id.IdorganizationIda resource Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT organizationId is null
CompliancemandatoryThis method must be implemented.
MethodclearOrganizationIdTerms
Description

Clears the organization Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsOrganizationQuery
Description

Tests if a ResourceQuery is available.

Returnboolean true if an organization query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetOrganizationQuery
Description

Gets the query for an organization. Multiple retrievals produce a nested OR term.

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsOrganizationQuery() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationQuery() is true.
MethodmatchAnyOrganization
Description

Matches an activity that has any organization.

Parametersbooleanmatch true to match activities with any organization, false to match activities with no organization
CompliancemandatoryThis method must be implemented.
MethodclearOrganizationTerms
Description

Clears the organization terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSupervisorId
Description

Sets the supervisor Id for this query.

Parametersosid.id.IdsupervisorIda resource Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT supervisorId is null
CompliancemandatoryThis method must be implemented.
MethodclearSupervisorIdTerms
Description

Clears the supervisor Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSupervisorQuery
Description

Tests if a ResourceQuery is available.

Returnboolean true if a supervisor query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSupervisorQuery
Description

Gets the query for a supervisor. Multiple retrievals produce a nested OR term.

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsSupervisorQuery() is false
ComplianceoptionalThis method must be implemented if supportsSupervisorQuery() is true.
MethodmatchAnySupervisor
Description

Matches an activity that has any supervisor.

Parametersbooleanmatch true to match activities with any supervisor, false to match activities with no supervisor
CompliancemandatoryThis method must be implemented.
MethodclearSupervisorTerms
Description

Clears the supervisor terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCode
Description

Matches an activity code.

Parametersstringcodea code
osid.type.TypestringMatchTypethe string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT code is not of stringMatchType
NULL_ARGUMENT code is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyCode
Description

Matches an activity that has any code assigned.

Parametersbooleanmatch true to match activities with any code, false to match activities with no code
CompliancemandatoryThis method must be implemented.
MethodclearCodeTerms
Description

Clears the code terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSummaryQuery
Description

Tests if a SummaryQuery is available.

Returnboolean true if a summery query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSummaryQuery
Description

Gets the query for a summary. Multiple retrievals produce a nested OR term.

Returnosid.financials.SummaryQuerythe summery query
ErrorsUNIMPLEMENTED supportsSummeryQuery() is false
ComplianceoptionalThis method must be implemented if supportsSupervisorQuery() is true.
MethodclearSummaryTerms
Description

Clears the summary terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorActivityId
Description

Sets the activity Id for this query to match activities that have the specified activity as an ancestor.

Parametersosid.id.IdactivityIdan activity Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT activityId is null
CompliancemandatoryThis method must be implemented.
MethodclearAncestorActivityIdTerms
Description

Clears the ancestor activity Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorActivityQuery
Description

Tests if an ActivityQuery is available.

Returnboolean true if an activity query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAncestorActivityQuery
Description

Gets the query for an activity. Multiple retrievals produce a nested OR term.

Returnosid.financials.ActivityQuerythe activity query
ErrorsUNIMPLEMENTED supportsAncestorActivityQuery() is false
ComplianceoptionalThis method must be implemented if supportsAncestorActivityQuery() is true.
MethodmatchAnyAncestorActivity
Description

Matches activities with any activity ancestor.

Parametersbooleanmatch true to match activities with any ancestor, false to match root activities
CompliancemandatoryThis method must be implemented.
MethodclearAncestorActivityTerms
Description

Clears the ancestor activity query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantActivityId
Description

Sets the activity Id for this query to match activities that have the specified activity as a descendant.

Parametersosid.id.IdactivityIdan activity Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT activityId is null
CompliancemandatoryThis method must be implemented.
MethodclearDescendantActivityIdTerms
Description

Clears the descendant activity Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantActivityQuery
Description

Tests if an ActivityQuery is available.

Returnboolean true if an activity query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDescendantActivityQuery
Description

Gets the query for an activity. Multiple retrievals produce a nested OR term.

Returnosid.financials.ActivityQuerythe activity query
ErrorsUNIMPLEMENTED supportsDescendantActivityQuery() is false
ComplianceoptionalThis method must be implemented if supportsDescendantActivityQuery() is true.
MethodmatchAnyDescendantActivity
Description

Matches activities with any activity descendant.

Parametersbooleanmatch true to match activities with any descendant, false to match leaf activities
CompliancemandatoryThis method must be implemented.
MethodclearDescendantActivityTerms
Description

Clears the descendant activity query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBusinessId
Description

Sets the business Id for this query to match activities assigned to businesses.

Parametersosid.id.IdbusinessIdthe business Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT businessId is null
CompliancemandatoryThis method must be implemented.
MethodclearBusinessIdTerms
Description

Clears the business Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsBusinessQuery
Description

Tests if a BusinessQuery is available.

Returnboolean true if a business query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBusinessQuery
Description

Gets the query for a business. Multiple retrievals produce a nested OR term.

Returnosid.financials.BusinessQuerythe business query
ErrorsUNIMPLEMENTED supportsBusinessQuery() is false
ComplianceoptionalThis method must be implemented if supportsBusinessQuery() is true.
MethodclearBusinessTerms
Description

Clears the business terms.

CompliancemandatoryThis method must be implemented.
MethodgetActivityQueryRecord
Description

Gets the activity query 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.ActivityQueryRecordthe activity query record
ErrorsNULL_ARGUMENT activityRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(activityRecordType) is false
CompliancemandatoryThis method must be implemented.