Interface | osid.contact.ContactNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | getAddressBookId | ||
Description |
Gets the | ||
Return | osid.id.Id | the AddressBook Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBook | ||
Description |
Gets the | ||
Return | osid.contact.AddressBook | the address book | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForContactNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedAddressBookView | ||
Description |
Federates the view for methods in this session. A federated view will include contacts in address books which are children of this address book in the address book hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedAddressBookView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this address book only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableContactNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableContactNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeContactNotification | ||
Description |
Acknowledge a contact notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewContacts | ||
Description |
Register for notifications of new contacts. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewContactsByGenusType | ||
Description |
Register for notifications of new contacts for the
given genus | ||
Parameters | osid.type.Type | contactGenusType | the contact genus type to monitor |
Errors | NULL_ARGUMENT | contactGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewContactsForReference | ||
Description |
Register for notifications of new contacts for the
given reference | ||
Parameters | osid.id.Id | referenceId | the Id of the reference to monitor |
Errors | NULL_ARGUMENT | referenceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewContactsForAddress | ||
Description |
Register for notifications of new contacts for the
given reference | ||
Parameters | osid.id.Id | addressId | the Id of the address to monitor |
Errors | NULL_ARGUMENT | addressId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedContacts | ||
Description |
Registers for notification of updated contacts. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedContactsByGenusType | ||
Description |
Register for notifications of changed contacts for the
given contact genus | ||
Parameters | osid.type.Type | contactGenusType | the contact genus type to monitor |
Errors | NULL_ARGUMENT | contactGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedContactsForReference | ||
Description |
Register for notifications of changed contacts for the
given reference | ||
Parameters | osid.id.Id | referenceId | the Id of the reference to monitor |
Errors | NULL_ARGUMENT | referenceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedContactsForAddress | ||
Description |
Register for notifications of changed contacts for the
given address | ||
Parameters | osid.id.Id | addressId | the Id of the address to monitor |
Errors | NULL_ARGUMENT | addressId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedContact | ||
Description |
Registers for notification of an updated contact.
| ||
Parameters | osid.id.Id | contactId | the Id of the Contact to monitor |
Errors | NULL_ARGUMENT | contactId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedContacts | ||
Description |
Registers for notification of deleted contacts. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedContactsByGenusType | ||
Description |
Register for notifications of deleted contacts for the
given contact genus | ||
Parameters | osid.type.Type | contactGenusType | the contact genus type to monitor |
Errors | NULL_ARGUMENT | contactGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedContactsForReference | ||
Description |
Register for notifications of deleted contacts for the
given reference | ||
Parameters | osid.id.Id | referenceId | the Id of the reference to monitor |
Errors | NULL_ARGUMENT | referenceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedContactsForAddress | ||
Description |
Register for notifications of deleted contacts for the
given address | ||
Parameters | osid.id.Id | addressId | the Id of the address to monitor |
Errors | NULL_ARGUMENT | addressId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedContact | ||
Description |
Registers for notification of a deleted contact. | ||
Parameters | osid.id.Id | contactId | the Id of the Contact to monitor |
Errors | NULL_ARGUMENT | contactId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |