IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.channel.sms.config
Class CommandMetaData

java.lang.Object
  extended by com.ibm.btt.channel.sms.config.CommandMetaData

public class CommandMetaData
extends java.lang.Object

SMS Command Meta Data. One CommandMetaData bean is corresponding to one SMS Command. Data bean can be initialized by configuration file of element factory. Used by request handler to parse the SMS command


Field Summary
(package private)  java.lang.String bttOperationName
           
(package private)  java.util.List<CommandParamter> parameters
           
(package private)  java.lang.String shortCode
           
 
Constructor Summary
CommandMetaData()
           
 
Method Summary
 java.lang.String getBttOperationName()
          get BTT operation name to be executed for SMS command
 java.util.List<CommandParamter> getParameters()
          Parameter list of the SMS Command.
 java.lang.String getShortCode()
          Shortcode of SMS Command.
 boolean hasOptionalParam()
          Check if the param list contains optional parameter.
 void setBttOperationName(java.lang.String bttOperationName)
          Set BTT operation name
 void setParameters(java.util.List<CommandParamter> parameters)
          Parameter list of the SMS Command.
 void setShortCode(java.lang.String shortCode)
          Shortcode of SMS Command.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

shortCode

java.lang.String shortCode

bttOperationName

java.lang.String bttOperationName

parameters

java.util.List<CommandParamter> parameters
Constructor Detail

CommandMetaData

public CommandMetaData()
Method Detail

getBttOperationName

public java.lang.String getBttOperationName()
get BTT operation name to be executed for SMS command

Returns:
BTT operation name

setBttOperationName

public void setBttOperationName(java.lang.String bttOperationName)
Set BTT operation name

Parameters:
bttOperationName -

getParameters

public java.util.List<CommandParamter> getParameters()
Parameter list of the SMS Command. The parameters should be defined by sequence.

Returns:

setParameters

public void setParameters(java.util.List<CommandParamter> parameters)
Parameter list of the SMS Command. The parameters should be defined by sequence.

Parameters:
parameters -

getShortCode

public java.lang.String getShortCode()
Shortcode of SMS Command. It is usually the first word of the message

Returns:

setShortCode

public void setShortCode(java.lang.String shortCode)
Shortcode of SMS Command. It is usually the first word of the message

Parameters:
shortCode -

hasOptionalParam

public boolean hasOptionalParam()
                         throws SMSHandlerException
Check if the param list contains optional parameter. Only one optional param is permited for a SMS command.

Returns:
true if contains one optional param
Throws:
java.lang.Exception
SMSHandlerException

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011