org.osid.contact

Interface ContactQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable

public interface ContactQuery
extends OsidRelationshipQuery

This is the query for searching contacts. Each method 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 terms.
void	clearAddressBookTerms() Clears the address book terms.
void	clearAddresseeIdTerms() Clears the resource Id terms.
void	clearAddresseeTerms() Clears the resource terms.
void	clearAddressIdTerms() Clears the address Id terms.
void	clearAddressTerms() Clears the address terms.
void	clearReferenceIdTerms() Clears the reference Id terms.
AddressBookQuery	getAddressBookQuery() Gets the query for an address book query.
ResourceQuery	getAddresseeQuery() Gets the query for a resource query.
AddressQuery	getAddressQuery() Gets the query for an address query.
ContactQueryRecord	getContactQueryRecord(Type contactRecordType) Gets the contact query record corresponding to the given Contact record Type.
void	matchAddressBookId(Id addressBookId, boolean match) Sets the address Id for this query to match contacts assigned to address books.
void	matchAddresseeId(Id resourceId, boolean match) Sets a resource Id.
void	matchAddressId(Id addressId, boolean match) Sets an address Id.
void	matchReferenceId(Id referenceId, boolean match) Sets a reference Id.
boolean	supportsAddressBookQuery() Tests if an AddressBookQuery is available.
boolean	supportsAddresseeQuery() Tests if a ResourceQuery is available.
boolean	supportsAddressQuery() Tests if an AddressQuery is available.

Methods inherited from interface org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

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.OsidTemporalQuery

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

Method Detail

matchReferenceId

void matchReferenceId(Id referenceId,
                    boolean match)

Sets a reference Id.

Parameters:

referenceId - a reference Id

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

Throws:

NullArgumentException - referenceId is null

Compliance:

mandatory - This method must be implemented.

clearReferenceIdTerms

void clearReferenceIdTerms()

Clears the reference Id terms.

Compliance:

mandatory - This method must be implemented.

matchAddresseeId

void matchAddresseeId(Id resourceId,
                    boolean match)

Sets a resource Id.

Parameters:

resourceId - a resource Id

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

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearAddresseeIdTerms

void clearAddresseeIdTerms()

Clears the resource Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAddresseeQuery

boolean supportsAddresseeQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAddresseeQuery

ResourceQuery getAddresseeQuery()

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

Returns:

the resource query

Throws:

UnimplementedException - supportsAddresseeQuery() is false

Compliance:

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

clearAddresseeTerms

void clearAddresseeTerms()

Clears the resource terms.

Compliance:

mandatory - This method must be implemented.

matchAddressId

void matchAddressId(Id addressId,
                  boolean match)

Sets an address Id.

Parameters:

addressId - an address Id

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

Throws:

NullArgumentException - addressId is null

Compliance:

mandatory - This method must be implemented.

clearAddressIdTerms

void clearAddressIdTerms()

Clears the address Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAddressQuery

boolean supportsAddressQuery()

Tests if an AddressQuery is available.

Returns:

true if an address query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAddressQuery

AddressQuery getAddressQuery()

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

Returns:

the address query

Throws:

UnimplementedException - supportsAddressQuery() is false

Compliance:

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

clearAddressTerms

void clearAddressTerms()

Clears the address terms.

Compliance:

mandatory - This method must be implemented.

matchAddressBookId

void matchAddressBookId(Id addressBookId,
                      boolean match)

Sets the address Id for this query to match contacts assigned to address books.

Parameters:

addressBookId - an 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 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 query. 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 terms.

Compliance:

mandatory - This method must be implemented.

getContactQueryRecord

ContactQueryRecord getContactQueryRecord(Type contactRecordType)
                                         throws OperationFailedException

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

Parameters:

contactRecordType - a contact record type

Returns:

the contact query record

Throws:

NullArgumentException - contactRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(contactRecordType) is false

Compliance:

mandatory - This method must be implemented.