brahms.communication
Interface IPayloadProperties

All Known Implementing Classes:

CommunicativeAct

public interface IPayloadProperties

IPayloadProperties is an interface defining the names of required or commonly used and supported properties to define the contents of a payload.

Version:

$Revision: 1.1 $ $Date: 2007/10/10 14:02:59 $ $Author: rvhoof $

Author:

Ron van Hoof

Field Summary

static java.lang.String	ACTION Property name with as value a string specifying the action to be performed on the content (optional)
static java.lang.String	CONTENT Property name with as value an Any with the content of the message; equivalently specifies the object of the action.
static java.lang.String	CONVERSATION_ID Proprty name with as value a string with a unique conversation identifier used to identify the ongoing sequence of communicative acts that together form a conversation.
static java.lang.String	ENCODING Property name with as value a CAPayloadEncoding value specifying the encoding of the message content
static java.lang.String	IN_REPLY_TO Property name with as value a string that specifies an expression that references an earlier action to which this message is a reply.
static java.lang.String	LANGUAGE Property name with as value a string specifying the language in which the message content is expressed.
static java.lang.String	ONTOLOGY Property name with as value a CAOntologyList with the ontology(s) used to give a meaning to the symbols in the message content
static java.lang.String	PERFORMATIVE Property name with as value the type of communicative act.
static java.lang.String	PROTOCOL Propery name with as value a CAInteractionProtocol value specifying the interaction protocol that the sending actor is employing with this message.
static java.lang.String	RECEIVER Property name with as value a list with one or more Credentials for the intended recipients of the message.
static java.lang.String	REPLY_BY Property name with as value a long long that specifies the time and/or date indicating the latest time by which the sending actor would like to receive a reply.
static java.lang.String	REPLY_TO Property name with as value the Credentials of the actor to which the receiver should send responses for this message instead of using the sender of the message.
static java.lang.String	REPLY_WITH Property name with as value a string that specifies an expression that will be used by the responding actor to identify this message.
static java.lang.String	SENDER Property name with as value the Credentials of the sender of the message.
static java.lang.String	SUBJECT Property name with as value a string specifying the subject of the message (optional)

Field Detail

PERFORMATIVE

static final java.lang.String PERFORMATIVE

Property name with as value the type of communicative act.

See Also:

Constant Field Values

SENDER

static final java.lang.String SENDER

Property name with as value the Credentials of the sender of the message. (optional if the sender wishes to remain anonymous)

See Also:

Constant Field Values

RECEIVER

static final java.lang.String RECEIVER

Property name with as value a list with one or more Credentials for the intended recipients of the message.

See Also:

Constant Field Values

REPLY_TO

static final java.lang.String REPLY_TO

Property name with as value the Credentials of the actor to which the receiver should send responses for this message instead of using the sender of the message.

See Also:

Constant Field Values

ACTION

static final java.lang.String ACTION

Property name with as value a string specifying the action to be performed on the content (optional)

See Also:

Constant Field Values

SUBJECT

static final java.lang.String SUBJECT

Property name with as value a string specifying the subject of the message (optional)

See Also:

Constant Field Values

CONTENT

static final java.lang.String CONTENT

Property name with as value an Any with the content of the message; equivalently specifies the object of the action.

See Also:

Constant Field Values

LANGUAGE

static final java.lang.String LANGUAGE

Property name with as value a string specifying the language in which the message content is expressed.

See Also:

Constant Field Values

ENCODING

static final java.lang.String ENCODING

Property name with as value a CAPayloadEncoding value specifying the encoding of the message content

See Also:

Constant Field Values

ONTOLOGY

static final java.lang.String ONTOLOGY

Property name with as value a CAOntologyList with the ontology(s) used to give a meaning to the symbols in the message content

See Also:

Constant Field Values

PROTOCOL

static final java.lang.String PROTOCOL

Propery name with as value a CAInteractionProtocol value specifying the interaction protocol that the sending actor is employing with this message. If the protocol is not NO_PROTOCOL then the payload must include a non null and non empty conversation-id property. All responses to this message, within the scope of the same interaction protocol, should contain the same value for the conversation-id. The timeout value in the reply-byparameter must denote the latest time by which the sending actor would like to have received the next message in the protocol flow (not to be confused with the latest time by which the interaction protocol should terminate

See Also:

Constant Field Values

CONVERSATION_ID

static final java.lang.String CONVERSATION_ID

Proprty name with as value a string with a unique conversation identifier used to identify the ongoing sequence of communicative acts that together form a conversation. Should be globally unique.

See Also:

Constant Field Values

REPLY_WITH

static final java.lang.String REPLY_WITH

Property name with as value a string that specifies an expression that will be used by the responding actor to identify this message. The reply-with parameter is designed to be used to follow a conversation thread in a situation where multiple dialogues occur simultaneously. If actor i sends to actor j a message which contains: reply-with Actor j will respond with a message containing: in-reply-to

See Also:

Constant Field Values

IN_REPLY_TO

static final java.lang.String IN_REPLY_TO

Property name with as value a string that specifies an expression that references an earlier action to which this message is a reply.

See Also:

Constant Field Values

REPLY_BY

static final java.lang.String REPLY_BY

Property name with as value a long long that specifies the time and/or date indicating the latest time by which the sending actor would like to receive a reply.

See Also:

Constant Field Values