public interface CustomerQuery extends OsidObjectQuery, OsidTemporalQuery
This is the query for searching customers. 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 |
clearActivityIdTerms()
Clears the activity
Id terms. |
void |
clearActivityTerms()
Clears the activity terms.
|
void |
clearBusinessIdTerms()
Clears the business
Id terms. |
void |
clearBusinessTerms()
Clears the business terms.
|
void |
clearCustomerNumberTerms()
Clears the customer number.
|
void |
clearResourceIdTerms()
Clears the resource
Id terms. |
void |
clearResourceTerms()
Clears the resource terms.
|
ActivityQuery |
getActivityQuery()
Gets the query for an activity.
|
BusinessQuery |
getBusinessQuery()
Gets the query for a business.
|
CustomerQueryRecord |
getCustomerQueryRecord(Type customerRecordType)
Gets the customer query record corresponding to the given
Customer record Type. |
ResourceQuery |
getResourceQuery()
Gets the query for a resource.
|
void |
matchActivityId(Id activityId,
boolean match)
Sets the activity
Id for this query to match customers
that have a financial activity. |
void |
matchAnyActivity(boolean match)
Matches customers that have any financial activity.
|
void |
matchAnyCustomerNumber(boolean match)
Matches customers with any number.
|
void |
matchBusinessId(Id businessId,
boolean match)
Sets the business
Id for this query to match customers
assigned to businesses. |
void |
matchCustomerNumber(java.lang.String number,
Type stringMatchType,
boolean match)
Matches customer numbers.
|
void |
matchResourceId(Id resourceId,
boolean match)
Sets the resource
Id for this query. |
boolean |
supportsActivityQuery()
Tests if an
ActivityQuery is available. |
boolean |
supportsBusinessQuery()
Tests if a
BusinessQuery is available. |
boolean |
supportsResourceQuery()
Tests if a
ResourceQuery 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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchResourceId(Id resourceId, boolean match)
Id
for this query.resourceId
- a resource Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearResourceIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsResourceQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getResourceQuery()
OR
term.UnimplementedException
- supportsResourceQuery()
is false
optional
- This method must be implemented if
supportsResourceQuery()
is true.
void clearResourceTerms()
mandatory
- This method must be implemented. void matchCustomerNumber(java.lang.String number, Type stringMatchType, boolean match)
number
- a customer numberstringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- number
not of
stringMatchType
NullArgumentException
- number
or
stringMatchType
is null
mandatory
- This method must be implemented. void matchAnyCustomerNumber(boolean match)
match
- true
to match customers with any number,
false
to match customers with no numbermandatory
- This method must be implemented. void clearCustomerNumberTerms()
mandatory
- This method must be implemented. void matchActivityId(Id activityId, boolean match)
Id
for this query to match customers
that have a financial activity.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
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 customers with any
activity, false
to match customers with no
activitymandatory
- This method must be implemented. void clearActivityTerms()
mandatory
- This method must be implemented. void matchBusinessId(Id businessId, boolean match)
Id
for this query to match customers
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. CustomerQueryRecord getCustomerQueryRecord(Type customerRecordType) throws OperationFailedException
Customer
record Type.
Multiple record
retrievals produce a nested OR
term.customerRecordType
- a customer record typeNullArgumentException
- customerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(customerRecordType)
is false
mandatory
- This method must be implemented.