org.osid.recognition

Interface ConvocationNotificationSession

All Superinterfaces:

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

public interface ConvocationNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Convocation 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	canRegisterForConvocationNotifications() Tests if this user can register for Convocation notifications.
Academy	getAcademy() Gets the Academy associated with this session.
Id	getAcademyId() Gets the Academy Id associated with this session.
void	registerForChangedConvocation(Id convocationId) Registers for notification of an updated convocation.
void	registerForChangedConvocations() Registers for notification of updated convocations.
void	registerForDeletedConvocation(Id convocationId) Registers for notification of a deleted convocation.
void	registerForDeletedConvocations() Registers for notification of deleted convocations.
void	registerForNewConvocations() Register for notifications of new convocations.
void	useFederatedAcademyView() Federates the view for methods in this session.
void	useIsolatedAcademyView() 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

getAcademyId

Id getAcademyId()

Gets the Academy Id associated with this session.

Returns:

the Academy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAcademy

Academy getAcademy()
                   throws OperationFailedException,
                          PermissionDeniedException

Gets the Academy associated with this session.

Returns:

the academy

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForConvocationNotifications

boolean canRegisterForConvocationNotifications()

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

useFederatedAcademyView

void useFederatedAcademyView()

Federates the view for methods in this session. A federated view will include convocations in academies which are children of this academy in the academy hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedAcademyView

void useIsolatedAcademyView()

Isolates the view for methods in this session. An isolated view restricts retrievals to this academy only.

Compliance:

mandatory - This method is must be implemented.

registerForNewConvocations

void registerForNewConvocations()
                                throws OperationFailedException,
                                       PermissionDeniedException

Register for notifications of new convocations. ConvocationReceiver.newConvocations() is invoked when a new Convocation is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedConvocations

void registerForChangedConvocations()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Registers for notification of updated convocations. ConvocationReceiver.changedConvocations() is invoked when a convocation is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedConvocation

void registerForChangedConvocation(Id convocationId)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Registers for notification of an updated convocation. ConvocationReceiver.changedConvocations() is invoked when the specified convocation is changed.

Parameters:

convocationId - the Id of the Convocation to monitor

Throws:

NullArgumentException - convocationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedConvocations

void registerForDeletedConvocations()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Registers for notification of deleted convocations. ConvocationReceiver.deletedConvocations() is invoked when a convocation is deleted.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedConvocation

void registerForDeletedConvocation(Id convocationId)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Registers for notification of a deleted convocation. ConvocationReceiver.deletedConvocations() is invoked when the specified convocation is deleted.

Parameters:

convocationId - the Id of the Convocation to monitor

Throws:

NullArgumentException - convocationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.