org.osid.assessment.authoring

Interface SequenceRuleEnablerNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface SequenceRuleEnablerNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to SequenceRuleEnabler objects in this Bank. This also includes existing SequenceRuleEnablers 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 SequenceRuleEnablerLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledgeSequenceRuleEnablerNotification(Id notificationId) Acknowledge a sequence rule enabler notification.
boolean	canRegisterForSequenceRuleEnablerNotifications() Tests if this user can register for SequenceRuleEnabler notifications.
Bank	getBank() Gets the Bank associated with this session.
Id	getBankId() Gets the Bank Id associated with this session.
void	registerForChangedSequenceRuleEnabler(Id sequenceRuleEnablerId) Registers for notification of an updated sequence rule enabler.
void	registerForChangedSequenceRuleEnablers() Registers for notification of updated bank enabelrs.
void	registerForDeletedSequenceRuleEnabler(Id sequenceRuleEnablerId) Registers for notification of a deleted sequence rule enabler.
void	registerForDeletedSequenceRuleEnablers() Registers for notification of deleted sequence rule enablers.
void	registerForNewSequenceRuleEnablers() Register for notifications of new sequence rule enablers.
void	reliableSequenceRuleEnablerNotifications() Reliable notifications are desired.
void	unreliableSequenceRuleEnablerNotifications() Unreliable notifications are desired.
void	useFederatedBankView() Federates the view for methods in this session.
void	useIsolatedBankView() Isolates the view for methods in this session.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getBankId

Id getBankId()

Gets the Bank Id associated with this session.

Returns:

the Bank Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBank

Bank getBank()
             throws OperationFailedException,
                    PermissionDeniedException

Gets the Bank associated with this session.

Returns:

the bank

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForSequenceRuleEnablerNotifications

boolean canRegisterForSequenceRuleEnablerNotifications()

Tests if this user can register for SequenceRuleEnabler 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.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedBankView

void useFederatedBankView()

Federates the view for methods in this session. A federated view will include enablers in banks which are children of this bank in the bank hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedBankView

void useIsolatedBankView()

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.

reliableSequenceRuleEnablerNotifications

void reliableSequenceRuleEnablerNotifications()

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeSequenceRuleEnablerNotification() .

Compliance:

mandatory - This method is must be implemented.

unreliableSequenceRuleEnablerNotifications

void unreliableSequenceRuleEnablerNotifications()

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

Compliance:

mandatory - This method is must be implemented.

acknowledgeSequenceRuleEnablerNotification

void acknowledgeSequenceRuleEnablerNotification(Id notificationId)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Acknowledge a sequence rule enabler notification.

Parameters:

notificationId - the Id of the notification

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewSequenceRuleEnablers

void registerForNewSequenceRuleEnablers()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Register for notifications of new sequence rule enablers. SequenceRuleEnablerReceiver.newSequenceRuleEnablers() is invoked when a new SequenceRuleEnabler appears in this bank.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedSequenceRuleEnablers

void registerForChangedSequenceRuleEnablers()
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Registers for notification of updated bank enabelrs. SequenceRuleEnablerReceiver.changedSequenceRuleEnablers() is invoked when a sequence rule enabler in this bank is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedSequenceRuleEnabler

void registerForChangedSequenceRuleEnabler(Id sequenceRuleEnablerId)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Registers for notification of an updated sequence rule enabler. ProvisionableReceiver.changedSequenceRuleEnablers() is invoked when the specified sequence rule enabler in this bank is changed.

Parameters:

sequenceRuleEnablerId - the Id of the SequenceRuleEnabler to monitor

Throws:

NullArgumentException - sequenceRuleEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedSequenceRuleEnablers

void registerForDeletedSequenceRuleEnablers()
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Registers for notification of deleted sequence rule enablers. SequenceRuleEnablerReceiver.deletedSequenceRuleEnablers() is invoked when a sequence rule enabler is deleted or removed from this bank.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedSequenceRuleEnabler

void registerForDeletedSequenceRuleEnabler(Id sequenceRuleEnablerId)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Registers for notification of a deleted sequence rule enabler. SequenceRuleEnablerReceiver.deletedSequenceRuleEnablers() is invoked when the specified sequence rule enabler is deleted or removed from this bank.

Parameters:

sequenceRuleEnablerId - the Id of the SequenceRuleEnabler to monitor

Throws:

NullArgumentException - sequenceRuleEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.