Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

brahms.communication
Class CommunicativeActFactory

java.lang.Object
  extended by brahms.communication.CommunicativeActFactory

public class CommunicativeActFactory
extends java.lang.Object

CommunicativeActFactory is a factory providing methods to create new CommunicativeActs.

Version:
$Revision: 1.1 $ $Date: 2007/10/10 14:02:58 $ $Author: rvhoof $
Author:
Ron van Hoof

Constructor Summary
CommunicativeActFactory()
           
 
Method Summary
static CommunicativeAct createCommunicativeAct(IActiveInstance sender, IActiveInstance receiver, IActiveInstance replyTo, Performative performative, boolean generateConversationID, java.lang.String action, java.lang.String subject, IContext ctx)
          Creates a new communicative act object populated with the specified information
static CommunicativeAct createCommunicativeAct(IActiveInstance sender, IActiveInstance receiver, IActiveInstance replyTo, Performative performative, java.lang.String conversationID, java.lang.String action, java.lang.String subject, IContext ctx)
          Creates a new communicative act object populated with the specified information
static CommunicativeAct createCommunicativeAct(IActiveInstance sender, IActiveInstance receiver, Performative performative, boolean generateConversationID, java.lang.String action, java.lang.String subject, IContext ctx)
          Creates a new communicative act object populated with the specified information
static CommunicativeAct createCommunicativeAct(IActiveInstance sender, IActiveInstance receiver, Performative performative, java.lang.String conversationID, java.lang.String action, java.lang.String subject, IContext ctx)
          Creates a new communicative act object populated with the specified information
protected static CommunicativeAct createCommunicativeAct(Performative performative, java.lang.String action, IContext ctx)
          Creates an empty communicative act object for which only the Performative and action are specified as the minimum properties to define the name of the CommunicativeAct.
static java.lang.String createConversationID(CommunicativeAct ca)
          Generates a conversation id for a CommunicativeAct.
static CommunicativeAct populateCommunicativeAct(CommunicativeAct ca, IActiveInstance sender, IActiveInstance receiver, IActiveInstance replyTo, Performative performative, java.lang.String conversationID, java.lang.String action, java.lang.String subject, IContext ctx)
          Populates the specified communicative act with the specified information
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CommunicativeActFactory

public CommunicativeActFactory()
Method Detail

createCommunicativeAct

public static final CommunicativeAct createCommunicativeAct(IActiveInstance sender,
                                                            IActiveInstance receiver,
                                                            IActiveInstance replyTo,
                                                            Performative performative,
                                                            boolean generateConversationID,
                                                            java.lang.String action,
                                                            java.lang.String subject,
                                                            IContext ctx)
                                                     throws ExternalException
Creates a new communicative act object populated with the specified information

Parameters:
sender - the sender of the message
receiver - the receiver of the message
replyTo - the actor to reply to when replying to the message
performative - the message type
generateConversationID - generate a conversation-id for the message
action - the action to be taken by the receiver
subject - the subject of the message
ctx - the IContext specifying contextual information necessary to interact with agents and objects.
Returns:
CommunicativeAct a new CommunicativeAct object wrapping the Brahms CommunicativeAct
Throws:
ExternalException - if an unexpected internal error occurs.

createCommunicativeAct

public static final CommunicativeAct createCommunicativeAct(IActiveInstance sender,
                                                            IActiveInstance receiver,
                                                            IActiveInstance replyTo,
                                                            Performative performative,
                                                            java.lang.String conversationID,
                                                            java.lang.String action,
                                                            java.lang.String subject,
                                                            IContext ctx)
                                                     throws ExternalException
Creates a new communicative act object populated with the specified information

Parameters:
sender - the sender of the message
receiver - the receiver of the message
replyTo - the actor to reply to when replying to the message
performative - the message type
conversationID - the conversation-id for the message
action - the action to be taken by the receiver
subject - the subject of the message
ctx - the IContext specifying contextual information necessary to interact with agents and objects.
Returns:
CommunicativeAct a new CommunicativeAct object wrapping the Brahms CommunicativeAct
Throws:
ExternalException - if an unexpected internal error occurs.

