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.
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. |
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchAccountId(Id accountId, boolean match)
Id
for this query.accountId
- an account Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- accountId
is
null
mandatory
- This method must be implemented. void clearAccountIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAccountQuery()
AccountQuery
is available. true
if an account query is available,
false
otherwisemandatory
- This method must be implemented. AccountQuery getAccountQuery()
OR
term.UnimplementedException
- supportsAccountQuery()
is false
optional
- This method must be implemented if
supportsAccountQuery()
is true.
void matchAnyAccount(boolean match)
match
- true
to match businesses with any
account, false
to match businesses with no
accountsmandatory
- This method must be implemented. void clearAccountTerms()
mandatory
- This method must be implemented. void matchActivityId(Id activityId, boolean match)
Id
for this query.activityId
- an activity Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- activityId
is
null
mandatory
- This method must be implemented. void clearActivityIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsActivityQuery()
ActivityQuery
is available. true
if an activity query is available,
false
otherwisemandatory
- This method must be implemented. ActivityQuery getActivityQuery()
OR
term.UnimplementedException
- supportsActivityQuery()
is false
optional
- This method must be implemented if
supportsActivityQuery()
is true.
void matchAnyActivity(boolean match)
match
- true
to match businesses with any
activity, false
to match businesses with no
activitiesmandatory
- This method must be implemented. void clearActivityTerms()
mandatory
- This method must be implemented. void matchFiscalPeriodId(Id fiscalPeriodId, boolean match)
Id
for this query.fiscalPeriodId
- a fiscal period Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- fiscalPeriodId
is null
mandatory
- This method must be implemented. void clearFiscalPeriodIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsFiscalPeriodQuery()
FiscalPeriodQuery
is available. true
if a fiscal period query is available,
false
otherwisemandatory
- This method must be implemented. FiscalPeriodQuery getFiscalPeriodQuery()
OR
term.UnimplementedException
-
supportsFiscalPeriodQuery()
is false
optional
- This method must be implemented if
supportsFiscalPeriodQuery()
is true.
void matchAnyFiscalPeriod(boolean match)
match
- true
to match businesses with any fiscal
period, false
to match businesses with no
fiscal periodmandatory
- This method must be implemented. void clearFiscalPeriodTerms()
mandatory
- This method must be implemented. void matchAncestorBusinessId(Id businessId, boolean match)
Id
for this query to match businesses
that have the specified business as an ancestor.businessId
- a business Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- businessId
is
null
mandatory
- This method must be implemented. void clearAncestorBusinessIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAncestorBusinessQuery()
BusinessQuery
is available. true
if a business query is available,
false
otherwisemandatory
- This method must be implemented. BusinessQuery getAncestorBusinessQuery()
OR
term.UnimplementedException
-
supportsAncestorBusinessQuery()
is false
optional
- This method must be implemented if
supportsAncestorBusinessQuery()
is true.
void matchAnyAncestorBusiness(boolean match)
match
- true
to match businesses with any
ancestor, false
to match root businessesmandatory
- This method must be implemented. void clearAncestorBusinessTerms()
mandatory
- This method must be implemented. void matchDescendantBusinessId(Id businessId, boolean match)
Id
for this query to match businesses
that have the specified business as an descendant.businessId
- a business Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- businessId
is
null
mandatory
- This method must be implemented. void clearDescendantBusinessIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDescendantBusinessQuery()
BusinessQuery
is available. true
if a business query is available,
false
otherwisemandatory
- This method must be implemented. BusinessQuery getDescendantBusinessQuery()
OR
term.UnimplementedException
-
supportsDescendantBusinessQuery()
is false
optional
- This method must be implemented if
supportsDescendantBusinessQuery()
is true.
void matchAnyDescendantBusiness(boolean match)
match
- true
to match businesses with any
descendant, false
to match leaf businessesmandatory
- This method must be implemented. void clearDescendantBusinessTerms()
mandatory
- This method must be implemented. BusinessQueryRecord getBusinessQueryRecord(Type businessRecordType) throws OperationFailedException
Business
record Type.
Multiple record
retrievals produce a nested OR
term.businessRecordType
- a business record typeNullArgumentException
- businessRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(businessRecordType)
is false
mandatory
- This method must be implemented.