org.osid.inquiry

Interface AcknowledgementNotificationSession

All Superinterfaces:

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

public interface AcknowledgementNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Inquiry objects in this Inquest for resources related to the authenticated agent. This also includes existing inquiries that may appear or disappear due to changes in the Inquest hierarchy, 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	canRegisterForInquiryNotifications() Tests if this user can register for Inquiry notifications.
Inquest	getInquest() Gets the Inquest associated with this session.
Id	getInquestId() Gets the Inquest Id associated with this session.
void	registerForNewInquiries() Register for notifications of new inquiries needing responses for resources related to the authenticated agent.
void	registerForNewInquiriesToAcknowledge(Id auditId) Register for notifications of new inquiries needing responses for the given audit Id for resources related to the authenticated agent.

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

getInquestId

Id getInquestId()

Gets the Inquest Id associated with this session.

Returns:

the Inquest Id associated with this session

Compliance:

mandatory - This method must be implemented.

getInquest

Inquest getInquest()
                   throws OperationFailedException,
                          PermissionDeniedException

Gets the Inquest associated with this session.

Returns:

the inquest

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForInquiryNotifications

boolean canRegisterForInquiryNotifications()

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

registerForNewInquiries

void registerForNewInquiries()
                             throws OperationFailedException,
                                    PermissionDeniedException

Register for notifications of new inquiries needing responses for resources related to the authenticated agent. InquiryReceiver.newInquiries() is invoked when a new Inquiry appears in this inquest.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewInquiriesToAcknowledge

void registerForNewInquiriesToAcknowledge(Id auditId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Register for notifications of new inquiries needing responses for the given audit Id for resources related to the authenticated agent. InquiryReceiver.newInquiries() is invoked when a new Inquiry needs a response.

Parameters:

auditId - the Id of the audit to monitor

Throws:

NullArgumentException - auditId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.