Interface AcknowledgementNotificationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AcknowledgementNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Inquiries 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.