org.osid.financials

Interface BusinessQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface BusinessQuery
extends OsidCatalogQuery

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.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAccountIdTerms() Clears the account Id query terms.
void	clearAccountTerms() Clears the account query terms.
void	clearActivityIdTerms() Clears the activity Id query terms.
void	clearActivityTerms() Clears the activity query terms.
void	clearAncestorBusinessIdTerms() Clears the ancestor business Id query terms.
void	clearAncestorBusinessTerms() Clears the ancestor business query terms.
void	clearDescendantBusinessIdTerms() Clears the descendant business Id query terms.
void	clearDescendantBusinessTerms() Clears the descendant business query terms.
void	clearFiscalPeriodIdTerms() Clears the fiscal period Id query terms.
void	clearFiscalPeriodTerms() Clears the fiscal period query terms.
AccountQuery	getAccountQuery() Gets the query for an account.
ActivityQuery	getActivityQuery() Gets the query for an activity.
BusinessQuery	getAncestorBusinessQuery() Gets the query for a business.
BusinessQueryRecord	getBusinessQueryRecord(Type businessRecordType) Gets the business query record corresponding to the given Business record Type.
BusinessQuery	getDescendantBusinessQuery() Gets the query for a business.
FiscalPeriodQuery	getFiscalPeriodQuery() Gets the query for a fiscal period.
void	matchAccountId(Id accountId, boolean match) Sets the account Id for this query.
void	matchActivityId(Id activityId, boolean match) Sets the activity Id for this query.
void	matchAncestorBusinessId(Id businessId, boolean match) Sets the business Id for this query to match businesses that have the specified business as an ancestor.
void	matchAnyAccount(boolean match) Matches businesses that have any account.
void	matchAnyActivity(boolean match) Matches businesses that have any activity.
void	matchAnyAncestorBusiness(boolean match) Matches businesses with any business ancestor.
void	matchAnyDescendantBusiness(boolean match) Matches agencies with any descendant business.
void	matchAnyFiscalPeriod(boolean match) Matches businesses that have any fiscal period.
void	matchDescendantBusinessId(Id businessId, boolean match) Sets the business Id for this query to match businesses that have the specified business as an descendant.
void	matchFiscalPeriodId(Id fiscalPeriodId, boolean match) Sets the fiscal period Id for this query.
boolean	supportsAccountQuery() Tests if an AccountQuery is available.
boolean	supportsActivityQuery() Tests if an ActivityQuery is available.
boolean	supportsAncestorBusinessQuery() Tests if a BusinessQuery is available.
boolean	supportsDescendantBusinessQuery() Tests if a BusinessQuery is available.
boolean	supportsFiscalPeriodQuery() Tests if a FiscalPeriodQuery is available.

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

matchAccountId

void matchAccountId(Id accountId,
                  boolean match)

Sets the account Id for this query.

Parameters:

accountId - an account Id

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - accountId is null

Compliance:

mandatory - This method must be implemented.

clearAccountIdTerms

void clearAccountIdTerms()

Clears the account Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAccountQuery

boolean supportsAccountQuery()

Tests if an AccountQuery is available.

Returns:

true if an account query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAccountQuery

AccountQuery getAccountQuery()

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

Returns:

the account query

Throws:

UnimplementedException - supportsAccountQuery() is false

Compliance:

optional - This method must be implemented if supportsAccountQuery() is true.

matchAnyAccount

void matchAnyAccount(boolean match)

Matches businesses that have any account.

Parameters:

match - true to match businesses with any account, false to match businesses with no accounts

Compliance:

mandatory - This method must be implemented.

clearAccountTerms

void clearAccountTerms()

Clears the account query terms.

Compliance:

mandatory - This method must be implemented.

matchActivityId

void matchActivityId(Id activityId,
                   boolean match)

Sets the activity Id for this query.

Parameters:

activityId - an activity Id

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - activityId is null

Compliance:

mandatory - This method must be implemented.

clearActivityIdTerms

void clearActivityIdTerms()

Clears the activity Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsActivityQuery

boolean supportsActivityQuery()

Tests if an ActivityQuery is available.

Returns:

true if an activity query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getActivityQuery

