public interface SequenceRuleNotificationSession extends OsidSession
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.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeSequenceRuleNotification(Id notificationId)
Acknowledge a sequence rule notification.
|
boolean |
canRegisterForSequenceRuleNotifications()
Tests if this user can register for
SequenceRule
notifications. |
Bank |
getBank()
Gets the
Bank associated with this session. |
Id |
getBankId()
Gets the
Bank Id associated with this
session. |
void |
registerForChangedSequenceRule(Id sequenceRuleId)
Registers for notification of an updated sequence rule.
|
void |
registerForChangedSequenceRules()
Registers for notification of updated sequence rules.
|
void |
registerForChangedSequenceRulesForAssessmentPart(Id assessmentPartId)
Register for notifications of updated sequence rules for the given
assessment part.
|
void |
registerForChangedSequenceRulesForNextAssessmentPart(Id assessmentPartId)
Register for notifications of updated sequence rules for the given
assessment part.
|
void |
registerForDeletedSequenceRule(Id sequenceRuleId)
Registers for notification of a deleted sequence rule.
|
void |
registerForDeletedSequenceRules()
Registers for notification of deleted sequence rules.
|
void |
registerForDeletedSequenceRulesForAssessmentPart(Id assessmentPartId)
Registers for notification of deleted sequence rules for the given
assessment part.
|
void |
registerForDeletedSequenceRulesForNextAssessmentPart(Id assessmentPartId)
Registers for notification of deleted sequence rules for the given
assessment part.
|
void |
registerForNewSequenceRules()
Register for notifications of new sequence rules.
|
void |
registerForNewSequenceRulesForAssessmentPart(Id assessmentPartId)
Register for notifications of new sequence rules for the given
assessment part.
|
void |
registerForNewSequenceRulesForNextAssessmentPart(Id assessmentPartId)
Register for notifications of new sequence rules for the given
assessment part.
|
void |
reliableSequenceRuleNotifications()
Reliable notifications are desired.
|
void |
unreliableSequenceRuleNotifications()
Unreliable notifications are desired.
|
void |
useFederatedBankView()
Federates the view for methods in this session.
|
void |
useIsolatedBankView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBankId()
Bank
Id
associated with this
session. Bank Id
associated with this sessionmandatory
- This method must be implemented. Bank getBank() throws OperationFailedException, PermissionDeniedException
Bank
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForSequenceRuleNotifications()
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedBankView()
mandatory
- This method is must be implemented. void useIsolatedBankView()
mandatory
- This method is must be implemented. void reliableSequenceRuleNotifications()
acknowledgeSequenceRuleNotification()
.mandatory
- This method is must be implemented. void unreliableSequenceRuleNotifications()
mandatory
- This method is must be implemented. void acknowledgeSequenceRuleNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewSequenceRules() throws OperationFailedException, PermissionDeniedException
SequenceRuleReceiver.newSequenceRules()
is invoked when a new
SequenceRule
appears in this bank.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewSequenceRulesForAssessmentPart(Id assessmentPartId) throws OperationFailedException, PermissionDeniedException
SequenceRuleReceiver.newSequenceRules()
is invoked when a new SequenceRule
appears in
this bank.assessmentPartId
- the Id
of the
AssessmentPart
to monitorNullArgumentException
- sequenceRuleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewSequenceRulesForNextAssessmentPart(Id assessmentPartId) throws OperationFailedException, PermissionDeniedException
SequenceRuleReceiver.newSequenceRules()
is invoked when a new SequenceRule
appears in
this bank.assessmentPartId
- the Id
of the
AssessmentPart
to monitorNullArgumentException
- sequenceRuleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSequenceRules() throws OperationFailedException, PermissionDeniedException
SequenceRuleReceiver.changedSequenceRules()
is invoked when a
sequence rule in this bank is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSequenceRulesForAssessmentPart(Id assessmentPartId) throws OperationFailedException, PermissionDeniedException
SequenceRuleReceiver.changedSequenceRules()
is invoked when a new SequenceRule
in this bank
is changed.assessmentPartId
- the Id
of the
AssessmentPart
to monitorNullArgumentException
- sequenceRuleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSequenceRulesForNextAssessmentPart(Id assessmentPartId) throws OperationFailedException, PermissionDeniedException
SequenceRuleReceiver.changedSequenceRules()
is invoked when a new SequenceRule
in this bank
is changed.assessmentPartId
- the Id
of the
AssessmentPart
to monitorNullArgumentException
- sequenceRuleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSequenceRule(Id sequenceRuleId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedSequenceRules()
is invoked when
the specified sequence rule in this bank is changed.sequenceRuleId
- the Id
of the
SequenceRule
to monitorNullArgumentException
- sequenceRuleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSequenceRules() throws OperationFailedException, PermissionDeniedException
SequenceRuleReceiver.deletedSequenceRules()
is invoked when a
sequence rule is deleted or removed from this bank.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSequenceRulesForAssessmentPart(Id assessmentPartId) throws OperationFailedException, PermissionDeniedException
SequenceRuleReceiver.deletedSequenceRule()
is invoked when a sequence rule is deleted or removed from
this bank.assessmentPartId
- the Id
of the
AssessmentPart
to monitorNullArgumentException
- sequenceRuleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSequenceRulesForNextAssessmentPart(Id assessmentPartId) throws OperationFailedException, PermissionDeniedException
SequenceRuleReceiver.deletedSequenceRule()
is invoked when a sequence rule is deleted or removed from
this bank.assessmentPartId
- the Id
of the
AssessmentPart
to monitorNullArgumentException
- sequenceRuleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSequenceRule(Id sequenceRuleId) throws OperationFailedException, PermissionDeniedException
SequenceRuleReceiver.deletedSequenceRule()
is invoked when the
specified sequence rule is deleted or removed from this bank.sequenceRuleId
- the Id
of the
SequenceRule
to monitorNullArgumentException
- sequenceRuleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.