org.osid.topology

Interface GraphNotificationSession

All Superinterfaces:

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

public interface GraphNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Graph 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	canRegisterForGraphNotifications() Tests if this user can register for Graph notifications.
void	registerForChangedGraph(Id graphId) Registers for notification of an updated graph.
void	registerForChangedGraphs() Registers for notification of updated graphs.
void	registerForDeletedGraph(Id graphId) Registers for notification of a deleted graph.
void	registerForDeletedGraphAncestors(Id graphId) Registers for notification if an ancestor is removed from the specified graph in the graph hierarchy.
void	registerForDeletedGraphDescendants(Id graphId) Registers for notification if a descendant is removed from fthe specified graph in the graph hierarchy.
void	registerForDeletedGraphs() Registers for notification of deleted graphs.
void	registerForNewGraphAncestors(Id graphId) Registers for notification if an ancestor is added to the specified graph in the graph hierarchy.
void	registerForNewGraphDescendants(Id graphId) Registers for notification if a descendant is added to the specified graph in the graph hierarchy.
void	registerForNewGraphs() Register for notifications of new graphs.

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

canRegisterForGraphNotifications

boolean canRegisterForGraphNotifications()

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

registerForNewGraphs

void registerForNewGraphs()
                          throws OperationFailedException,
                                 PermissionDeniedException

Register for notifications of new graphs. GraphReceiver.newGraph() is invoked when a new Graph is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewGraphAncestors

void registerForNewGraphAncestors(Id graphId)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Registers for notification if an ancestor is added to the specified graph in the graph hierarchy. GraphReceiver.newGraphAncestor() is invoked when the specified graph experiences an addition in ancestry.

Parameters:

graphId - the Id of the graph to monitor

Throws:

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewGraphDescendants

void registerForNewGraphDescendants(Id graphId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Registers for notification if a descendant is added to the specified graph in the graph hierarchy. GraphReceiver.newGraphDescendant() is invoked when the specified graph experiences an addition in descendants.

Parameters:

graphId - the Id of the graph to monitor

Throws:

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedGraphs

void registerForChangedGraphs()
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of updated graphs. GraphReceiver.changedGraph() is invoked when a graph is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedGraph

void registerForChangedGraph(Id graphId)
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of an updated graph. GraphReceiver.changedGraph() is invoked when the specified graph is changed.

Parameters:

graphId - the Id of the Graph to monitor

Throws:

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedGraphs

void registerForDeletedGraphs()
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of deleted graphs. GraphReceiver.deletedGraph() is invoked when a graph is deleted.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedGraph

void registerForDeletedGraph(Id graphId)
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of a deleted graph. GraphReceiver.deletedGraph() is invoked when the specified graph is deleted.

Parameters:

graphId - the Id of the Graph to monitor

Throws:

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedGraphAncestors

void registerForDeletedGraphAncestors(Id graphId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Registers for notification if an ancestor is removed from the specified graph in the graph hierarchy. GraphReceiver.deletedGraphAncestor() is invoked when the specified graph experiences a removal of an ancestor.

Parameters:

graphId - the Id of the graph to monitor

Throws:

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedGraphDescendants

void registerForDeletedGraphDescendants(Id graphId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

graphId - the Id of the graph to monitor

Throws:

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.