createCommunicativeAct

public static final CommunicativeAct createCommunicativeAct(IActiveInstance sender,
                                                            IActiveInstance receiver,
                                                            Performative performative,
                                                            boolean generateConversationID,
                                                            java.lang.String action,
                                                            java.lang.String subject,
                                                            IContext ctx)
                                                     throws ExternalException
Creates a new communicative act object populated with the specified information

Parameters:
sender - the sender of the message
receiver - the receiver of the message
performative - the message type
generateConversationID - generate a conversation-id for the message
action - the action to be taken by the receiver
subject - the subject of the message
ctx - the IContext specifying contextual information necessary to interact with agents and objects.
Returns:
CommunicativeAct a new CommunicativeAct object wrapping the Brahms CommunicativeAct
Throws:
ExternalException - if an unexpected internal error occurs.

createCommunicativeAct

public static final CommunicativeAct createCommunicativeAct(IActiveInstance sender,
                                                            IActiveInstance receiver,
                                                            Performative performative,
                                                            java.lang.String conversationID,
                                                            java.lang.String action,
                                                            java.lang.String subject,
                                                            IContext ctx)
                                                     throws ExternalException
Creates a new communicative act object populated with the specified information

Parameters:
sender - the sender of the message
receiver - the receiver of the message
performative - the message type
conversationID - the conversation-id for the message
action - the action to be taken by the receiver
subject - the subject of the message
ctx - the IContext specifying contextual information necessary to interact with agents and objects.
Returns:
CommunicativeAct a new CommunicativeAct object wrapping the Brahms CommunicativeAct
Throws:
ExternalException - if an unexpected internal error occurs.

createCommunicativeAct

protected static final CommunicativeAct createCommunicativeAct(Performative performative,
                                                               java.lang.String action,
                                                               IContext ctx)
                                                        throws ExternalException
Creates an empty communicative act object for which only the Performative and action are specified as the minimum properties to define the name of the CommunicativeAct. The action and performative are not populated in the CommunicativeAct!

Parameters:
performative - the message type
action - the action to be taken by the receiver
ctx - the IContext specifying contextual information necessary to interact with agents and objects.
Returns:
CommunicativeAct a new CommunicativeAct object wrapping the Brahms CommunicativeAct
Throws:
ExternalException - if an unexpected internal error occurs.

populateCommunicativeAct

public static final CommunicativeAct populateCommunicativeAct(CommunicativeAct ca,
                                                              IActiveInstance sender,
                                                              IActiveInstance receiver,
                                                              IActiveInstance replyTo,
                                                              Performative performative,
                                                              java.lang.String conversationID,
                                                              java.lang.String action,
                                                              java.lang.String subject,
                                                              IContext ctx)
                                                       throws ExternalException
Populates the specified communicative act with the specified information

Parameters:
ca - the CommunicativeAct to be populated
sender - the sender of the message
receiver - the receiver of the message
replyTo - the actor to reply to when replying to the message
performative - the message type
conversationID - the conversation-id for the message
action - the action to be taken by the receiver
subject - the subject of the message
ctx - the IContext specifying contextual information necessary to interact with agents and objects.
Returns:
CommunicativeAct the populated CommunicativeAct object wrapping the Brahms CommunicativeAct
Throws:
ExternalException - if an unexpected internal error occurs.

createConversationID

public static final java.lang.String createConversationID(CommunicativeAct ca)
                                                   throws ExternalException
Generates a conversation id for a CommunicativeAct.

Parameters:
ca - the CommunicativeAct for which to generate a conversation id
Returns:
String the conversation identifier
Throws:
ExternalException - in case of an internal error
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 1997-2012 All Rights Reserved.