org.osid.contact.rules

Interface ContactEnablerQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidEnablerQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, OsidTemporalQuery, Suppliable

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidEnablerQuery

clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery

Methods inherited from interface org.osid.OsidRuleQuery

clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery

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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchRuledContactId

void matchRuledContactId(Id contactId,
                       boolean match)

Matches enablers mapped to the contact.

Parameters:

contactId - the contact book Id

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

Throws:

NullArgumentException - contactBookId is null

Compliance:

mandatory - This method must be implemented.

clearRuledContactIdTerms

void clearRuledContactIdTerms()

Clears the contact Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledContactQuery

boolean supportsRuledContactQuery()

Tests if a ContactBookQuery is available.

Returns:

true if a contact query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledContactQuery

ContactQuery getRuledContactQuery()

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

Returns:

the address book query

Throws:

UnimplementedException - supportsContactQuery() is false

Compliance:

optional - This method must be implemented if supportsContactQuery() is true.

matchAnyRuledContact

void matchAnyRuledContact(boolean match)

Matches enablers mapped to any contact.

Parameters:

match - true for enablers mapped to any contact, false to match enablers mapped to no contact

Compliance:

mandatory - This method must be implemented.

clearRuledContactTerms

void clearRuledContactTerms()

Clears the contact query terms.

Compliance:

mandatory - This method must be implemented.

matchAddressBookId

void matchAddressBookId(Id addressBookId,
                      boolean match)

Matches enablers mapped to the address book.

Parameters:

addressBookId - the address book Id

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

Throws:

NullArgumentException - addressBookId is null

Compliance:

mandatory - This method must be implemented.

clearAddressBookIdTerms

void clearAddressBookIdTerms()

Clears the address book Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAddressBookQuery

boolean supportsAddressBookQuery()

Tests if an AddressBookQuery is available.

Returns:

true if an address book query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAddressBookQuery

AddressBookQuery getAddressBookQuery()

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

Returns:

the address book query

Throws:

UnimplementedException - supportsAddressBookQuery() is false

Compliance:

optional - This method must be implemented if supportsAddressBookQuery() is true.

clearAddressBookTerms

void clearAddressBookTerms()

Clears the address book query terms.

Compliance:

mandatory - This method must be implemented.

getContactEnablerQueryRecord

ContactEnablerQueryRecord getContactEnablerQueryRecord(Type contactEnablerRecordType)
                                                       throws OperationFailedException

Gets the contact enabler query record corresponding to the given ContactEnabler record Type. Multiple record retrievals produce a nested OR term.

Parameters:

contactEnablerRecordType - a contact enabler record type

Returns:

the contact enabler query record

Throws:

NullArgumentException - contactEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(contactEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.