org.osid.financials.posting

Interface PostEntryNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getBusinessId

Id getBusinessId()

Gets the Business Id associated with this session.

Returns:

the Business Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBusiness

Business getBusiness()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Business associated with this session.

Returns:

the business

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForPostEntryNotifications

boolean canRegisterForPostEntryNotifications()

Tests if this user can register for 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.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedBusinessView

void useFederatedBusinessView()

Federates the view for methods in this session. A federated view will include post entries in catalogs which are children of this catalog in the business hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedBusinessView

void useIsolatedBusinessView()

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

Compliance:

mandatory - This method is must be implemented.

registerForNewPostEntries

void registerForNewPostEntries()
                               throws OperationFailedException,
                                      PermissionDeniedException

Register for notifications of new post entries. PostEntryReceiver.newPostEntries() is invoked when a new PostEntry appears in this business.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewPostEntriesForPost

void registerForNewPostEntriesForPost(Id postId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Register for notifications of new post entries for the given post. PostEntryReceiver.newPostEntries() is invoked when a new PostEntry appears in this business.

Parameters:

postId - the Id of the Post to monitor

Throws:

NullArgumentException - postId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewPostEntriesForAccount

void registerForNewPostEntriesForAccount(Id accountId)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Register for notifications of new post entries for the given account. PostEntryReceiver.newPostEntries() is invoked when a new PostEntry appears in this business.

Parameters:

accountId - the Id of the Account to monitor

Throws:

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewPostEntriesForActivity

void registerForNewPostEntriesForActivity(Id activityId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Register for notifications of new post entries for the given activity. PostEntryReceiver.newPostEntries() is invoked when a new PostEntry appears in this business.

Parameters:

activityId - the Id of the Activity to monitor

Throws:

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPostEntries

void registerForChangedPostEntries()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Registers for notification of updated payers. PostEntryReceiver.changedPostEntries() is invoked when a post entry in this business is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPostEntriesForPost

void registerForChangedPostEntriesForPost(Id postId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Registers for notification of updated post entries for the given post. PostEntryReceiver.changedPostEntries() is invoked when the specified post entry in this business is changed.

Parameters:

postId - the Id of the Post to monitor

Throws:

NullArgumentException - postId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPostEntriesForAccount

void registerForChangedPostEntriesForAccount(Id accountId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Register for notifications of updated post entries for the given account. PostEntryReceiver.changedPostEntries() is invoked when a PostEntry is changed in this business.

Parameters:

accountId - the Id of the Account to monitor

Throws:

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPostEntriesForActivity

void registerForChangedPostEntriesForActivity(Id activityId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Register for notifications of updated post entries for the given activity. PostEntryReceiver.changedPostEntries() is invoked when a PostEntry is changed in this business.

Parameters:

activityId - the Id of the Activity to monitor

Throws:

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPostEntry

void registerForChangedPostEntry(Id postEntryId)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Registers for notification of an updated post entries. PostEntryReceiver.changedPostEntries() is invoked when the specified post entry in this business is changed.

Parameters:

postEntryId - the Id of the PostEntry to monitor

Throws:

NullArgumentException - postEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPostEntries

void registerForDeletedPostEntries()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Registers for notification of deleted post entries. PostEntryReceiver.deletedPostEntries() is invoked when a post entry is deleted or removed from this business.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPostEntriesForPost

void registerForDeletedPostEntriesForPost(Id postId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Registers for notification of deleted post entries for the given post. PostEntryReceiver.deletedPostEntries() is invoked when the specified post entry is deleted or removed from this business.

Parameters:

postId - the Id of the Post to monitor

Throws:

NullArgumentException - postId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPostEntriesForAccount

void registerForDeletedPostEntriesForAccount(Id accountId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Register for notifications of deleted post entries for the given account. PostEntryReceiver.deletedPostEntries() is invoked when a PostEntry is removed or deleted from this business.

Parameters:

accountId - the Id of the Account to monitor

Throws:

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPostEntriesForActivity

void registerForDeletedPostEntriesForActivity(Id activityId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Register for notifications of deleted post entries for the given activity. PostEntryReceiver.deletedPostEntry() is invoked when a PostEntry is removed or deleted from this business.

Parameters:

activityId - the Id of the Activity to monitor

Throws:

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPostEntry

void registerForDeletedPostEntry(Id postEntryId)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Registers for notification of a deleted post entries. PostEntryReceiver.deletedPostEntries() is invoked when the specified post entry is deleted or removed from this business.

Parameters:

postEntryId - the Id of the PostEntry to monitor

Throws:

NullArgumentException - postEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.