OSID - osid.financials.ActivityNotificationSession Service Interface Definition

Interface	osid.financials.ActivityNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Activity` objects in this `Business.` This also includes existing activities 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 `ActivityLookupSession.`
Method	getBusinessId
Description	Gets the `Business` `Id` associated with this session.
Return	`osid.id.Id`		the `Business Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBusiness
Description	Gets the `Business` associated with this session.
Return	`osid.financials.Business`		the business
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForActivityNotifications
Description	Tests if this user can register for `Activity` 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.
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 activities 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	registerForNewActivities
Description	Register for notifications of new activities. `ActivityReceiver.newActivities()` is invoked when a new `Activity` appears in this business.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewActivityAncestors
Description	Registers for notification if an ancestor is added to the specified activity in the activity hierarchy. `ActivityReceiver.newActivityAncestor()` is invoked when the specified activity experiences an addition in ancestry.
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	registerForNewActivityDescendants
Description	Registers for notification if a descendant is added to the specified activity in the activity hierarchy. `ActivityReceiver.newActivityDescendant()` is invoked when the specified activity experiences an addition in descendants.
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	registerForChangedActivities
Description	Registers for notification of updated activities. `ActivityReceiver.changedActivities()` is invoked when an activity in this business is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedActivity
Description	Registers for notification of an updated activity. `ActivityReceiver.changedActivities()` is invoked when the specified activity in this business is changed.
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	registerForDeletedActivities
Description	Registers for notification of deleted activities. `ActivityReceiver.deletedActivities()` is invoked when an activity is deleted or removed from this business.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedActivity
Description	Registers for notification of a deleted activity. `ActivityReceiver.deletedActivities()` is invoked when the specified activity is deleted or removed from this business.
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	registerForDeletedActivityAncestors
Description	Registers for notification if an ancestor is removed from the specified activity in the activity hierarchy. `ActivityReceiver.deletedActivityAncestor()` is invoked when the specified activity experiences a removal of an ancestor.
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	registerForDeletedActivityDescendants
Description	Registers for notification if a descendant is removed from fthe specified activity in the activity hierarchy. `ActivityReceiver.deletedActivityDescednant()` is invoked when the specified activity experiences a removal of one of its descdendents.
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.