org.osid.contact

Interface AddressQuery

All Superinterfaces:

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

public interface AddressQuery
extends OsidObjectQuery

This is the query for searching for addresses. 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	clearAddressTextTerms() Clears the text address terms.
void	clearContactIdTerms() Clears the contact Id terms.
void	clearContactTerms() Clears the contact terms.
void	clearResourceIdTerms() Clears the resource Id terms.
void	clearResourceTerms() Clears the resource terms.
AddressBookQuery	getAddressBookQuery() Gets the query for an address book query.
AddressQueryRecord	getAddressQueryRecord(Type addressRecordType) Gets the address query record corresponding to the given Address record Type.
ContactQuery	getContactQuery() Gets the query for an address.
ResourceQuery	getResourceQuery() Gets the query for a resource query.
void	matchAddressBookId(Id addressBookId, boolean match) Sets the address Id for this query to match contacts assigned to address books.
void	matchAddressText(java.lang.String address, Type stringMatchType, boolean match) Matches the address text.
void	matchAnyContact(boolean match) Matches addresses with any contact.
void	matchContactId(Id contactId, boolean match) Sets the contact Id for this query to match contacts assigned to addresses.
void	matchResourceId(Id resourceId, boolean match) Sets a resource Id.
boolean	supportsAddressBookQuery() Tests if an AddressBookQuery is available.
boolean	supportsContactQuery() Tests if a contact query is available.
boolean	supportsResourceQuery() Tests if a ResourceQuery is available.

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

Method Detail

matchResourceId

void matchResourceId(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.

clearResourceIdTerms

void clearResourceIdTerms()

Clears the resource Id terms.

Compliance:

mandatory - This method must be implemented.

supportsResourceQuery

boolean supportsResourceQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceQuery

ResourceQuery getResourceQuery()

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

Returns:

the resource query

Throws:

UnimplementedException - supportsResourceQuery() is false

Compliance:

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

clearResourceTerms

void clearResourceTerms()

Clears the resource terms.

Compliance:

mandatory - This method must be implemented.

matchAddressText

void matchAddressText(java.lang.String address,
                    Type stringMatchType,
                    boolean match)

Matches the address text.

Parameters:

address - the address text

stringMatchType - a string match type

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

Throws:

NullArgumentException - address or stringMatchType is null

Compliance:

mandatory - This method must be implemented.

clearAddressTextTerms

void clearAddressTextTerms()

Clears the text address terms.

Compliance:

mandatory - This method must be implemented.

matchContactId

void matchContactId(Id contactId,
                  boolean match)

Sets the contact Id for this query to match contacts assigned to addresses.

Parameters:

contactId - a contact Id

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

Throws:

NullArgumentException - contactId is null

Compliance:

mandatory - This method must be implemented.

clearContactIdTerms

void clearContactIdTerms()

Clears the contact Id terms.

Compliance:

mandatory - This method must be implemented.

supportsContactQuery

boolean supportsContactQuery()

Tests if a contact query is available.

Returns:

true if a contact query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getContactQuery

ContactQuery getContactQuery()

Gets the query for an address.

Returns:

the contact query

Throws:

UnimplementedException - supportsContactQuery() is false

Compliance:

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

matchAnyContact

void matchAnyContact(boolean match)

Matches addresses with any contact.

Parameters:

match - true to match addresses with any contact, false to match addresses with no contacts

Compliance:

mandatory - This method must be implemented.

clearContactTerms

void clearContactTerms()

Clears the contact 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.

getAddressQueryRecord

AddressQueryRecord getAddressQueryRecord(Type addressRecordType)
                                         throws OperationFailedException

Gets the address query record corresponding to the given Address record Type. Multiple record retrievals produce a nested boolean OR term.

Parameters:

addressRecordType - an address record type

Returns:

the address query record

Throws:

NullArgumentException - addressRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(addressRecordType) is false

Compliance:

mandatory - This method must be implemented.