Interface | osid.financials.posting.PostEntryNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getBusinessId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Business Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBusiness | ||
Description |
Gets the | ||
Return | osid.financials.Business | the business | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForPostEntryNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedBusinessView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedBusinessView | ||
Description |
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. | |
Method | registerForNewPostEntries | ||
Description |
Register for notifications of new post entries. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewPostEntriesForPost | ||
Description |
Register for notifications of new post entries for the
given post. | ||
Parameters | osid.id.Id | postId | the Id of the Post to monitor |
Errors | NULL_ARGUMENT | postId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewPostEntriesForAccount | ||
Description |
Register for notifications of new post entries for the
given account. | ||
Parameters | osid.id.Id | accountId | the Id of the Account to monitor |
Errors | NULL_ARGUMENT | accountId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewPostEntriesForActivity | ||
Description |
Register for notifications of new post entries for the
given activity. | ||
Parameters | osid.id.Id | activityId | the Id of the Activity to monitor |
Errors | NULL_ARGUMENT | activityId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPostEntries | ||
Description |
Registers for notification of updated payers. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPostEntriesForPost | ||
Description |
Registers for notification of updated post entries for
the given post. | ||
Parameters | osid.id.Id | postId | the Id of the Post to monitor |
Errors | NULL_ARGUMENT | postId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPostEntriesForAccount | ||
Description |
Register for notifications of updated post entries for
the given account. | ||
Parameters | osid.id.Id | accountId | the Id of the Account to monitor |
Errors | NULL_ARGUMENT | accountId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPostEntriesForActivity | ||
Description |
Register for notifications of updated post entries for
the given activity. | ||
Parameters | osid.id.Id | activityId | the Id of the Activity to monitor |
Errors | NULL_ARGUMENT | activityId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPostEntry | ||
Description |
Registers for notification of an updated post entries.
| ||
Parameters | osid.id.Id | postEntryId | the Id of the PostEntry to monitor |
Errors | NULL_ARGUMENT | postEntryId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPostEntries | ||
Description |
Registers for notification of deleted post entries.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPostEntriesForPost | ||
Description |
Registers for notification of deleted post entries for
the given post. | ||
Parameters | osid.id.Id | postId | the Id of the Post to monitor |
Errors | NULL_ARGUMENT | postId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPostEntriesForAccount | ||
Description |
Register for notifications of deleted post entries for
the given account. | ||
Parameters | osid.id.Id | accountId | the Id of the Account to monitor |
Errors | NULL_ARGUMENT | accountId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPostEntriesForActivity | ||
Description |
Register for notifications of deleted post entries for
the given activity. | ||
Parameters | osid.id.Id | activityId | the Id of the Activity to monitor |
Errors | NULL_ARGUMENT | activityId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPostEntry | ||
Description |
Registers for notification of a deleted post entries.
| ||
Parameters | osid.id.Id | postEntryId | the Id of the PostEntry to monitor |
Errors | NULL_ARGUMENT | postEntryId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |