org.osid.contact

Interface AddressBookQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface AddressBookQuery
extends OsidCatalogQuery

This is the query for searching for address books. 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	clearAddressIdTerms() Clears the address Id terms.
void	clearAddressTerms() Clears the address terms.
void	clearAncestorAddressBookIdTerms() Clears the ancestor address book Id terms.
void	clearAncestorAddressBookTerms() Clears the ancestor address book terms.
void	clearContactIdTerms() Clears the contact Id terms.
void	clearContactTerms() Clears the contact terms.
void	clearDescendantAddressBookIdTerms() Clears the descendant address book Id terms.
void	clearDescendantAddressBookTerms() Clears the descendant address book terms.
AddressBookQueryRecord	getAddressBookQueryRecord(Type addressBookRecordType) Gets the query record corresponding to the given AddressBook record Type.
AddressQuery	getAddressQuery() Gets the query for an address query.
AddressBookQuery	getAncestorAddressBookQuery() Gets the query for an address book.
ContactQuery	getContactQuery() Gets the query for an address book.
AddressBookQuery	getDescendantAddressBookQuery() Gets the query for an address book.
void	matchAddressId(Id addressId, boolean match) Sets the address Id for this query to match contacts assigned to addresses.
void	matchAncestorAddressBookId(Id addressBookId, boolean match) Sets the address book Id for this query to match address books that have the specified address book as an ancestor.
void	matchAnyAddress(boolean match) Matches address books with any address.
void	matchAnyAncestorAddressBook(boolean match) Matches address books with any ancestor.
void	matchAnyContact(boolean match) Matches address books with any contact.
void	matchAnyDescendantAddressBook(boolean match) Matches address books with any descendant.
void	matchContactId(Id contactId, boolean match) Sets the contact Id for this query to match contacts assigned to address books.
void	matchDescendantAddressBookId(Id addressBookId, boolean match) Sets the address book Id for this query to match address books that have the specified address book as a descendant.
boolean	supportsAddressQuery() Tests if an AddressQuery is available.
boolean	supportsAncestorAddressBookQuery() Tests if an AddressBookQuery is available.
boolean	supportsContactQuery() Tests if a contact query is available.
boolean	supportsDescendantAddressBookQuery() Tests if an AddressBookQuery 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

Methods inherited from interface org.osid.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

matchContactId

void matchContactId(Id contactId,
                  boolean match)

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

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

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 address books with any contact.

Parameters:

match - true to match address books with any contact, false to match address books with no contacts

Compliance:

mandatory - This method must be implemented.

clearContactTerms

void clearContactTerms()

Clears the contact terms.

Compliance:

mandatory - This method must be implemented.

matchAddressId

void matchAddressId(Id addressId,
                  boolean match)

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

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 supportsAddressQuery() is true.

matchAnyAddress

void matchAnyAddress(boolean match)

Matches address books with any address.

Parameters:

match - true to match address books with any address, false to match address books with no addresses

Compliance:

mandatory - This method must be implemented.

clearAddressTerms

void clearAddressTerms()

Clears the address terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorAddressBookId

void matchAncestorAddressBookId(Id addressBookId,
                              boolean match)

Sets the address book Id for this query to match address books that have the specified address book as an ancestor.

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.

clearAncestorAddressBookIdTerms

void clearAncestorAddressBookIdTerms()

Clears the ancestor address book Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorAddressBookQuery

boolean supportsAncestorAddressBookQuery()

Tests if an AddressBookQuery is available.

Returns:

true if an address book query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorAddressBookQuery

AddressBookQuery getAncestorAddressBookQuery()

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

Returns:

the address book query

Throws:

UnimplementedException - supportsAncestorAddressBookQuery() is false

Compliance:

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

matchAnyAncestorAddressBook

void matchAnyAncestorAddressBook(boolean match)

Matches address books with any ancestor.

Parameters:

match - true to match address books with any ancestor, false to match root address books

Compliance:

mandatory - This method must be implemented.

clearAncestorAddressBookTerms

void clearAncestorAddressBookTerms()

Clears the ancestor address book terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantAddressBookId

void matchDescendantAddressBookId(Id addressBookId,
                                boolean match)

Sets the address book Id for this query to match address books that have the specified address book as a descendant.

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.

clearDescendantAddressBookIdTerms

void clearDescendantAddressBookIdTerms()

Clears the descendant address book Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantAddressBookQuery

boolean supportsDescendantAddressBookQuery()

Tests if an AddressBookQuery is available.

Returns:

true if an address book query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantAddressBookQuery

AddressBookQuery getDescendantAddressBookQuery()

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

Returns:

the address book query

Throws:

UnimplementedException - supportsDescendantAddressBookQuery() is false

Compliance:

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

matchAnyDescendantAddressBook

void matchAnyDescendantAddressBook(boolean match)

Matches address books with any descendant.

Parameters:

match - true to match address books with any descendant, false to match leaf address books

Compliance:

mandatory - This method must be implemented.

clearDescendantAddressBookTerms

void clearDescendantAddressBookTerms()

Clears the descendant address book terms.

Compliance:

mandatory - This method must be implemented.

getAddressBookQueryRecord

AddressBookQueryRecord getAddressBookQueryRecord(Type addressBookRecordType)
                                                 throws OperationFailedException

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

Parameters:

addressBookRecordType - an address book record type

Returns:

the address book query record

Throws:

NullArgumentException - addressBookRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(addressBookRecordType) is false

Compliance:

mandatory - This method must be implemented.