org.osid.hold

Interface OublietteNotificationSession

All Superinterfaces:

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

public interface OublietteNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Oubliette objects. 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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForOublietteNotifications() Tests if this user can register for Oubliette notifications.
void	registerForChangedOubliette(Id oublietteId) Registers for notification of an updated oubliette.
void	registerForChangedOubliettes() Registers for notification of updated oubliettes.
void	registerForDeletedOubliette(Id oublietteId) Registers for notification of a deleted oubliette.
void	registerForDeletedOublietteAncestors(Id oublietteId) Registers for notification if an ancestor is removed from the specified oubliette in the oubliette hierarchy.
void	registerForDeletedOublietteDescendants(Id oublietteId) Registers for notification if a descendant is removed from fthe specified oubliette in the oubliette hierarchy.
void	registerForDeletedOubliettes() Registers for notification of deletedoOubliettes.
void	registerForNewOublietteAncestors(Id oublietteId) Registers for notification if an ancestor is added to the specified oubliette in the oubliette hierarchy.
void	registerForNewOublietteDescendants(Id oublietteId) Registers for notification if a descendant is added to the specified oubliette in the oubliette hierarchy.
void	registerForNewOubliettes() Register for notifications of new oubliettes.

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

canRegisterForOublietteNotifications

boolean canRegisterForOublietteNotifications()

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

registerForNewOubliettes

void registerForNewOubliettes()
                              throws OperationFailedException,
                                     PermissionDeniedException

Register for notifications of new oubliettes. OublietteReceiver.newOubliette() is invoked when a new Oubliette is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewOublietteAncestors

void registerForNewOublietteAncestors(Id oublietteId)
                                      throws NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Registers for notification if an ancestor is added to the specified oubliette in the oubliette hierarchy. OublietteReceiver.newOublietteAncestor() is invoked when the specified oubliette experiences an addition in ancestry.

Parameters:

oublietteId - the Id of the oubliette to monitor

Throws:

NotFoundException - an oubliette was not found identified by the given Id

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewOublietteDescendants

void registerForNewOublietteDescendants(Id oublietteId)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Registers for notification if a descendant is added to the specified oubliette in the oubliette hierarchy. OublietteReceiver.newOublietteDescendant() is invoked when the specified oubliette experiences an addition in descendants.

Parameters:

oublietteId - the Id of the oubliette to monitor

Throws:

NotFoundException - an oubliette was not found identified by the given Id

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedOubliettes

void registerForChangedOubliettes()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Registers for notification of updated oubliettes. OublietteReceiver.changedOubliette() is invoked when an oubliette is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedOubliette

void registerForChangedOubliette(Id oublietteId)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Registers for notification of an updated oubliette. OublietteReceiver.changedOubliette() is invoked when the specified oubliette is changed.

Parameters:

oublietteId - the Id of the Oubliette to monitor

Throws:

NotFoundException - an oubliette was not found identified by the given Id

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedOubliettes

void registerForDeletedOubliettes()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Registers for notification of deletedoOubliettes. OublietteReceiver.deletedOubliette() is invoked when an oubliette is deleted.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedOubliette

void registerForDeletedOubliette(Id oublietteId)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Registers for notification of a deleted oubliette. OublietteReceiver.deletedOubliette() is invoked when the specified oubliette is deleted.

Parameters:

oublietteId - the Id of the Oubliette to monitor

Throws:

NotFoundException - an oubliette was not found identified by the given Id

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedOublietteAncestors

void registerForDeletedOublietteAncestors(Id oublietteId)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Registers for notification if an ancestor is removed from the specified oubliette in the oubliette hierarchy. OublietteReceiver.deletedOublietteAncestor() is invoked when the specified oubliette experiences a removal of an ancestor.

Parameters:

oublietteId - the Id of the oubliette to monitor

Throws:

NotFoundException - an oubliette was not found identified by the given Id

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedOublietteDescendants

void registerForDeletedOublietteDescendants(Id oublietteId)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Registers for notification if a descendant is removed from fthe specified oubliette in the oubliette hierarchy. OublietteReceiver.deletedOublietteDescednant() is invoked when the specified oubliette experiences a removal of one of its descdendents.

Parameters:

oublietteId - the Id of the oubliette to monitor

Throws:

NotFoundException - an oubliette was not found identified by the given Id

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.