org.osid.offering.rules

Interface OfferingConstrainerEnablerNotificationSession

All Superinterfaces:

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

public interface OfferingConstrainerEnablerNotificationSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForOfferingConstrainerEnablerNotifications() Tests if this user can register for OfferingConstrainerEnabler notifications.
Catalogue	getCatalogue() Gets the Catalogue associated with this session.
Id	getCatalogueId() Gets the Catalogue Id associated with this session.
void	registerForChangedOfferingConstrainerEnabler(Id offeringConstrainerEnablerId) Registers for notification of an updated offering constrainer enabler.
void	registerForChangedOfferingConstrainerEnablers() Registers for notification of updated offering constrainer enablers.
void	registerForDeletedOfferingConstrainerEnabler(Id offeringConstrainerEnablerId) Registers for notification of a deleted offering constrainer enabler.
void	registerForDeletedOfferingConstrainerEnablers() Registers for notification of deleted offering constrainer enablers.
void	registerForNewOfferingConstrainerEnablers() Register for notifications of new offering constrainer enablers.
void	useFederatedCatalogueView() Federates the view for methods in this session.
void	useIsolatedCatalogueView() 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

getCatalogueId

Id getCatalogueId()

Gets the Catalogue Id associated with this session.

Returns:

the Catalogue Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCatalogue

Catalogue getCatalogue()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets the Catalogue associated with this session.

Returns:

the catalogue

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForOfferingConstrainerEnablerNotifications

boolean canRegisterForOfferingConstrainerEnablerNotifications()

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

useFederatedCatalogueView

void useFederatedCatalogueView()

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

Compliance:

mandatory - This method is must be implemented.

useIsolatedCatalogueView

void useIsolatedCatalogueView()

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

Compliance:

mandatory - This method is must be implemented.

registerForNewOfferingConstrainerEnablers

void registerForNewOfferingConstrainerEnablers()
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Register for notifications of new offering constrainer enablers. OfferingConstrainerEnablerReceiver.newOfferingConstrainerEnabler() is invoked when a new OfferingConstrainerEnabler appears in this catalogue.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedOfferingConstrainerEnablers

void registerForChangedOfferingConstrainerEnablers()
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

Registers for notification of updated offering constrainer enablers. OfferingConstrainerEnablerReceiver.changedOfferingConstrainerEnabler() is invoked when an offering constrainer enabler in this catalogue is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedOfferingConstrainerEnabler

void registerForChangedOfferingConstrainerEnabler(Id offeringConstrainerEnablerId)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Registers for notification of an updated offering constrainer enabler. ProvisionableReceiver.changedOfferingConstrainerEnabler() is invoked when the specified offering constrainer enabler in this catalogue is changed.

Parameters:

offeringConstrainerEnablerId - the Id of the OfferingConstrainerEnabler to monitor

Throws:

NullArgumentException - offeringConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedOfferingConstrainerEnablers

void registerForDeletedOfferingConstrainerEnablers()
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

Registers for notification of deleted offering constrainer enablers. OfferingConstrainerEnablerReceiver.deletedOfferingConstrainerEnabler() is invoked when an offering constrainer enabler is deleted or removed from this catalogue.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedOfferingConstrainerEnabler

void registerForDeletedOfferingConstrainerEnabler(Id offeringConstrainerEnablerId)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Registers for notification of a deleted offering constrainer enabler. OfferingConstrainerEnablerReceiver.deletedOfferingConstrainerEnabler() is invoked when the specified offering constrainer enabler is deleted or removed from this catalogue.

Parameters:

offeringConstrainerEnablerId - the Id of the OfferingConstrainerEnabler to monitor

Throws:

NullArgumentException - offeringConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.