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

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.

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.
MethodcanRegisterForPostEntryNotifications
Description

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.

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 post entries 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.
MethodregisterForNewPostEntries
Description

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

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

Register for notifications of new post entries for the given post. PostEntryReceiver.newPostEntries() is invoked when a new PostEntry appears in 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.
MethodregisterForNewPostEntriesForAccount
Description

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

Parametersosid.id.IdaccountIdthe Id of the Account to monitor
ErrorsNULL_ARGUMENT accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewPostEntriesForActivity
Description

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

Parametersosid.id.IdactivityIdthe Id of the Activity to monitor
ErrorsNULL_ARGUMENT activityId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedPostEntries
Description

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

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

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.

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.
MethodregisterForChangedPostEntriesForAccount
Description

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

Parametersosid.id.IdaccountIdthe Id of the Account to monitor
ErrorsNULL_ARGUMENT accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedPostEntriesForActivity
Description

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

Parametersosid.id.IdactivityIdthe Id of the Activity to monitor
ErrorsNULL_ARGUMENT activityId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedPostEntry
Description

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

Parametersosid.id.IdpostEntryIdthe Id of the PostEntry to monitor
ErrorsNULL_ARGUMENT postEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedPostEntries
Description

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

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

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.

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.
MethodregisterForDeletedPostEntriesForAccount
Description

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.

Parametersosid.id.IdaccountIdthe Id of the Account to monitor
ErrorsNULL_ARGUMENT accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedPostEntriesForActivity
Description

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.

Parametersosid.id.IdactivityIdthe Id of the Activity to monitor
ErrorsNULL_ARGUMENT activityId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedPostEntry
Description

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

Parametersosid.id.IdpostEntryIdthe Id of the PostEntry to monitor
ErrorsNULL_ARGUMENT postEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.