Interface MessagingSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface MessagingSession
extends OsidSession

This session provides a means to send messages.

Method Summary

Modifier and Type	Method	Description
boolean	canSendMessages()	Tests if this user can send messages.
MessageList	getUnsentMessages()	Gets all Messages not sent by the resource related to the authenticated agent.
void	sendMessage(Id messageId, Id recipientIdList)	Sends a Message .

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

canSendMessages

boolean canSendMessages()

Tests if this user can send messages. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 message operations to unauthorized users.

Returns:

false if sending messages is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

sendMessage

void sendMessage(Id messageId,
 Id recipientIdList)
          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Sends a Message .

Parameters:

messageId - the Id of the Message

recipientIdList - list of resource or agent recipients

Throws:

NotFoundException - messageId is not found

NullArgumentException - messageId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getUnsentMessages

MessageList getUnsentMessages()
                       throws OperationFailedException,
PermissionDeniedException

Gets all Messages not sent by the resource related to the authenticated agent. In plenary mode, the returned list contains all known unrad messages or an error results. Otherwise, the returned list may contain only those messages that are accessible through this session.

Returns:

a list of unsent Messages

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.