public interface OfferingConstrainerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to OfferingConstrainer
objects in this Catalogue.
This also includes existing OfferingConstrainers
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
OfferingConstrainerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeOfferingConstrainerNotification(Id notificationId)
Acknowledge an offering constrainer notification.
|
boolean |
canRegisterForOfferingConstrainerNotifications()
Tests if this user can register for
OfferingConstrainer
notifications. |
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
void |
registerForChangedOfferingConstrainer(Id offeringConstrainerId)
Registers for notification of an updated offering constrainer.
|
void |
registerForChangedOfferingConstrainers()
Registers for notification of updated catalogues.
|
void |
registerForDeletedOfferingConstrainer(Id offeringConstrainerId)
Registers for notification of a deleted offering constrainer.
|
void |
registerForDeletedOfferingConstrainers()
Registers for notification of deleted offering constrainers.
|
void |
registerForNewOfferingConstrainers()
Register for notifications of new offering constrainers.
|
void |
reliableOfferingConstrainerNotifications()
Reliable notifications are desired.
|
void |
unreliableOfferingConstrainerNotifications()
Unreliable notifications are desired.
|
void |
useFederatedCatalogueView()
Federates the view for methods in this session.
|
void |
useIsolatedCatalogueView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCatalogueId()
Catalogue
Id
associated with
this session. Catalogue Id
associated with this sessionmandatory
- This method must be implemented. Catalogue getCatalogue() throws OperationFailedException, PermissionDeniedException
Catalogue
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForOfferingConstrainerNotifications()
OfferingConstrainer
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedCatalogueView()
mandatory
- This method is must be implemented. void useIsolatedCatalogueView()
mandatory
- This method is must be implemented. void reliableOfferingConstrainerNotifications()
acknowledgeOfferingConstrainerNotification()
.mandatory
- This method is must be implemented. void unreliableOfferingConstrainerNotifications()
mandatory
- This method is must be implemented. void acknowledgeOfferingConstrainerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewOfferingConstrainers() throws OperationFailedException, PermissionDeniedException
OfferingConstrainerReceiver.newOfferingConstrainers()
is
invoked when a new OfferingConstrainer
appears in this
catalogue.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedOfferingConstrainers() throws OperationFailedException, PermissionDeniedException
OfferingConstrainerReceiver.changedOfferingConstrainers()
is
invoked when an offering constrainer in this catalogue is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedOfferingConstrainer(Id offeringConstrainerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedOfferingConstrainers()
is invoked
when the specified offering constrainer in this catalogue is changed.offeringConstrainerId
- the Id
of the
OfferingConstrainer
to monitorNullArgumentException
- offeringConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedOfferingConstrainers() throws OperationFailedException, PermissionDeniedException
OfferingConstrainerReceiver.deletedOfferingConstrainers()
is
invoked when an offering constrainer is deleted or removed from this
catalogue.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedOfferingConstrainer(Id offeringConstrainerId) throws OperationFailedException, PermissionDeniedException
OfferingConstrainerReceiver.deletedOfferingConstrainers()
is
invoked when the specified offering constrainer is deleted or removed
from this catalogue.offeringConstrainerId
- the Id
of the
OfferingConstrainer
to monitorNullArgumentException
- offeringConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.