Interface | osid.contact.ContactQuery | ||
---|---|---|---|
Implements | osid.OsidRelationshipQuery | ||
Description |
This is the query for searching contacts. Each method
specifies an | ||
Method | matchReferenceId | ||
Description |
Sets a reference | ||
Parameters | osid.id.Id | referenceId | a reference Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | referenceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearReferenceIdTerms | ||
Description |
Clears the reference | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAddresseeId | ||
Description |
Sets a resource | ||
Parameters | osid.id.Id | resourceId | a resource Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAddresseeIdTerms | ||
Description |
Clears the resource | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAddresseeQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddresseeQuery | ||
Description |
Gets the query for a resource query. Multiple
retrievals produce a nested | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsAddresseeQuery() is false | |
Compliance | optional | This method must be implemented if supportsAddresseeQuery()
is true. | |
Method | clearAddresseeTerms | ||
Description |
Clears the resource terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAddressId | ||
Description |
Sets an address | ||
Parameters | osid.id.Id | addressId | an address Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | addressId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAddressIdTerms | ||
Description |
Clears the address | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAddressQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an address query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressQuery | ||
Description |
Gets the query for an address query. Multiple
retrievals produce a nested | ||
Return | osid.contact.AddressQuery | the address query | |
Errors | UNIMPLEMENTED | supportsAddressQuery() is false | |
Compliance | optional | This method must be implemented if supportsAddressrQuery()
is true. | |
Method | clearAddressTerms | ||
Description |
Clears the address terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAddressBookId | ||
Description |
Sets the address | ||
Parameters | osid.id.Id | addressBookId | an address book Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | addressBookId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAddressBookIdTerms | ||
Description |
Clears the address book | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAddressBookQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an address book query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBookQuery | ||
Description |
Gets the query for an address book query. Multiple
retrievals produce a nested | ||
Return | osid.contact.AddressBookQuery | the address book query | |
Errors | UNIMPLEMENTED | supportsAddressBookQuery() is false | |
Compliance | optional | This method must be implemented if supportsAddressBookQuery()
is true. | |
Method | clearAddressBookTerms | ||
Description |
Clears the address book terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getContactQueryRecord | ||
Description |
Gets the contact query record corresponding to the
given | ||
Parameters | osid.type.Type | contactRecordType | a contact record type |
Return | osid.contact.records.ContactQueryRecord | the contact query record | |
Errors | NULL_ARGUMENT | contactRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(contactRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |