Interface CommunicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CommunicationSession
extends OsidSession

This session defines methods to process communications. Notifications are cancelled when this session is closed.

Method Summary

Modifier and Type	Method	Description
void	acknowledge(Id communiqueId)	Sends a nonce response indicating that operations should continue or abort.
ResponseForm	getResponseForm(Id communiqueId)	Gets the response form for submitting form-based responses.
void	registerForCommuniques()	Register for notifications of new communiques.
void	respondViaForm(ResponseForm responseForm)	Responds to a communique requiring form input.
void	respondViaOption(Id responseOptionId)	Responds to a communique requiring a response option.

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

registerForCommuniques

void registerForCommuniques()
                     throws OperationFailedException,
PermissionDeniedException

Register for notifications of new communiques. CommunicationReceiver.newCommunique() is invoked when a new Communique is sent.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

acknowledge

void acknowledge(Id communiqueId)
          throws OperationFailedException,
PermissionDeniedException

Sends a nonce response indicating that operations should continue or abort.

Parameters:

communiqueId - the Id of a communique

Throws:

IllegalStateException - Communique.respondViaOption() or Communique.respondViaForm() is true , or a response was already supplied

InvalidArgumentException - communiqueId not valid

NullArgumentException - communiqueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

respondViaOption

void respondViaOption(Id responseOptionId)
               throws OperationFailedException,
PermissionDeniedException

Responds to a communique requiring a response option.

Parameters:

responseOptionId - the Id of a response option

Throws:

IllegalStateException - Communique.respondViaOption() is false or a response was already supplied

InvalidArgumentException - responseOptionId not valid

NullArgumentException - responseOptionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getResponseForm

ResponseForm getResponseForm(Id communiqueId)
                      throws OperationFailedException,
PermissionDeniedException

Gets the response form for submitting form-based responses.

Parameters:

communiqueId - the Id of a communique

Returns:

a response form

Throws:

IllegalStateException - Communique.respondViaForm() is false

InvalidArgumentException - communiqueId not valid

NullArgumentException - communiqueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

respondViaForm

void respondViaForm(ResponseForm responseForm)
             throws OperationFailedException,
PermissionDeniedException

Responds to a communique requiring form input.

Parameters:

responseForm - a response form

Throws:

IllegalStateException - responseForm already used in a response transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - responseForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - responseForm did not originate from getResponseForm()

Compliance:

mandatory - This method must be implemented.