org.osid.offering

Interface OfferingNotificationSession

All Superinterfaces:

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

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.

Method Summary

Methods

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.

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.

canRegisterForOfferingNotifications

boolean canRegisterForOfferingNotifications()

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

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 notifications for offeringss 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.

registerForNewOfferings

void registerForNewOfferings()
                             throws OperationFailedException,
                                    PermissionDeniedException

Register for notifications of new offerings. OfferingReceiver.newOfferings() is invoked when a new Offering is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewOfferingsForCanonicalUnit

void registerForNewOfferingsForCanonicalUnit(Id canonicalUnitId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Registers for notification of new offerings for the given canonical unit. OfferingReceiver.newOfferings() is invoked when an offering appears in this catalogue.

Parameters:

canonicalUnitId - the Id of the CanonicalUnit to monitor

Throws:

NullArgumentException - canonicalUnitId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewOfferingsForTimePeriod

void registerForNewOfferingsForTimePeriod(Id timePeriodId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Registers for notification of new offerings for the given time period. OfferingReceiver.newOfferings() is invoked when an offering appears in this catalogue.

Parameters:

timePeriodId - the Id of the TimePeriod to monitor

Throws:

NullArgumentException - timePeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedOfferings

void registerForChangedOfferings()
                                 throws OperationFailedException,
                                        PermissionDeniedException

Registers for notification of updated offerings. OfferingReceiver.changedOfferings() is invoked when an offering in this catalogue is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedOfferingsForCanonicalUnit

void registerForChangedOfferingsForCanonicalUnit(Id canonicalUnitId)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Registers for notification of updated offerings for the given canonical unit. OfferingReceiver.changedOfferings() is invoked when an offering in this catalogue is updated.

Parameters:

canonicalUnitId - the Id of the CanonicalUnit to monitor

Throws:

NullArgumentException - canonicalUnitId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedOfferingsForTimePeriod

void registerForChangedOfferingsForTimePeriod(Id timePeriodId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Registers for notification of updated offerings for the given time period. OfferingReceiver.changedOfferings() is invoked when an offering in this catalogue is updated.

Parameters:

timePeriodId - the Id of the TimePeriod to monitor

Throws:

NullArgumentException - timePeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedOffering

void registerForChangedOffering(Id offeringId)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Registers for notification of an updated offering. OfferingReceiver.changedOfferings() is invoked when the specified offering in this catalogue is changed.

Parameters:

offeringId - the Id of the Offering to monitor

Throws:

NotFoundException - an offering was not found identified by the given Id

NullArgumentException - offeringId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedOfferings

void registerForDeletedOfferings()
                                 throws OperationFailedException,
                                        PermissionDeniedException

Registers for notification of deleted offerings. OfferingReceiver.deletedOfferings() is invoked when an offering is removed from this catalogue.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedOfferingsForCanonicalUnit

void registerForDeletedOfferingsForCanonicalUnit(Id canonicalUnitId)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Registers for notification of deleted offerings for the given canonical unit. OfferingReceiver.changedOfferings() is invoked when an offering is remoevd from this catalogue.

Parameters:

canonicalUnitId - the Id of the CanonicalUnit to monitor

Throws:

NullArgumentException - canonicalUnitId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedOfferingsForTimePeriod

void registerForDeletedOfferingsForTimePeriod(Id timePeriodId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Registers for notification of updated offerings for the given time period. OfferingReceiver.changedOfferings() is invoked when an offering is removed from this catalogue.

Parameters:

timePeriodId - the Id of the TimePeriod to monitor

Throws:

NullArgumentException - timePeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedOffering

void registerForDeletedOffering(Id offeringId)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Registers for notification of a deleted offering. OfferingReceiver.deletedOfferings() is invoked when the specified offering is removed from this catalogue.

Parameters:

offeringId - the Id of the Offering to monitor

Throws:

NotFoundException - an offering was not found identified by the given Id

NullArgumentException - offeringId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.