casa

Interface MLMessageInterface

public interface MLMessageInterface

Title: CASA Description: Interface for all messages that use a markup language.

Copyright: Copyright 2003-2014, Knowledge Science Group, University of Calgary. Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. The Knowledge Science Group makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

Version:

0.9

Author:

Rob Kremer, Chad La Fournie

Method Summary

Modifier and Type	Method and Description
void	fromString(String source)
String	getCONTENT()
String	getFROM()
String	getIN_REPLY_TO()
String	getLANGUAGE()
String	getParameter(String key)
String	getPerformative() Deprecated. use SetParameter(ML.PERFORMATIVE,String) instead
String	getRECEIVER()
String	getREPLY_WITH()
String	getSENDER()
String	getTO()
Enumeration	parameters()
void	reset()
void	setParameter(String parameter, String value)
void	setPerformative(String performative) Deprecated. use getParameter(ML.PERFORMATIVE) instead
String	toString()

Method Detail

reset

void reset()

setParameter

void setParameter(String parameter,
                  String value)

getParameter

String getParameter(String key)

setPerformative

@Deprecated
void setPerformative(String performative)

Deprecated. use getParameter(ML.PERFORMATIVE) instead

Retrieves the current performative for this message.

getPerformative

@Deprecated
String getPerformative()

Deprecated. use SetParameter(ML.PERFORMATIVE,String) instead

Sets the performative of this message. Since a message can have only one performative this method over-writes the performative if it had previously been set.

Parameters:

performative - perfomative to assign to this message

parameters

Enumeration parameters()

toString

String toString()

Overrides:

toString in class Object

fromString

void fromString(String source)
         throws MLMessageFormatException

Throws:

MLMessageFormatException

getSENDER

String getSENDER()

getRECEIVER

String getRECEIVER()

getFROM

String getFROM()

getTO

String getTO()

getREPLY_WITH

String getREPLY_WITH()

getIN_REPLY_TO

String getIN_REPLY_TO()

getLANGUAGE

String getLANGUAGE()

getCONTENT

String getCONTENT()