org.osid.provisioning

Interface DistributorNotificationSession

All Superinterfaces:

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

public interface DistributorNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Distributor 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	canRegisterForDistributorNotifications() Tests if this user can register for Distributor notifications.
void	registerForChangedDistributor(Id distributorId) Registers for notification of an updated distributor.
void	registerForChangedDistributors() Registers for notification of updated distributors.
void	registerForDeletedDistributor(Id distributorId) Registers for notification of a deleted distributor.
void	registerForDeletedDistributorAncestors(Id distributorId) Registers for notification if an ancestor is removed from the specified distributor in the distributor hierarchy.
void	registerForDeletedDistributorDescendants(Id distributorId) Registers for notification if a descendant is removed from fthe specified distributor in the distributor hierarchy.
void	registerForDeletedDistributors() Registers for notification of deleted distributors.
void	registerForNewDistributorAncestors(Id distributorId) Registers for notification if an ancestor is added to the specified distributor in the distributor hierarchy.
void	registerForNewDistributorDescendants(Id distributorId) Registers for notification if a descendant is added to the specified distributor in the distributor hierarchy.
void	registerForNewDistributors() Register for notifications of new distributors.

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

canRegisterForDistributorNotifications

boolean canRegisterForDistributorNotifications()

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

registerForNewDistributors

void registerForNewDistributors()
                                throws OperationFailedException,
                                       PermissionDeniedException

Register for notifications of new distributors. DistributorReceiver.newDistributors() is invoked when a new Distributor is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewDistributorAncestors

void registerForNewDistributorAncestors(Id distributorId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Registers for notification if an ancestor is added to the specified distributor in the distributor hierarchy. DistributorReceiver.newDistributorAncestor() is invoked when the specified distributor experiences an addition in ancestry.

Parameters:

distributorId - the Id of the distributor to monitor

Throws:

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewDistributorDescendants

void registerForNewDistributorDescendants(Id distributorId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Registers for notification if a descendant is added to the specified distributor in the distributor hierarchy. DistributorReceiver.newDistributorDescendant() is invoked when the specified distributor experiences an addition in descendants.

Parameters:

distributorId - the Id of the distributor to monitor

Throws:

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedDistributors

void registerForChangedDistributors()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Registers for notification of updated distributors. DistributorReceiver.changedDistributors() is invoked when a distributor is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedDistributor

void registerForChangedDistributor(Id distributorId)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Registers for notification of an updated distributor. DistributorReceiver.changedDistributors() is invoked when the specified distributor is changed.

Parameters:

distributorId - the Id of the Distributor to monitor

Throws:

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedDistributors

void registerForDeletedDistributors()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Registers for notification of deleted distributors. DistributorReceiver.deletedDistributors() is invoked when a distributor is deleted.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedDistributor

void registerForDeletedDistributor(Id distributorId)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Registers for notification of a deleted distributor. DistributorReceiver.deletedDistributors() is invoked when the specified distributor is deleted.

Parameters:

distributorId - the Id of the Distributor to monitor

Throws:

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedDistributorAncestors

void registerForDeletedDistributorAncestors(Id distributorId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Registers for notification if an ancestor is removed from the specified distributor in the distributor hierarchy. DistributorReceiver.deletedDistributorAncestor() is invoked when the specified distributor experiences a removal of an ancestor.

Parameters:

distributorId - the Id of the distributor to monitor

Throws:

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedDistributorDescendants

void registerForDeletedDistributorDescendants(Id distributorId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

distributorId - the Id of the distributor to monitor

Throws:

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.