OSID - osid.assessment.authoring.SequenceRuleNotificationSession Service Interface Definition

Interface	osid.assessment.authoring.SequenceRuleNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `SequenceRule` objects in this `Bank.` This also includes existing `SequenceRules` that may appear or disappear due to changes in the `Bank` 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 `SequenceRuleLookupSession.`
Method	getBankId
Description	Gets the `Bank` `Id` associated with this session.
Return	`osid.id.Id`		the `Bank Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBank
Description	Gets the `Bank` associated with this session.
Return	`osid.assessment.Bank`		the bank
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForSequenceRuleNotifications
Description	Tests if this user can register for `SequenceRule` 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	useFederatedBankView
Description	Federates the view for methods in this session. A federated view will include in banks which are children of this bank in the bank hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBankView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this bank only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableSequenceRuleNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeSequenceRuleNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableSequenceRuleNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeSequenceRuleNotification
Description	Acknowledge a sequence rule notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewSequenceRules
Description	Register for notifications of new sequence rules. `SequenceRuleReceiver.newSequenceRules()` is invoked when a new `SequenceRule` appears in this bank.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewSequenceRulesForAssessmentPart
Description	Register for notifications of new sequence rules for the given assessment part. `SequenceRuleReceiver.newSequenceRules()` is invoked when a new `SequenceRule` appears in this bank.
Parameters	`osid.id.Id`	`assessmentPartId`	the `Id` of the `AssessmentPart` to monitor
Errors	NULL_ARGUMENT		`sequenceRuleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewSequenceRulesForNextAssessmentPart
Description	Register for notifications of new sequence rules for the given assessment part. `SequenceRuleReceiver.newSequenceRules()` is invoked when a new `SequenceRule` appears in this bank.
Parameters	`osid.id.Id`	`assessmentPartId`	the `Id` of the `AssessmentPart` to monitor
Errors	NULL_ARGUMENT		`sequenceRuleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedSequenceRules
Description	Registers for notification of updated sequence rules. `SequenceRuleReceiver.changedSequenceRules()` is invoked when a sequence rule in this bank is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedSequenceRulesForAssessmentPart
Description	Register for notifications of updated sequence rules for the given assessment part. `SequenceRuleReceiver.changedSequenceRules()` is invoked when a new `SequenceRule` in this bank is changed.
Parameters	`osid.id.Id`	`assessmentPartId`	the `Id` of the `AssessmentPart` to monitor
Errors	NULL_ARGUMENT		`sequenceRuleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedSequenceRulesForNextAssessmentPart
Description	Register for notifications of updated sequence rules for the given assessment part. `SequenceRuleReceiver.changedSequenceRules()` is invoked when a new `SequenceRule` in this bank is changed.
Parameters	`osid.id.Id`	`assessmentPartId`	the `Id` of the `AssessmentPart` to monitor
Errors	NULL_ARGUMENT		`sequenceRuleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedSequenceRule
Description	Registers for notification of an updated sequence rule. `ProvisionableReceiver.changedSequenceRules()` is invoked when the specified sequence rule in this bank is changed.
Parameters	`osid.id.Id`	`sequenceRuleId`	the `Id` of the `SequenceRule` to monitor
Errors	NULL_ARGUMENT		`sequenceRuleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedSequenceRules
Description	Registers for notification of deleted sequence rules. `SequenceRuleReceiver.deletedSequenceRules()` is invoked when a sequence rule is deleted or removed from this bank.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedSequenceRulesForAssessmentPart
Description	Registers for notification of deleted sequence rules for the given assessment part. `SequenceRuleReceiver.deletedSequenceRule()` is invoked when a sequence rule is deleted or removed from this bank.
Parameters	`osid.id.Id`	`assessmentPartId`	the `Id` of the `AssessmentPart` to monitor
Errors	NULL_ARGUMENT		`sequenceRuleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedSequenceRulesForNextAssessmentPart
Description	Registers for notification of deleted sequence rules for the given assessment part. `SequenceRuleReceiver.deletedSequenceRule()` is invoked when a sequence rule is deleted or removed from this bank.
Parameters	`osid.id.Id`	`assessmentPartId`	the `Id` of the `AssessmentPart` to monitor
Errors	NULL_ARGUMENT		`sequenceRuleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedSequenceRule
Description	Registers for notification of a deleted sequence rule. `SequenceRuleReceiver.deletedSequenceRule()` is invoked when the specified sequence rule is deleted or removed from this bank.
Parameters	`osid.id.Id`	`sequenceRuleId`	the `Id` of the `SequenceRule` to monitor
Errors	NULL_ARGUMENT		`sequenceRuleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.