public interface AccountQuery extends OsidObjectQuery, OsidFederateableQuery
This is the query for searching accounts. 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 |
clearAncestorAccountIdTerms()
Clears the ancestor account
Id query terms. |
void |
clearAncestorAccountTerms()
Clears the ancestor account query terms.
|
void |
clearBusinessIdTerms()
Clears the business
Id terms. |
void |
clearBusinessTerms()
Clears the business terms.
|
void |
clearCodeTerms()
Clears the code terms.
|
void |
clearCreditBalanceTerms()
Clears the credit balance terms.
|
void |
clearDescendantAccountIdTerms()
Clears the descendant account
Id query terms. |
void |
clearDescendantAccountTerms()
Clears the descendant account query terms.
|
void |
clearSummaryTerms()
Clears the summary terms.
|
AccountQueryRecord |
getAccountQueryRecord(Type accountRecordType)
Gets the account query record corresponding to the given
Account record Type. |
AccountQuery |
getAncestorAccountQuery()
Gets the query for an account.
|
BusinessQuery |
getBusinessQuery()
Gets the query for a business.
|
AccountQuery |
getDescendantAccountQuery()
Gets the query for an account.
|
SummaryQuery |
getSummaryQuery()
Gets the query for a summary.
|
void |
matchAncestorAccountId(Id accountId,
boolean match)
Sets the account
Id for this query to match accounts
that have the specified account as an ancestor. |
void |
matchAnyAncestorAccount(boolean match)
Matches accounts with any account ancestor.
|
void |
matchAnyCode(boolean match)
Matches an account that has any code assigned.
|
void |
matchAnyDescendantAccount(boolean match)
Matches accounts with any account descendant.
|
void |
matchBusinessId(Id businessId,
boolean match)
Sets the business
Id for this query to match accounts
assigned to businesses. |
void |
matchCode(java.lang.String code,
Type stringMatchType,
boolean match)
Matches an account code.
|
void |
matchCreditBalance(boolean match)
Matches accounts that are credit accounts.
|
void |
matchDescendantAccountId(Id accountId,
boolean match)
Sets the account
Id for this query to match accounts
that have the specified account as a descendant. |
boolean |
supportsAncestorAccountQuery()
Tests if an
AccountQuery is available. |
boolean |
supportsBusinessQuery()
Tests if a
BusinessQuery is available. |
boolean |
supportsDescendantAccountQuery()
Tests if an
AccountQuery is available. |
boolean |
supportsSummaryQuery()
Tests if a
SummaryQuery 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
void matchCreditBalance(boolean match)
match
- true
to match accounts that are credit
account, false
to match accounts debit accountsmandatory
- This method must be implemented. void clearCreditBalanceTerms()
mandatory
- This method must be implemented. void matchCode(java.lang.String code, Type stringMatchType, boolean match)
code
- a codestringMatchType
- the string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- code
is not
of stringMatchType
NullArgumentException
- code
is
null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyCode(boolean match)
match
- true
to match accounts with any code,
false
to match accounts with no codemandatory
- This method must be implemented. void clearCodeTerms()
mandatory
- This method must be implemented. boolean supportsSummaryQuery()
SummaryQuery
is available. true
if a summery query is available,
false
otherwisemandatory
- This method must be implemented. SummaryQuery getSummaryQuery()
OR
term.UnimplementedException
- supportsSummeryQuery()
is false
optional
- This method must be implemented if
supportsSupervisorQuery()
is true.
void clearSummaryTerms()
mandatory
- This method must be implemented. void matchAncestorAccountId(Id accountId, boolean match)
Id
for this query to match accounts
that have the specified account as an ancestor.accountId
- an account Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- accountId
is
null
mandatory
- This method must be implemented. void clearAncestorAccountIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAncestorAccountQuery()
AccountQuery
is available. true
if an account query is available,
false
otherwisemandatory
- This method must be implemented. AccountQuery getAncestorAccountQuery()
OR
term.UnimplementedException
-
supportsAncestorAccountQuery()
is false
optional
- This method must be implemented if
supportsAncestorAccountQuery()
is true.
void matchAnyAncestorAccount(boolean match)
match
- true
to match accounts with any ancestor,
false
to match root accountsmandatory
- This method must be implemented. void clearAncestorAccountTerms()
mandatory
- This method must be implemented. void matchDescendantAccountId(Id accountId, boolean match)
Id
for this query to match accounts
that have the specified account as a descendant.accountId
- an account Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- accountId
is
null
mandatory
- This method must be implemented. void clearDescendantAccountIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDescendantAccountQuery()
AccountQuery
is available. true
if an account query is available,
false
otherwisemandatory
- This method must be implemented. AccountQuery getDescendantAccountQuery()
OR
term.UnimplementedException
-
supportsDescendantAccountQuery()
is false
optional
- This method must be implemented if
supportsDescendantAccountQuery()
is true.
void matchAnyDescendantAccount(boolean match)
match
- true
to match accounts with any
descendant, false
to match leaf accountsmandatory
- This method must be implemented. void clearDescendantAccountTerms()
mandatory
- This method must be implemented. void matchBusinessId(Id businessId, boolean match)
Id
for this query to match accounts
assigned to businesses.businessId
- the business Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- businessId
is
null
mandatory
- This method must be implemented. void clearBusinessIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsBusinessQuery()
BusinessQuery
is available. true
if a business query is available,
false
otherwisemandatory
- This method must be implemented. BusinessQuery getBusinessQuery()
OR
term.UnimplementedException
- supportsBusinessQuery()
is false
optional
- This method must be implemented if
supportsBusinessQuery()
is true.
void clearBusinessTerms()
mandatory
- This method must be implemented. AccountQueryRecord getAccountQueryRecord(Type accountRecordType) throws OperationFailedException
Account
record Type.
Multiple record retrievals
produce a nested OR
term.accountRecordType
- an account record typeNullArgumentException
- accountRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(accountRecordType)
is false
mandatory
- This method must be implemented.