org.osid.offering

Interface ParticipantNotificationSession

All Superinterfaces:

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

public interface ParticipantNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Participant 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	canRegisterForParticipantNotifications() Tests if this user can register for Participant notifications.
Catalogue	getCatalogue() Gets the Catalogue associated with this session.
Id	getCatalogueId() Gets the Catalogue Id associated with this session.
void	registerForChangedParticipant(Id participantId) Registers for notification of an updated participant.
void	registerForChangedParticipants() Registers for notification of updated participants.
void	registerForChangedParticipantsForOffering(Id offeringId) Register for notifications of changed participants for the given offering.
void	registerForChangedParticipantsForResource(Id resourceId) Register for notifications of changed participants for the given resource.
void	registerForDeletedParticipant(Id participantId) Registers for notification of a deleted participants.
void	registerForDeletedParticipants() Registers for notification of deleted participants.
void	registerForDeletedParticipantsForOffering(Id offeringId) Register for notifications of deleted participants for the given offering.
void	registerForDeletedParticipantsForResource(Id resourceId) Register for notifications of deleted participants for the given resource.
void	registerForNewParticipants() Register for notifications of new participants.
void	registerForNewParticipantsForOffering(Id offeringId) Register for notifications of new participants for an offering.
void	registerForNewParticipantsForResource(Id resourceId) Register for notifications of new participants for a resource.
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.

canRegisterForParticipantNotifications

boolean canRegisterForParticipantNotifications()

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

registerForNewParticipants

void registerForNewParticipants()
                                throws OperationFailedException,
                                       PermissionDeniedException

Register for notifications of new participants. ParticipantReceiver.newParticipant() is invoked when a new Participant is appears in this catalogue.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewParticipantsForOffering

void registerForNewParticipantsForOffering(Id offeringId)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Register for notifications of new participants for an offering. ParticipantReceiver.newParticipant() is invoked when a new Participant appears in this catalogue.

Parameters:

offeringId - an offering to monitor

Throws:

NullArgumentException - offeringId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewParticipantsForResource

void registerForNewParticipantsForResource(Id resourceId)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Register for notifications of new participants for a resource. ParticipantReceiver.newParticipant() is invoked when a new Participant appears in this catalogue.

Parameters:

resourceId - a resource to monitor

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedParticipants

void registerForChangedParticipants()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Registers for notification of updated participants. ParticipantReceiver.changedParticipant() is invoked when a participant in this catalogue is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedParticipantsForOffering

void registerForChangedParticipantsForOffering(Id offeringId)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Register for notifications of changed participants for the given offering. ParticipantReceiver.changedParticipant() is invoked when a Participant for the offering in this catalogue is changed.

Parameters:

offeringId - an offering to monitor

Throws:

NullArgumentException - offeringId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedParticipantsForResource

void registerForChangedParticipantsForResource(Id resourceId)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Register for notifications of changed participants for the given resource. ParticipantReceiver.changedParticipant() is invoked when a Participant for the offering in this catalogue is changed.

Parameters:

resourceId - a resource to monitor

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedParticipant

void registerForChangedParticipant(Id participantId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Registers for notification of an updated participant. ParticipantReceiver.changedParticipant() is invoked when the specified participant in this catalogue is changed.

Parameters:

participantId - the Id of the Participant to monitor

Throws:

NotFoundException - a participant was not found identified by the given Id

NullArgumentException - participantId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedParticipants

void registerForDeletedParticipants()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Registers for notification of deleted participants. ParticipantReceiver.deletedParticipant() is invoked when a participant is removed from this catalogue.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedParticipantsForOffering

void registerForDeletedParticipantsForOffering(Id offeringId)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Register for notifications of deleted participants for the given offering. ParticipantReceiver.deletedParticipant() is invoked when a Participant for the offering is removed from this catalogue.

Parameters:

offeringId - an offering to monitor

Throws:

NullArgumentException - offeringId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedParticipantsForResource

void registerForDeletedParticipantsForResource(Id resourceId)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Register for notifications of deleted participants for the given resource. ParticipantReceiver.deletedParticipant() is invoked when a Participant for the offering is removed from this catalogue.

Parameters:

resourceId - a resource to monitor

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedParticipant

void registerForDeletedParticipant(Id participantId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Registers for notification of a deleted participants. ParticipantReceiver.deletedParticipant() is invoked when the specified participant is removed from this catalogue.

Parameters:

participantId - the Id of the Participant to monitor

Throws:

NotFoundException - a participant was not found identified by the given Id

NullArgumentException - participantId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.