public interface ContactEnablerQuery extends OsidEnablerQuery
This is the query for searching contact enablers. 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 |
clearAddressBookIdTerms()
Clears the address book
Id query terms. |
void |
clearAddressBookTerms()
Clears the address book query terms.
|
void |
clearRuledContactIdTerms()
Clears the contact
Id query terms. |
void |
clearRuledContactTerms()
Clears the contact query terms.
|
AddressBookQuery |
getAddressBookQuery()
Gets the query for an address book.
|
ContactEnablerQueryRecord |
getContactEnablerQueryRecord(Type contactEnablerRecordType)
Gets the contact enabler query record corresponding to the given
ContactEnabler record Type. |
ContactQuery |
getRuledContactQuery()
Gets the query for a contact.
|
void |
matchAddressBookId(Id addressBookId,
boolean match)
Matches enablers mapped to the address book.
|
void |
matchAnyRuledContact(boolean match)
Matches enablers mapped to any contact.
|
void |
matchRuledContactId(Id contactId,
boolean match)
Matches enablers mapped to the contact.
|
boolean |
supportsAddressBookQuery()
Tests if an
AddressBookQuery is available. |
boolean |
supportsRuledContactQuery()
Tests if a
ContactBookQuery is available. |
clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery
clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery
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
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchRuledContactId(Id contactId, boolean match)
contactId
- the contact book Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- contactBookId
is
null
mandatory
- This method must be implemented. void clearRuledContactIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledContactQuery()
ContactBookQuery
is available. true
if a contact query is available,
false
otherwisemandatory
- This method must be implemented. ContactQuery getRuledContactQuery()
OR
term.UnimplementedException
- supportsContactQuery()
is false
optional
- This method must be implemented if
supportsContactQuery()
is true.
void matchAnyRuledContact(boolean match)
match
- true
for enablers mapped to any contact,
false
to match enablers mapped to no contactmandatory
- This method must be implemented. void clearRuledContactTerms()
mandatory
- This method must be implemented. void matchAddressBookId(Id addressBookId, boolean match)
addressBookId
- the address book Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- addressBookId
is
null
mandatory
- This method must be implemented. void clearAddressBookIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAddressBookQuery()
AddressBookQuery
is available. true
if an address book query is available,
false
otherwisemandatory
- This method must be implemented. AddressBookQuery getAddressBookQuery()
OR
term.UnimplementedException
-
supportsAddressBookQuery()
is false
optional
- This method must be implemented if
supportsAddressBookQuery()
is true.
void clearAddressBookTerms()
mandatory
- This method must be implemented. ContactEnablerQueryRecord getContactEnablerQueryRecord(Type contactEnablerRecordType) throws OperationFailedException
ContactEnabler
record Type.
Multiple
record retrievals produce a nested OR
term.contactEnablerRecordType
- a contact enabler record typeNullArgumentException
- contactEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(contactEnablerRecordType)
is
false
mandatory
- This method must be implemented.