public interface OfferingNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Offering
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.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForOfferingNotifications()
Tests if this user can register for
Offering
notifications. |
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
void |
registerForChangedOffering(Id offeringId)
Registers for notification of an updated offering.
|
void |
registerForChangedOfferings()
Registers for notification of updated offerings.
|
void |
registerForChangedOfferingsForCanonicalUnit(Id canonicalUnitId)
Registers for notification of updated offerings for the given
canonical unit.
|
void |
registerForChangedOfferingsForTimePeriod(Id timePeriodId)
Registers for notification of updated offerings for the given time
period.
|
void |
registerForDeletedOffering(Id offeringId)
Registers for notification of a deleted offering.
|
void |
registerForDeletedOfferings()
Registers for notification of deleted offerings.
|
void |
registerForDeletedOfferingsForCanonicalUnit(Id canonicalUnitId)
Registers for notification of deleted offerings for the given
canonical unit.
|
void |
registerForDeletedOfferingsForTimePeriod(Id timePeriodId)
Registers for notification of updated offerings for the given time
period.
|
void |
registerForNewOfferings()
Register for notifications of new offerings.
|
void |
registerForNewOfferingsForCanonicalUnit(Id canonicalUnitId)
Registers for notification of new offerings for the given canonical
unit.
|
void |
registerForNewOfferingsForTimePeriod(Id timePeriodId)
Registers for notification of new offerings for the given time period.
|
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 canRegisterForOfferingNotifications()
Offering
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 registerForNewOfferings() throws OperationFailedException, PermissionDeniedException
OfferingReceiver.newOfferings()
is invoked when a new
Offering
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewOfferingsForCanonicalUnit(Id canonicalUnitId) throws OperationFailedException, PermissionDeniedException
OfferingReceiver.newOfferings()
is invoked when
an offering appears in this catalogue.canonicalUnitId
- the Id
of the
CanonicalUnit
to monitorNullArgumentException
- canonicalUnitId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewOfferingsForTimePeriod(Id timePeriodId) throws OperationFailedException, PermissionDeniedException
OfferingReceiver.newOfferings()
is invoked when an
offering appears in this catalogue.timePeriodId
- the Id
of the TimePeriod
to monitorNullArgumentException
- timePeriodId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedOfferings() throws OperationFailedException, PermissionDeniedException
OfferingReceiver.changedOfferings()
is invoked when an
offering in this catalogue is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedOfferingsForCanonicalUnit(Id canonicalUnitId) throws OperationFailedException, PermissionDeniedException
OfferingReceiver.changedOfferings()
is
invoked when an offering in this catalogue is updated.canonicalUnitId
- the Id
of the
CanonicalUnit
to monitorNullArgumentException
- canonicalUnitId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedOfferingsForTimePeriod(Id timePeriodId) throws OperationFailedException, PermissionDeniedException
OfferingReceiver.changedOfferings()
is invoked
when an offering in this catalogue is updated.timePeriodId
- the Id
of the TimePeriod
to monitorNullArgumentException
- timePeriodId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedOffering(Id offeringId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OfferingReceiver.changedOfferings()
is invoked when the
specified offering in this catalogue is changed.offeringId
- the Id
of the Offering
to monitorNotFoundException
- an offering was not found
identified by the given Id
NullArgumentException
- offeringId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedOfferings() throws OperationFailedException, PermissionDeniedException
OfferingReceiver.deletedOfferings()
is invoked when an
offering is removed from this catalogue.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedOfferingsForCanonicalUnit(Id canonicalUnitId) throws OperationFailedException, PermissionDeniedException
OfferingReceiver.changedOfferings()
is
invoked when an offering is remoevd from this catalogue.canonicalUnitId
- the Id
of the
CanonicalUnit
to monitorNullArgumentException
- canonicalUnitId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedOfferingsForTimePeriod(Id timePeriodId) throws OperationFailedException, PermissionDeniedException
OfferingReceiver.changedOfferings()
is invoked
when an offering is removed from this catalogue.timePeriodId
- the Id
of the TimePeriod
to monitorNullArgumentException
- timePeriodId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedOffering(Id offeringId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OfferingReceiver.deletedOfferings()
is invoked when the
specified offering is removed from this catalogue.offeringId
- the Id
of the Offering
to monitorNotFoundException
- an offering was not found
identified by the given Id
NullArgumentException
- offeringId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.