OSID Logo
OSID Specifications
blogging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.blogging.EntryNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Entry objects in this Blog. This also includes existing entries that may appear or disappear due to changes in the Blog hierarchy, This session is intended for consumers needing to synchronize their entry with this service without the use of polling. Notifications are cancelled when this session is closed.

The two views defined in this session correspond to the views in the EntryLookupSession.

MethodgetBlogId
Description

Gets the Blog Id associated with this session.

Returnosid.id.Idthe Blog Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBlog
Description

Gets the Blog associated with this session.

Returnosid.blogging.Blogthe Blog associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForEntryNotifications
Description

Tests if this user can register for Entry notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer notification operations.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedBlogView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBlogView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this blog only.

CompliancemandatoryThis method is must be implemented.
MethodreliableEntryNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeEntryNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableEntryNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeEntryNotification
Description

Acknowledge an entry notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewEntries
Description

Register for notifications of new entries. EntryReceiver.newEntries() is invoked when a new Entry is appears in this blog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewEntriesForPoster
Description

Register for notifications of new entries posted by the given resource. EntryReceiver.newEntries() is invoked when a new Entry is appears in this blog.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedEntries
Description

Registers for notification of updated entries. EntryReceiver.changedEntries() is invoked when an entry in this blog is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedEntriesForPoster
Description

Register for notifications of updated entries posted by the given resource. EntryReceiver.changedEntries() is invoked when an Entry is changed in this blog.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedEntry
Description

Registers for notification of an updated entry. EntryReceiver.changedEntries() is invoked when the specified entry in this blog is changed.

Parametersosid.id.IdentryIdthe Id of the Entry to monitor
ErrorsNULL_ARGUMENT entryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedEntries
Description

Registers for notification of deleted entries. EntryReceiver.deletedEntries() is invoked when an entry is deleted or removed from this blog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedEntriesForPoster
Description

Register for notifications of deleted entries posted by the given resource. EntryReceiver.deletedEntries() is invoked when an Entry is deleted or removed from this blog.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedEntry
Description

Registers for notification of a deleted entry. EntryReceiver.deletedEntries() is invoked when the specified entry is deleted or removed from this blog.

Parametersosid.id.IdentryIdthe Id of the Entry to monitor
ErrorsNULL_ARGUMENT entryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.