Interface | osid.installation.InstallationNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive asynchronous
notifications on adds/changes to | ||
Method | getSiteId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Site Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getSite | ||
Description |
Gets the | ||
Return | osid.installation.Site | the Site associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForInstallationNotifications | ||
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 | registerForNewInstallations | ||
Description |
Register for notifications of new installations. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedInstallations | ||
Description |
Registers for notification of deleted installations.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedInstallation | ||
Description |
Registers for notification of a deleted installation.
| ||
Parameters | osid.id.Id | installationId | the Id of the Installation to monitor |
Errors | NULL_ARGUMENT | installationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |