com.ibm.commerce.programadapter.messagemapper
Interface MessageMapper

All Known Implementing Classes:
MessageMapperGenericImpl

public interface MessageMapper

MessageMapper will convert an object into a com.ibm.commerce.datatype.CommandProperty object. If the object cannot be converted, a null object is returned.


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
           
static java.lang.String NAME
           
 
Method Summary
 CommandProperty createFromMessage(java.lang.Object message)
          Convert the given object into a com.ibm.commerce.datatype.CommandProperty object.
 void destroy()
          Cleanup when the MessageMapper is not needed anymore.
 java.lang.Integer getMessageMapperId()
          Returns the MessageMapper id.
 java.lang.String getMessageMapperName()
          Returns the MessageMapper name.
 void init(TypedProperty configuration)
          Initializes the MessageMapper based on the given configuration.
 void setMessageMapperId(java.lang.Integer messageMapperId)
          Sets the MessageMapper Id.
 void setMessageMapperName(java.lang.String name)
          Sets the MessageMapper name.
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

defaultCommandClassName

public static final java.lang.String defaultCommandClassName

NAME

public static final java.lang.String NAME
Method Detail

createFromMessage

public CommandProperty createFromMessage(java.lang.Object message)
Convert the given object into a com.ibm.commerce.datatype.CommandProperty object.
Parameters:
Object - message - the object to convert
Returns:
com.ibm.commerce.datatype.CommandProperty

destroy

public void destroy()
Cleanup when the MessageMapper is not needed anymore.

getMessageMapperId

public java.lang.Integer getMessageMapperId()
Returns the MessageMapper id.

getMessageMapperName

public java.lang.String getMessageMapperName()
Returns the MessageMapper name.

init

public void init(TypedProperty configuration)
Initializes the MessageMapper based on the given configuration.
Parameters:
com.ibm.commerce.datatype.TypedProperty - configuration.

setMessageMapperId

public void setMessageMapperId(java.lang.Integer messageMapperId)
Sets the MessageMapper Id.

setMessageMapperName

public void setMessageMapperName(java.lang.String name)
Sets the MessageMapper name.