org.osid.inquiry

Interface InquestNotificationSession

All Superinterfaces:

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

public interface InquestNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Inquest 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	canRegisterForInquestNotifications() Tests if this user can register for Inquest notifications.
void	registerForChangedInquest(Id inquestId) Registers for notification of an updated inquest.
void	registerForChangedInquests() Registers for notification of updated inquests.
void	registerForDeletedInquest(Id inquestId) Registers for notification of a deleted inquest.
void	registerForDeletedInquestAncestors(Id inquestId) Registers for notification if an ancestor is removed from the specified inquest in the inquest hierarchy.
void	registerForDeletedInquestDescendants(Id inquestId) Registers for notification if a descendant is removed from fthe specified inquest in the inquest hierarchy.
void	registerForDeletedInquests() Registers for notification of deleted inquests.
void	registerForNewInquestAncestors(Id inquestId) Registers for notification if an ancestor is added to the specified inquest in the inquest hierarchy.
void	registerForNewInquestDescendants(Id inquestId) Registers for notification if a descendant is added to the specified inquest in the inquest hierarchy.
void	registerForNewInquests() Register for notifications of new inquests.

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

canRegisterForInquestNotifications

boolean canRegisterForInquestNotifications()

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

registerForNewInquests

void registerForNewInquests()
                            throws OperationFailedException,
                                   PermissionDeniedException

Register for notifications of new inquests. InquestReceiver.newInquest() is invoked when a new Inquest is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewInquestAncestors

void registerForNewInquestAncestors(Id inquestId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Registers for notification if an ancestor is added to the specified inquest in the inquest hierarchy. InquestReceiver.newInquestAncestor() is invoked when the specified inquest experiences an addition in ancestry.

Parameters:

inquestId - the Id of the inquest to monitor

Throws:

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewInquestDescendants

void registerForNewInquestDescendants(Id inquestId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Registers for notification if a descendant is added to the specified inquest in the inquest hierarchy. InquestReceiver.newInquestDescendant() is invoked when the specified inquest experiences an addition in descendants.

Parameters:

inquestId - the Id of the inquest to monitor

Throws:

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedInquests

void registerForChangedInquests()
                                throws OperationFailedException,
                                       PermissionDeniedException

Registers for notification of updated inquests. InquestReceiver.changedInquest() is invoked when an inquest is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedInquest

void registerForChangedInquest(Id inquestId)
                               throws OperationFailedException,
                                      PermissionDeniedException

Registers for notification of an updated inquest. InquestReceiver.changedInquest() is invoked when the specified inquest is changed.

Parameters:

inquestId - the Id of the Inquest to monitor

Throws:

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedInquests

void registerForDeletedInquests()
                                throws OperationFailedException,
                                       PermissionDeniedException

Registers for notification of deleted inquests. InquestReceiver.deletedInquest() is invoked when an inquest is deleted.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedInquest

void registerForDeletedInquest(Id inquestId)
                               throws OperationFailedException,
                                      PermissionDeniedException

Registers for notification of a deleted inquest. InquestReceiver.deletedInquest() is invoked when the specified inquest is deleted.

Parameters:

inquestId - the Id of the Inquest to monitor

Throws:

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedInquestAncestors

void registerForDeletedInquestAncestors(Id inquestId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Registers for notification if an ancestor is removed from the specified inquest in the inquest hierarchy. InquestReceiver.deletedInquestAncestor() is invoked when the specified inquest experiences a removal of an ancestor.

Parameters:

inquestId - the Id of the inquest to monitor

Throws:

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedInquestDescendants

void registerForDeletedInquestDescendants(Id inquestId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Registers for notification if a descendant is removed from fthe specified inquest in the inquest hierarchy. InquestReceiver.deletedInquestDescednant() is invoked when the specified inquest experiences a removal of one of its descdendents.

Parameters:

inquestId - the Id of the inquest to monitor

Throws:

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.