OSID Logo
OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.ContactQuery
Implementsosid.OsidRelationshipQuery
Description

This is the query for searching contacts. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchReferenceId
Description

Sets a reference Id.

Parametersosid.id.IdreferenceIda reference Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT referenceId is null
CompliancemandatoryThis method must be implemented.
MethodclearReferenceIdTerms
Description

Clears the reference Id terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAddresseeId
Description

Sets a resource Id.

Parametersosid.id.IdresourceIda resource Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearAddresseeIdTerms
Description

Clears the resource Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAddresseeQuery
Description

Tests if a ResourceQuery is available.

Returnboolean true if a resource query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAddresseeQuery
Description

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

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsAddresseeQuery() is false
ComplianceoptionalThis method must be implemented if supportsAddresseeQuery() is true.
MethodclearAddresseeTerms
Description

Clears the resource terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAddressId
Description

Sets an address Id.

Parametersosid.id.IdaddressIdan address Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT addressId is null
CompliancemandatoryThis method must be implemented.
MethodclearAddressIdTerms
Description

Clears the address Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAddressQuery
Description

Tests if an AddressQuery is available.

Returnboolean true if an address query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAddressQuery
Description

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

Returnosid.contact.AddressQuerythe address query
ErrorsUNIMPLEMENTED supportsAddressQuery() is false
ComplianceoptionalThis method must be implemented if supportsAddressrQuery() is true.
MethodclearAddressTerms
Description

Clears the address terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAddressBookId
Description

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

Parametersosid.id.IdaddressBookIdan address book Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT addressBookId is null
CompliancemandatoryThis method must be implemented.
MethodclearAddressBookIdTerms
Description

Clears the address book Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAddressBookQuery
Description

Tests if an AddressBookQuery is available.

Returnboolean true if an address book query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAddressBookQuery
Description

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

Returnosid.contact.AddressBookQuerythe address book query
ErrorsUNIMPLEMENTED supportsAddressBookQuery() is false
ComplianceoptionalThis method must be implemented if supportsAddressBookQuery() is true.
MethodclearAddressBookTerms
Description

Clears the address book terms.

CompliancemandatoryThis method must be implemented.
MethodgetContactQueryRecord
Description

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

Parametersosid.type.TypecontactRecordTypea contact record type
Returnosid.contact.records.ContactQueryRecordthe contact query record
ErrorsNULL_ARGUMENT contactRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(contactRecordType) is false
CompliancemandatoryThis method must be implemented.