Interface AccountQuery

All Superinterfaces:

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

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 .

Method Summary

Modifier and Type	Method	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 .Multiple record retrievals produce a nested OR term.
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(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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Method Details

matchCreditBalance

void matchCreditBalance(boolean match)

Matches accounts that are credit accounts.

Parameters:

match - true to match accounts that are credit account, false to match accounts debit accounts

Compliance:

mandatory - This method must be implemented.

clearCreditBalanceTerms

void clearCreditBalanceTerms()

Clears the credit balance terms.

Compliance:

mandatory - This method must be implemented.

matchCode

void matchCode(String code,
 Type stringMatchType,
 boolean match)

Matches an account code.

Parameters:

code - a code

stringMatchType - the string match type

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

Throws:

InvalidArgumentException - code is not of stringMatchType

NullArgumentException - code is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyCode

void matchAnyCode(boolean match)

Matches an account that has any code assigned.

Parameters:

match - true to match accounts with any code, false to match accounts with no code

Compliance:

mandatory - This method must be implemented.

clearCodeTerms

void clearCodeTerms()

Clears the code terms.

Compliance:

mandatory - This method must be implemented.

supportsSummaryQuery

boolean supportsSummaryQuery()

Tests if a SummaryQuery is available.

Returns:

true if a summery query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSummaryQuery

SummaryQuery getSummaryQuery()

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

Returns:

the summery query

Throws:

UnimplementedException - supportsSummeryQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSupervisorQuery()} is {@code true} .

clearSummaryTerms

void clearSummaryTerms()

Clears the summary terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorAccountId

void matchAncestorAccountId(Id accountId,
 boolean match)

Sets the account Id for this query to match accounts that have the specified account as an ancestor.

Parameters:

accountId - an account Id

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

Throws:

NullArgumentException - accountId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorAccountIdTerms

void clearAncestorAccountIdTerms()

Clears the ancestor account Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorAccountQuery

boolean supportsAncestorAccountQuery()

Tests if an AccountQuery is available.

Returns:

true if an account query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorAccountQuery

AccountQuery getAncestorAccountQuery()

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

Returns:

the account query

Throws:

UnimplementedException - supportsAncestorAccountQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAncestorAccountQuery()} is {@code true} .

matchAnyAncestorAccount

void matchAnyAncestorAccount(boolean match)

Matches accounts with any account ancestor.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAncestorAccountTerms

void clearAncestorAccountTerms()

Clears the ancestor account query terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantAccountId

void matchDescendantAccountId(Id accountId,
 boolean match)

Sets the account Id for this query to match accounts that have the specified account as a descendant.

Parameters:

accountId - an account Id

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

Throws:

NullArgumentException - accountId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantAccountIdTerms

void clearDescendantAccountIdTerms()

Clears the descendant account Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantAccountQuery

boolean supportsDescendantAccountQuery()

Tests if an AccountQuery is available.

Returns:

true if an account query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantAccountQuery

AccountQuery getDescendantAccountQuery()

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

Returns:

the account query

Throws:

UnimplementedException - supportsDescendantAccountQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsDescendantAccountQuery()} is {@code true} .

matchAnyDescendantAccount

void matchAnyDescendantAccount(boolean match)

Matches accounts with any account descendant.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearDescendantAccountTerms

void clearDescendantAccountTerms()

Clears the descendant account query terms.

Compliance:

mandatory - This method must be implemented.

matchBusinessId

void matchBusinessId(Id businessId,
 boolean match)

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

Parameters:

businessId - the 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.

clearBusinessIdTerms

void clearBusinessIdTerms()

Clears the business Id terms.

Compliance:

mandatory - This method must be implemented.

supportsBusinessQuery

boolean supportsBusinessQuery()

Tests if a BusinessQuery is available.

Returns:

true if a business query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBusinessQuery

BusinessQuery getBusinessQuery()

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

Returns:

the business query

Throws:

UnimplementedException - supportsBusinessQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsBusinessQuery()} is {@code true} .

clearBusinessTerms

void clearBusinessTerms()

Clears the business terms.

Compliance:

mandatory - This method must be implemented.

getAccountQueryRecord

AccountQueryRecord getAccountQueryRecord(Type accountRecordType)
                                  throws OperationFailedException

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

Parameters:

accountRecordType - an account record type

Returns:

the account query record

Throws:

NullArgumentException - accountRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(accountRecordType) is false

Compliance:

mandatory - This method must be implemented.