OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.BusinessQuery
Implementsosid.OsidCatalogQuery
Description

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

MethodmatchAccountId
Description

Sets the account Id for this query.

Parametersosid.id.IdaccountIdan account Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT accountId is null
CompliancemandatoryThis method must be implemented.
MethodclearAccountIdTerms
Description

Clears the account Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAccountQuery
Description

Tests if an AccountQuery is available.

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

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

Returnosid.financials.AccountQuerythe account query
ErrorsUNIMPLEMENTED supportsAccountQuery() is false
ComplianceoptionalThis method must be implemented if supportsAccountQuery() is true.
MethodmatchAnyAccount
Description

Matches businesses that have any account.

Parametersbooleanmatch true to match businesses with any account, false to match businesses with no accounts
CompliancemandatoryThis method must be implemented.
MethodclearAccountTerms
Description

Clears the account query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchActivityId
Description

Sets the activity Id for this query.

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

Clears the activity Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsActivityQuery
Description

Tests if an ActivityQuery is available.

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

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

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

Matches businesses that have any activity.

Parametersbooleanmatch true to match businesses with any activity, false to match businesses with no activities
CompliancemandatoryThis method must be implemented.
MethodclearActivityTerms
Description

Clears the activity query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchFiscalPeriodId
Description

Sets the fiscal period Id for this query.

Parametersosid.id.IdfiscalPeriodIda fiscal period Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT fiscalPeriodId is null
CompliancemandatoryThis method must be implemented.
MethodclearFiscalPeriodIdTerms
Description

Clears the fiscal period Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsFiscalPeriodQuery
Description

Tests if a FiscalPeriodQuery is available.

Returnboolean true if a fiscal period query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetFiscalPeriodQuery
Description

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

Returnosid.financials.FiscalPeriodQuerythe fiscal period query
ErrorsUNIMPLEMENTED supportsFiscalPeriodQuery() is false
ComplianceoptionalThis method must be implemented if supportsFiscalPeriodQuery() is true.
MethodmatchAnyFiscalPeriod
Description

Matches businesses that have any fiscal period.

Parametersbooleanmatch true to match businesses with any fiscal period, false to match businesses with no fiscal period
CompliancemandatoryThis method must be implemented.
MethodclearFiscalPeriodTerms
Description

Clears the fiscal period query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorBusinessId
Description

Sets the business Id for this query to match businesses that have the specified business as an ancestor.

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

Clears the ancestor business Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorBusinessQuery
Description

Tests if a BusinessQuery is available.

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

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

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

Matches businesses with any business ancestor.

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

Clears the ancestor business query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantBusinessId
Description

Sets the business Id for this query to match businesses that have the specified business as an descendant.

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

Clears the descendant business Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantBusinessQuery
Description

Tests if a BusinessQuery is available.

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

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

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

Matches agencies with any descendant business.

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

Clears the descendant business query terms.

CompliancemandatoryThis method must be implemented.
MethodgetBusinessQueryRecord
Description

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

Parametersosid.type.TypebusinessRecordTypea business record type
Returnosid.financials.records.BusinessQueryRecordthe business query record
ErrorsNULL_ARGUMENT businessRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(businessRecordType) is false
CompliancemandatoryThis method must be implemented.