com.ibm.commerce.negotiation.commands
Class ModifyForumMessageCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.ControllerCommandImpl
                    |
                    +--com.ibm.commerce.tools.command.ToolsControllerCommandImpl
                          |
                          +--com.ibm.commerce.negotiation.commands.ModifyForumMessageCmdImpl
All Implemented Interfaces:
AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, ModifyForumMessageCmd, ToolsControllerCommand
Direct Known Subclasses:
ModifyForumMessageDialogCmdImpl, ModifyForumMessageListCmdImpl

public class ModifyForumMessageCmdImpl
extends ToolsControllerCommandImpl
implements ModifyForumMessageCmd

Controller command allows an administrator to mofify the attributes of a forum message.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright statement.
protected  ForumMessageHelper fmh
          Forum helper message.
 java.util.Hashtable xmlHash
          XML hash.
 
Fields inherited from class com.ibm.commerce.command. ControllerCommandImpl
requestProperties, responseProperties, retriable, viewReqProperties
 
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.negotiation.commands. ModifyForumMessageCmd
defaultCommandClassName, NAME
 
Constructor Summary
ModifyForumMessageCmdImpl()
          ModifyForumMessageCmdImpl constructor.
 
Method Summary
 void executeModify()
          Modifies the VIEWSTATUS and/or MSGSTATUS of one or more entries in the FORUMMSG table.
protected  java.lang.String getErrorText()
          Fetches the text of an error message.
 java.lang.String getMsgAction()
          Returns the msgAction member field.
 int getMsgIdCount()
          Returns the number of msg id's available to process.
protected  java.lang.Long getMsgIdEntry(int index)
          Fetches a specific msgId.
protected  java.lang.String getViewTaskName()
          Gets the viewTaskName field.
protected  java.util.Hashtable getXmlHash()
          Accessor method.
protected  boolean isParameterError()
          Returns true if a parameter error is present.
 boolean isReadyToCallExecute()
          Verifies that the this command is ready to be executed.
 void performExecute()
          Modifies the VIEWSTATUS and/or MSGSTATUS of one or more entries in the FORUMMSG table.
protected  void setErrorText(java.lang.String newErrorText)
          Sets the error text.
 void setMsgAction(java.lang.String newMsgAction)
          Sets the msgAction member field.
protected  void setMsgIdArrayFromList(java.lang.String msgIdList)
          Sets the elements of a Long[] array from a comma-delimited list of msg_id's.
protected  void setParameterError(boolean newParameterError)
          Sets parameter error flag value.
 void setRequestProperties( TypedProperty param)
          Copies key-value input data into member fields.
protected  void setViewTaskName(java.lang.String newViewTaskName)
          Sets the viewTaskName field.
protected  void setXmlHash(java.util.Hashtable newXmlHash)
          Setter method.
 void toolsPerformExecute()
          Performs forum message modify with ECTools error handling logic.
 
Methods inherited from class com.ibm.commerce.tools.command. ToolsControllerCommandImpl
getViewInputProperties
 
Methods inherited from class com.ibm.commerce.command. ControllerCommandImpl
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties
 
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.commerce.command. ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties
 
Methods inherited from interface com.ibm.commerce.command. AccCommand
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command. ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

Field Detail
public static final java.lang.String COPYRIGHT
Copyright statement.
See Also:
Constant Field Values

fmh

protected ForumMessageHelper fmh
Forum helper message.

xmlHash

public java.util.Hashtable xmlHash
XML hash.
Constructor Detail

ModifyForumMessageCmdImpl

public ModifyForumMessageCmdImpl()
ModifyForumMessageCmdImpl constructor.
Method Detail

executeModify

public void executeModify()
                   throws ECSystemException
Modifies the VIEWSTATUS and/or MSGSTATUS of one or more entries in the FORUMMSG table.
Throws:
ECSystemException

getErrorText

protected java.lang.String getErrorText()
Fetches the text of an error message.
Returns:
java.lang.String

getMsgAction

public java.lang.String getMsgAction()
Returns the msgAction member field.
Returns:
java.lang.String

getMsgIdCount

public int getMsgIdCount()
Returns the number of msg id's available to process.
Returns:
int

getMsgIdEntry

protected java.lang.Long getMsgIdEntry(int index)
Fetches a specific msgId.
Returns:
java.lang.Long[]

getViewTaskName

protected java.lang.String getViewTaskName()
Gets the viewTaskName field.
Returns:
java.lang.String

getXmlHash

protected java.util.Hashtable getXmlHash()
Accessor method.
Returns:
java.util.Hashtable

isParameterError

protected boolean isParameterError()
Returns true if a parameter error is present.
Returns:
boolean

isReadyToCallExecute

public boolean isReadyToCallExecute()
Verifies that the this command is ready to be executed.
Overrides:
isReadyToCallExecute in class AbstractECTargetableCommand
Returns:
boolean

performExecute

public void performExecute()
                    throws ECSystemException
Modifies the VIEWSTATUS and/or MSGSTATUS of one or more entries in the FORUMMSG table.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECSystemException

setErrorText

protected void setErrorText(java.lang.String newErrorText)
Sets the error text.
Parameters:
newErrorText - java.lang.String

setMsgAction

public void setMsgAction(java.lang.String newMsgAction)
Sets the msgAction member field.
Parameters:
newMsgAction - java.lang.String

setMsgIdArrayFromList

protected void setMsgIdArrayFromList(java.lang.String msgIdList)
                              throws java.lang.NumberFormatException
Sets the elements of a Long[] array from a comma-delimited list of msg_id's.
Throws:
java.lang.NumberFormatException

setParameterError

protected void setParameterError(boolean newParameterError)
Sets parameter error flag value.
Parameters:
newParameterError - boolean

setRequestProperties

public void setRequestProperties(TypedProperty param)
                          throws ECApplicationException
Copies key-value input data into member fields.
Specified by:
setRequestProperties in interface ControllerCommand
Overrides:
setRequestProperties in class ToolsControllerCommandImpl
Parameters:
param - com.ibm.commerce.datatype.TypedProperty
Throws:
ECApplicationException

setViewTaskName

protected void setViewTaskName(java.lang.String newViewTaskName)
Sets the viewTaskName field.

setXmlHash

protected void setXmlHash(java.util.Hashtable newXmlHash)
Setter method.
Parameters:
newXmlHash - java.util.Hashtable

toolsPerformExecute

public void toolsPerformExecute()
                         throws ECSystemException
Performs forum message modify with ECTools error handling logic.
Throws:
ECSystemException