org.osid.resourcing

Interface FoundryNotificationSession

All Superinterfaces:

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

public interface FoundryNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Foundry 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	canRegisterForFoundryNotifications() Tests if this user can register for Foundry notifications.
void	registerForChangedFoundries() Registers for notification of updated foundries.
void	registerForChangedFoundry(Id foundryId) Registers for notification of an updated foundry.
void	registerForDeletedFoundries() Registers for notification of deleted foundries.
void	registerForDeletedFoundry(Id foundryId) Registers for notification of a deleted foundry.
void	registerForDeletedFoundryAncestors(Id foundryId) Registers for notification if an ancestor is removed from the specified foundry in the foundry hierarchy.
void	registerForDeletedFoundryDescendants(Id foundryId) Registers for notification if a descendant is removed from fthe specified foundry in the foundry hierarchy.
void	registerForNewFoundries() Register for notifications of new foundries.
void	registerForNewFoundryAncestors(Id foundryId) Registers for notification if an ancestor is added to the specified foundry in the foundry hierarchy.
void	registerForNewFoundryDescendants(Id foundryId) Registers for notification if a descendant is added to the specified foundry in the foundry hierarchy.

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

canRegisterForFoundryNotifications

boolean canRegisterForFoundryNotifications()

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

registerForNewFoundries

void registerForNewFoundries()
                             throws OperationFailedException,
                                    PermissionDeniedException

Register for notifications of new foundries. FoundryReceiver.newFoundries() is invoked when a new Foundry is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewFoundryAncestors

void registerForNewFoundryAncestors(Id foundryId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Registers for notification if an ancestor is added to the specified foundry in the foundry hierarchy. FoundryReceiver.newFoundryAncestor() is invoked when the specified foundry experiences an addition in ancestry.

Parameters:

foundryId - the Id of the foundry to monitor

Throws:

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewFoundryDescendants

void registerForNewFoundryDescendants(Id foundryId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Registers for notification if a descendant is added to the specified foundry in the foundry hierarchy. FoundryReceiver.newFoundryDescendant() is invoked when the specified foundry experiences an addition in descendants.

Parameters:

foundryId - the Id of the foundry to monitor

Throws:

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedFoundries

void registerForChangedFoundries()
                                 throws OperationFailedException,
                                        PermissionDeniedException

Registers for notification of updated foundries. FoundryReceiver.changedFoundries() is invoked when a foundry is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedFoundry

void registerForChangedFoundry(Id foundryId)
                               throws OperationFailedException,
                                      PermissionDeniedException

Registers for notification of an updated foundry. FoundryReceiver.changedFoundries() is invoked when the specified foundry is changed.

Parameters:

foundryId - the Id of the Foundry to monitor

Throws:

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedFoundries

void registerForDeletedFoundries()
                                 throws OperationFailedException,
                                        PermissionDeniedException

Registers for notification of deleted foundries. FoundryReceiver.deletedFoundries() is invoked when a foundry is deleted.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedFoundry

void registerForDeletedFoundry(Id foundryId)
                               throws OperationFailedException,
                                      PermissionDeniedException

Registers for notification of a deleted foundry. FoundryReceiver.deletedFoundries() is invoked when the specified foundry is deleted.

Parameters:

foundryId - the Id of the Foundry to monitor

Throws:

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedFoundryAncestors

void registerForDeletedFoundryAncestors(Id foundryId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Registers for notification if an ancestor is removed from the specified foundry in the foundry hierarchy. FoundryReceiver.deletedFoundryAncestor() is invoked when the specified foundry experiences a removal of an ancestor.

Parameters:

foundryId - the Id of the foundry to monitor

Throws:

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedFoundryDescendants

void registerForDeletedFoundryDescendants(Id foundryId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

foundryId - the Id of the foundry to monitor

Throws:

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.