ActivityQuery getActivityQuery()

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

Returns:

the activity query

Throws:

UnimplementedException - supportsActivityQuery() is false

Compliance:

optional - This method must be implemented if supportsActivityQuery() is true.

matchAnyActivity

void matchAnyActivity(boolean match)

Matches businesses that have any activity.

Parameters:

match - true to match businesses with any activity, false to match businesses with no activities

Compliance:

mandatory - This method must be implemented.

clearActivityTerms

void clearActivityTerms()

Clears the activity query terms.

Compliance:

mandatory - This method must be implemented.

matchFiscalPeriodId

void matchFiscalPeriodId(Id fiscalPeriodId,
                       boolean match)

Sets the fiscal period Id for this query.

Parameters:

fiscalPeriodId - a fiscal period Id

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - fiscalPeriodId is null

Compliance:

mandatory - This method must be implemented.

clearFiscalPeriodIdTerms

void clearFiscalPeriodIdTerms()

Clears the fiscal period Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsFiscalPeriodQuery

boolean supportsFiscalPeriodQuery()

Tests if a FiscalPeriodQuery is available.

Returns:

true if a fiscal period query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodQuery

FiscalPeriodQuery getFiscalPeriodQuery()

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

Returns:

the fiscal period query

Throws:

UnimplementedException - supportsFiscalPeriodQuery() is false

Compliance:

optional - This method must be implemented if supportsFiscalPeriodQuery() is true.

matchAnyFiscalPeriod

void matchAnyFiscalPeriod(boolean match)

Matches businesses that have any fiscal period.

Parameters:

match - true to match businesses with any fiscal period, false to match businesses with no fiscal period

Compliance:

mandatory - This method must be implemented.

clearFiscalPeriodTerms

void clearFiscalPeriodTerms()

Clears the fiscal period query terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorBusinessId

void matchAncestorBusinessId(Id businessId,
                           boolean match)

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

Parameters:

businessId - a business Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - businessId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorBusinessIdTerms

void clearAncestorBusinessIdTerms()

Clears the ancestor business Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorBusinessQuery

boolean supportsAncestorBusinessQuery()

Tests if a BusinessQuery is available.

Returns:

true if a business query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorBusinessQuery

BusinessQuery getAncestorBusinessQuery()

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

Returns:

the business query

Throws:

UnimplementedException - supportsAncestorBusinessQuery() is false

Compliance:

optional - This method must be implemented if supportsAncestorBusinessQuery() is true.

matchAnyAncestorBusiness

void matchAnyAncestorBusiness(boolean match)

Matches businesses with any business ancestor.

Parameters:

match - true to match businesses with any ancestor, false to match root businesses

Compliance:

mandatory - This method must be implemented.

clearAncestorBusinessTerms

void clearAncestorBusinessTerms()

Clears the ancestor business query terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantBusinessId

void matchDescendantBusinessId(Id businessId,
                             boolean match)

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

Parameters:

businessId - a business Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - businessId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantBusinessIdTerms

void clearDescendantBusinessIdTerms()

Clears the descendant business Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantBusinessQuery

boolean supportsDescendantBusinessQuery()

Tests if a BusinessQuery is available.

Returns:

true if a business query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantBusinessQuery

BusinessQuery getDescendantBusinessQuery()

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

Returns:

the business query

Throws:

UnimplementedException - supportsDescendantBusinessQuery() is false

Compliance:

optional - This method must be implemented if supportsDescendantBusinessQuery() is true.

matchAnyDescendantBusiness

void matchAnyDescendantBusiness(boolean match)

Matches agencies with any descendant business.

Parameters:

match - true to match businesses with any descendant, false to match leaf businesses

Compliance:

mandatory - This method must be implemented.

clearDescendantBusinessTerms

void clearDescendantBusinessTerms()

Clears the descendant business query terms.

Compliance:

mandatory - This method must be implemented.

getBusinessQueryRecord

BusinessQueryRecord getBusinessQueryRecord(Type businessRecordType)
                                           throws OperationFailedException

Gets the business query 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 record

Throws:

NullArgumentException - businessRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(businessRecordType) is false

Compliance:

mandatory - This method must be implemented.