JavaDocs for Module Development

Question

Hi All,
I need to find a documentation for the methods getMessageProperty/setMessageProperty of the Message Class in the Adapter Framework.
I have already looked into the <b>sample_ra.rar</b> from my XI installation but i couldn't find this method in there.
I'd appreciate any help.
Tks

Answer 1

Hi,
I just downloaded and extracted the sample_ra.jar file.  I was able to find the javadoc of both methods in the interface Message.  Pls see below:
============================================
getMessageProperty
public java.lang.String getMessageProperty(java.lang.String namespace,
                                           java.lang.String name)Returns the value of an additional message property, in case that such an value exists.
Parameters:
namespace - The namespace of the property to get.
name - The name of the property to get.
Returns:
The value for the given namespace/name combination, or null, when no such value exists.
============================================
setMessageProperty
public void setMessageProperty(java.lang.String namespace,
                               java.lang.String name,
                               java.lang.String value)
                        throws InvalidParamExceptionSets an additional message field, if supported by the Message profile implementation. Such additional fields will not be visible as an own table column in the MS message monitoring, since it is to be stored as part of the message header. This mechanism allows different protocol implementations to support more message fiels, as per default available in the MS Message interface. Such fields can be accessed through this API method, without casting to the specific Message implementation.
Parameters:
namespace - The namespace of the property to set.
name - The name of the property to set.
value - The value of the property to set. When null is given as the value param, an already set value will be deleted.
Throws:
InvalidParamException - If either the length of one of the parameters is too long, or in case of an unknown/not allowed namespace/name combination (but only if the Message implementation has the necessary knowledge about the valid namespace/name pairs).