Jadex 0.96-beta1

jadex.model
Class MessageType.ParameterSpecification

java.lang.Object
  extended by jadex.model.MessageType.ParameterSpecification
All Implemented Interfaces:
Serializable
Enclosing class:
MessageType

public static class MessageType.ParameterSpecification
extends Object
implements Serializable

A class representing a parameter or parameter set specification.

See Also:
Serialized Form

Constructor Summary
MessageType.ParameterSpecification(String name, Class clazz)
          Create a parameter(set) specification.
MessageType.ParameterSpecification(String name, Class clazz, boolean derived)
          Create a parameter(set) specification.
MessageType.ParameterSpecification(String name, Class clazz, String defaultvalue, String source, boolean convid)
          Create a parameter(set) specification.
 
Method Summary
 Class getClazz()
          Get the clazz of the parameter(set).
 String getDefaultValue()
          Get the default value of the parameter(set).
 String getName()
          Get the name of the parameter(set).
 String getSource()
          Get the source parameter for copying reply values (if any).
 boolean isConversationIdentifier()
          True, if this parameter can be used to identify an ongoing conversation.
 boolean isDerived()
          A derived parameter is ignored, when sending/receiving messages and only used for matching incoming messages.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MessageType.ParameterSpecification

public MessageType.ParameterSpecification(String name,
                                          Class clazz)
Create a parameter(set) specification.


MessageType.ParameterSpecification

public MessageType.ParameterSpecification(String name,
                                          Class clazz,
                                          boolean derived)
Create a parameter(set) specification.


MessageType.ParameterSpecification

public MessageType.ParameterSpecification(String name,
                                          Class clazz,
                                          String defaultvalue,
                                          String source,
                                          boolean convid)
Create a parameter(set) specification.

Method Detail

getName

public String getName()
Get the name of the parameter(set).


getClazz

public Class getClazz()
Get the clazz of the parameter(set).


getDefaultValue

public String getDefaultValue()
Get the default value of the parameter(set).


getSource

public String getSource()
Get the source parameter for copying reply values (if any).


isConversationIdentifier

public boolean isConversationIdentifier()
True, if this parameter can be used to identify an ongoing conversation.


isDerived

public boolean isDerived()
A derived parameter is ignored, when sending/receiving messages and only used for matching incoming messages.


Jadex 0.96-beta1

Submit a bug or feature
For further API reference and developer documentation, see the Jadex User Guide and the Jadex Tutorial. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, and working code examples.

Copyright (C) 2002-2007 Lars Braubach, Alexander Pokahr - University of Hamburg. Use is subject to license terms.