OSID Logo
OSID Specifications
financials posting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.posting.PostNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Post objects in this Business. This also includes existing posts 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 PostLookupSession.

MethodgetBusinessId
Description

Gets the Business Id associated with this session.

Returnosid.id.Idthe Business Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBusiness
Description

Gets the Business associated with this session.

Returnosid.financials.Businessthe business
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForPostNotifications
Description

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

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

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBusinessView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewPosts
Description

Register for notifications of new posts. PostReceiver.newPosts() is invoked when a new Post appears in this business.

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

Registers for notification of updated payers. PostReceiver.changedPosts() is invoked when a payer in this business is changed.

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

Registers for notification of an updated post. PostReceiver.changedPosts() is invoked when the specified post in this business is changed.

Parametersosid.id.IdpostIdthe Id of the Post to monitor
ErrorsNULL_ARGUMENT postId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedPosts
Description

Registers for notification of deleted payers. PostReceiver.deletedPosts() is invoked when a post is deleted or removed from this business.

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

Registers for notification of a deleted post. PostReceiver.deletedPosts() is invoked when the specified post is deleted or removed from this business.

Parametersosid.id.IdpostIdthe Id of the Post to monitor
ErrorsNULL_ARGUMENT postId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.