OSID - osid.offering.OfferingNotificationSession Service Interface Definition

Interface	osid.offering.OfferingNotificationSession
Implements	`osid.OsidSession`
Description	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	getCatalogueId
Description	Gets the `Catalogue` `Id` associated with this session.
Return	`osid.id.Id`		the `Catalogue Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogue
Description	Gets the `Catalogue` associated with this session.
Return	`osid.offering.Catalogue`		the catalogue
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForOfferingNotifications
Description	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.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedCatalogueView
Description	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.
Method	useIsolatedCatalogueView
Description	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.
Method	registerForNewOfferings
Description	Register for notifications of new offerings. `OfferingReceiver.newOfferings()` is invoked when a new `Offering` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewOfferingsForCanonicalUnit
Description	Registers for notification of new offerings for the given canonical unit. `OfferingReceiver.newOfferings()` is invoked when an offering appears in this catalogue.
Parameters	`osid.id.Id`	`canonicalUnitId`	the `Id` of the `CanonicalUnit` to monitor
Errors	NULL_ARGUMENT		`canonicalUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewOfferingsForTimePeriod
Description	Registers for notification of new offerings for the given time period. `OfferingReceiver.newOfferings()` is invoked when an offering appears in this catalogue.
Parameters	`osid.id.Id`	`timePeriodId`	the `Id` of the `TimePeriod` to monitor
Errors	NULL_ARGUMENT		`timePeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOfferings
Description	Registers for notification of updated offerings. `OfferingReceiver.changedOfferings()` is invoked when an offering in this catalogue is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOfferingsForCanonicalUnit
Description	Registers for notification of updated offerings for the given canonical unit. `OfferingReceiver.changedOfferings()` is invoked when an offering in this catalogue is updated.
Parameters	`osid.id.Id`	`canonicalUnitId`	the `Id` of the `CanonicalUnit` to monitor
Errors	NULL_ARGUMENT		`canonicalUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOfferingsForTimePeriod
Description	Registers for notification of updated offerings for the given time period. `OfferingReceiver.changedOfferings()` is invoked when an offering in this catalogue is updated.
Parameters	`osid.id.Id`	`timePeriodId`	the `Id` of the `TimePeriod` to monitor
Errors	NULL_ARGUMENT		`timePeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOffering
Description	Registers for notification of an updated offering. `OfferingReceiver.changedOfferings()` is invoked when the specified offering in this catalogue is changed.
Parameters	`osid.id.Id`	`offeringId`	the `Id` of the `Offering` to monitor
Errors	NOT_FOUND		an offering was not found identified by the given `Id`
	NULL_ARGUMENT		`offeringId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedOfferings
Description	Registers for notification of deleted offerings. `OfferingReceiver.deletedOfferings()` is invoked when an offering is removed from this catalogue.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedOfferingsForCanonicalUnit
Description	Registers for notification of deleted offerings for the given canonical unit. `OfferingReceiver.changedOfferings()` is invoked when an offering is remoevd from this catalogue.
Parameters	`osid.id.Id`	`canonicalUnitId`	the `Id` of the `CanonicalUnit` to monitor
Errors	NULL_ARGUMENT		`canonicalUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedOfferingsForTimePeriod
Description	Registers for notification of updated offerings for the given time period. `OfferingReceiver.changedOfferings()` is invoked when an offering is removed from this catalogue.
Parameters	`osid.id.Id`	`timePeriodId`	the `Id` of the `TimePeriod` to monitor
Errors	NULL_ARGUMENT		`timePeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedOffering
Description	Registers for notification of a deleted offering. `OfferingReceiver.deletedOfferings()` is invoked when the specified offering is removed from this catalogue.
Parameters	`osid.id.Id`	`offeringId`	the `Id` of the `Offering` to monitor
Errors	NOT_FOUND		an offering was not found identified by the given `Id`
	NULL_ARGUMENT		`offeringId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.