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

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidSourceableQuery

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

Modifier and Type	Method	Description
void	clearBrandingIdTerms()	Clears all asset Id terms.
void	clearBrandingTerms()	Clears all branding terms.
void	clearLicenseTerms()	Clears all license terms.
void	clearProviderIdTerms()	Clears all provider Id terms.
void	clearProviderTerms()	Clears all provider terms.
AssetQuery	getBrandingQuery(boolean match)	Gets the query for an asset.
ResourceQuery	getProviderQuery(boolean match)	Gets the query for the provider.
void	matchAnyBranding(boolean match)	Match sourceables with any branding.
void	matchAnyLicense(boolean match)	Matches any object with a license.
void	matchAnyProvider(boolean match)	Match sourceables with a provider value.
void	matchBrandingId(Id assetId, boolean match)	Match the Id of an asset used for branding.
void	matchLicense(String license, Type stringMatchType, boolean match)	Adds a license to match.
void	matchProviderId(Id resourceId, boolean match)	Match the Id of the provider resource.
boolean	supportsBrandingQuery()	Tests if an AssetQuery for the branding is available.
boolean	supportsProviderQuery()	Tests if a ResourceQuery for the provider is available.

Method Details

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 {@code supportsContactQuery()} is {@code 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 {@code supportsAddressQuery()} is {@code 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 {@code supportsAncestorAddressBookQuery()} is {@code 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 {@code supportsDescendantAddressBookQuery()} is {@code 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.