org.osid.provisioning.rules

Interface PoolConstrainerEnablerNotificationSession

All Superinterfaces:

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

public interface PoolConstrainerEnablerNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to PoolConstrainerEnabler objects in this Distributor. This also includes existing PoolConstrainerEnablers that may appear or disappear due to changes in the Distributor 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 PoolConstrainerEnablerLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForPoolConstrainerEnablerNotifications() Tests if this user can register for PoolConstrainerEnabler notifications.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
void	registerForChangedPoolConstrainerEnabler(Id poolConstrainerEnablerId) Registers for notification of an updated pool constrainer enabler.
void	registerForChangedPoolConstrainerEnablers() Registers for notification of updated distributor enabelrs.
void	registerForDeletedPoolConstrainerEnabler(Id poolConstrainerEnablerId) Registers for notification of a deleted pool constrainer enabler.
void	registerForDeletedPoolConstrainerEnablers() Registers for notification of deleted pool constrainer enablers.
void	registerForNewPoolConstrainerEnablers() Register for notifications of new pool constrainer enablers.
void	useFederatedDistributorView() Federates the view for methods in this session.
void	useIsolatedDistributorView() 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

getDistributorId

Id getDistributorId()

Gets the Distributor Id associated with this session.

Returns:

the Distributor Id associated with this session

Compliance:

mandatory - This method must be implemented.

getDistributor

Distributor getDistributor()
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets the Distributor associated with this session.

Returns:

the distributor

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForPoolConstrainerEnablerNotifications

boolean canRegisterForPoolConstrainerEnablerNotifications()

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

useFederatedDistributorView

void useFederatedDistributorView()

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

Compliance:

mandatory - This method is must be implemented.

useIsolatedDistributorView

void useIsolatedDistributorView()

Isolates the view for methods in this session. An isolated view restricts notifications to this distributor only.

Compliance:

mandatory - This method is must be implemented.

registerForNewPoolConstrainerEnablers

void registerForNewPoolConstrainerEnablers()
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Register for notifications of new pool constrainer enablers. PoolConstrainerEnablerReceiver.newPoolConstrainerEnabler() is invoked when a new PoolConstrainerEnabler appears in this distributor.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPoolConstrainerEnablers

void registerForChangedPoolConstrainerEnablers()
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Registers for notification of updated distributor enabelrs. PoolConstrainerEnablerReceiver.changedPoolConstrainerEnabler() is invoked when a pool constrainer enabler in this distributor is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPoolConstrainerEnabler

void registerForChangedPoolConstrainerEnabler(Id poolConstrainerEnablerId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Registers for notification of an updated pool constrainer enabler. ProvisionableReceiver.changedPoolConstrainerEnabler() is invoked when the specified pool constrainer enabler in this distributor is changed.

Parameters:

poolConstrainerEnablerId - the Id of the PoolConstrainerEnabler to monitor

Throws:

NullArgumentException - poolConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPoolConstrainerEnablers

void registerForDeletedPoolConstrainerEnablers()
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Registers for notification of deleted pool constrainer enablers. PoolConstrainerEnablerReceiver.deletedPoolConstrainerEnabler() is invoked when a pool constrainer enabler is deleted or removed from this distributor.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPoolConstrainerEnabler

void registerForDeletedPoolConstrainerEnabler(Id poolConstrainerEnablerId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Registers for notification of a deleted pool constrainer enabler. PoolConstrainerEnablerReceiver.deletedPoolConstrainerEnabler() is invoked when the specified pool constrainer enabler is deleted or removed from this distributor.

Parameters:

poolConstrainerEnablerId - the Id of the PoolConstrainerEnabler to monitor

Throws:

NullArgumentException - poolConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.