public interface PostEntryNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to PostEntry
objects in this Business.
This
also includes existing post entries that may appear or disappear due to
changes in the Business
hierarchy, This session is intended
for consumers needing to synchronize their state 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
PostEntryLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForPostEntryNotifications()
Tests if this user can register for
PostEntry
notifications. |
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
void |
registerForChangedPostEntries()
Registers for notification of updated payers.
|
void |
registerForChangedPostEntriesForAccount(Id accountId)
Register for notifications of updated post entries for the given
account.
|
void |
registerForChangedPostEntriesForActivity(Id activityId)
Register for notifications of updated post entries for the given
activity.
|
void |
registerForChangedPostEntriesForPost(Id postId)
Registers for notification of updated post entries for the given post.
|
void |
registerForChangedPostEntry(Id postEntryId)
Registers for notification of an updated post entries.
|
void |
registerForDeletedPostEntries()
Registers for notification of deleted post entries.
|
void |
registerForDeletedPostEntriesForAccount(Id accountId)
Register for notifications of deleted post entries for the given
account.
|
void |
registerForDeletedPostEntriesForActivity(Id activityId)
Register for notifications of deleted post entries for the given
activity.
|
void |
registerForDeletedPostEntriesForPost(Id postId)
Registers for notification of deleted post entries for the given post.
|
void |
registerForDeletedPostEntry(Id postEntryId)
Registers for notification of a deleted post entries.
|
void |
registerForNewPostEntries()
Register for notifications of new post entries.
|
void |
registerForNewPostEntriesForAccount(Id accountId)
Register for notifications of new post entries for the given account.
|
void |
registerForNewPostEntriesForActivity(Id activityId)
Register for notifications of new post entries for the given activity.
|
void |
registerForNewPostEntriesForPost(Id postId)
Register for notifications of new post entries for the given post.
|
void |
useFederatedBusinessView()
Federates the view for methods in this session.
|
void |
useIsolatedBusinessView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBusinessId()
Business
Id
associated with
this session. Business Id
associated with this sessionmandatory
- This method must be implemented. Business getBusiness() throws OperationFailedException, PermissionDeniedException
Business
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForPostEntryNotifications()
PostEntry
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedBusinessView()
mandatory
- This method is must be implemented. void useIsolatedBusinessView()
mandatory
- This method is must be implemented. void registerForNewPostEntries() throws OperationFailedException, PermissionDeniedException
PostEntryReceiver.newPostEntries()
is invoked when a new
PostEntry
appears in this business.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewPostEntriesForPost(Id postId) throws OperationFailedException, PermissionDeniedException
PostEntryReceiver.newPostEntries()
is invoked when a
new PostEntry
appears in this business.postId
- the Id
of the Post
to
monitorNullArgumentException
- postId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewPostEntriesForAccount(Id accountId) throws OperationFailedException, PermissionDeniedException
PostEntryReceiver.newPostEntries()
is invoked when a
new PostEntry
appears in this business.accountId
- the Id
of the Account
to monitorNullArgumentException
- accountId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewPostEntriesForActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
PostEntryReceiver.newPostEntries()
is invoked when a
new PostEntry
appears in this business.activityId
- the Id
of the Activity
to monitorNullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedPostEntries() throws OperationFailedException, PermissionDeniedException
PostEntryReceiver.changedPostEntries()
is invoked when a post
entry in this business is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedPostEntriesForPost(Id postId) throws OperationFailedException, PermissionDeniedException
PostEntryReceiver.changedPostEntries()
is invoked when
the specified post entry in this business is changed.postId
- the Id
of the Post
to
monitorNullArgumentException
- postId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedPostEntriesForAccount(Id accountId) throws OperationFailedException, PermissionDeniedException
PostEntryReceiver.changedPostEntries()
is
invoked when a PostEntry
is changed in this business.accountId
- the Id
of the Account
to monitorNullArgumentException
- accountId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedPostEntriesForActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
PostEntryReceiver.changedPostEntries()
is
invoked when a PostEntry
is changed in this business.activityId
- the Id
of the Activity
to monitorNullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedPostEntry(Id postEntryId) throws OperationFailedException, PermissionDeniedException
PostEntryReceiver.changedPostEntries()
is invoked when the
specified post entry in this business is changed.postEntryId
- the Id
of the PostEntry
to monitorNullArgumentException
- postEntryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedPostEntries() throws OperationFailedException, PermissionDeniedException
PostEntryReceiver.deletedPostEntries()
is invoked when a post
entry is deleted or removed from this business.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedPostEntriesForPost(Id postId) throws OperationFailedException, PermissionDeniedException
PostEntryReceiver.deletedPostEntries()
is invoked when
the specified post entry is deleted or removed from this business.postId
- the Id
of the Post
to
monitorNullArgumentException
- postId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedPostEntriesForAccount(Id accountId) throws OperationFailedException, PermissionDeniedException
PostEntryReceiver.deletedPostEntries()
is
invoked when a PostEntry
is removed or deleted from
this business.accountId
- the Id
of the Account
to monitorNullArgumentException
- accountId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedPostEntriesForActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
PostEntryReceiver.deletedPostEntry()
is
invoked when a PostEntry
is removed or deleted from
this business.activityId
- the Id
of the Activity
to monitorNullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedPostEntry(Id postEntryId) throws OperationFailedException, PermissionDeniedException
PostEntryReceiver.deletedPostEntries()
is invoked when the
specified post entry is deleted or removed from this business.postEntryId
- the Id
of the PostEntry
to monitorNullArgumentException
- postEntryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.