Interface | osid.blogging.EntryNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getBlogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Blog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBlog | ||
Description |
Gets the | ||
Return | osid.blogging.Blog | the Blog associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForEntryNotifications | ||
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 | useFederatedBlogView | ||
Description |
Federates the view for methods in this session. A federated view will include entries in blogs which are children of this blog in the blog hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedBlogView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this blog only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableEntryNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableEntryNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeEntryNotification | ||
Description |
Acknowledge an entry 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 | registerForNewEntries | ||
Description |
Register for notifications of new entries. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewEntriesForPoster | ||
Description |
Register for notifications of new entries posted by the
given resource. | ||
Parameters | osid.id.Id | resourceId | the Id of the Resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedEntries | ||
Description |
Registers for notification of updated entries. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedEntriesForPoster | ||
Description |
Register for notifications of updated entries posted by
the given resource. | ||
Parameters | osid.id.Id | resourceId | the Id of the Resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedEntry | ||
Description |
Registers for notification of an updated entry. | ||
Parameters | osid.id.Id | entryId | the Id of the Entry to monitor |
Errors | NULL_ARGUMENT | entryId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedEntries | ||
Description |
Registers for notification of deleted entries. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedEntriesForPoster | ||
Description |
Register for notifications of deleted entries posted by
the given resource. | ||
Parameters | osid.id.Id | resourceId | the Id of the Resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedEntry | ||
Description |
Registers for notification of a deleted entry. | ||
Parameters | osid.id.Id | entryId | the Id of the Entry to monitor |
Errors | NULL_ARGUMENT | entryId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |