com.ibm.commerce.messaging.commands
Class MessagingAdminCmd
com.ibm.commerce.command.AbstractECTargetableCommand
|
+--com.ibm.commerce.command.ControllerCommandImpl
|
+--com.ibm.commerce.tools.command.ToolsControllerCommandImpl
|
+--com.ibm.commerce.messaging.commands.MessagingAdminCmd
- All Implemented Interfaces:
- AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, Protectable, ToolsControllerCommand
- Direct Known Subclasses:
- AttributesUpdateCmdImpl, CISEditAttCreateCmdImpl, CISEditAttUpdateCmdImpl, MessagingProfileCmdImpl, MessagingProfileCreateCmdImpl, MessagingProfileDeleteCmdImpl, MessagingProfileUpdateCmdImpl, StoreTransCreateCmdImpl, StoreTransUpdateCmdImpl
- public class MessagingAdminCmd
- extends ToolsControllerCommandImpl
Helper class for success handling, error handling and reading from an XML object.
Field Summary |
static java.lang.String |
COPYRIGHT
The internal copyright field. |
Method Summary |
TypedProperty |
createSuccessResponse(java.lang.String xmlFile,
java.lang.String navigation,
ECMessage ecm)
Create a success response. |
TypedProperty |
createSuccessResponseForDynamicList(ECMessage ecm)
Create a success response for dynamic list. |
java.lang.String |
getOptionalParameter(java.util.Hashtable xmlRoot,
java.lang.String name)
Get optional parameter. |
java.lang.String |
getOptionalParameter(java.util.Hashtable xmlRoot,
java.lang.String prefix,
java.lang.String name)
Get optional parameter. |
java.lang.String |
getRequiredParameter(java.util.Hashtable xmlRoot,
java.lang.String name,
java.lang.String xmlFile,
java.lang.String navigation)
Get required parameter. |
java.lang.String |
getRequiredParameter(java.util.Hashtable xmlRoot,
java.lang.String prefix,
java.lang.String name,
java.lang.String xmlFile,
java.lang.String navigation)
Get required parameter. |
void |
throwException(ECMessage ecm,
java.lang.String method,
java.lang.String navigation,
java.lang.String param1,
java.lang.String param2)
Throws and ECException based on the request properties and passed parameters. |
void |
throwException(TypedProperty res_prop,
java.lang.String xmlFile,
ECMessage ecm,
java.lang.String classname,
java.lang.String method,
java.lang.String navigation,
java.lang.String param1,
java.lang.String param2)
Throw exception. |
Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl |
fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties |
Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand |
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, performExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters |
Methods inherited from interface com.ibm.commerce.command.ControllerCommand |
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties |
Methods inherited from interface com.ibm.commerce.command.ECCommand |
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters |
COPYRIGHT
public static final java.lang.String COPYRIGHT
- The internal copyright field.
MessagingAdminCmd
public MessagingAdminCmd()
createSuccessResponse
public TypedProperty createSuccessResponse(java.lang.String xmlFile,
java.lang.String navigation,
ECMessage ecm)
- Create a success response.
Creation date: (10/30/00 1:08:20 PM)
- Parameters:
msg
- java.lang.String- Returns:
- com.ibm.commerce.datatype.TypedProperty
createSuccessResponseForDynamicList
public TypedProperty createSuccessResponseForDynamicList(ECMessage ecm)
- Create a success response for dynamic list.
Creation date: (10/30/00 1:08:20 PM)
- Parameters:
msg
- java.lang.String- Returns:
- com.ibm.commerce.datatype.TypedProperty
getOptionalParameter
public java.lang.String getOptionalParameter(java.util.Hashtable xmlRoot,
java.lang.String name)
- Get optional parameter.
Creation date: (6/1/00 7:39:22 PM)
- Parameters:
value
- java.lang.String
getOptionalParameter
public java.lang.String getOptionalParameter(java.util.Hashtable xmlRoot,
java.lang.String prefix,
java.lang.String name)
- Get optional parameter.
Creation date: (6/1/00 7:39:22 PM)
- Parameters:
value
- java.lang.String
getRequiredParameter
public java.lang.String getRequiredParameter(java.util.Hashtable xmlRoot,
java.lang.String name,
java.lang.String xmlFile,
java.lang.String navigation)
throws ECException
- Get required parameter.
Creation date: (6/1/00 7:39:22 PM)
- Parameters:
value
- java.lang.String
getRequiredParameter
public java.lang.String getRequiredParameter(java.util.Hashtable xmlRoot,
java.lang.String prefix,
java.lang.String name,
java.lang.String xmlFile,
java.lang.String navigation)
throws ECException
- Get required parameter.
Creation date: (6/1/00 7:39:22 PM)
- Parameters:
value
- java.lang.String
throwException
public void throwException(ECMessage ecm,
java.lang.String method,
java.lang.String navigation,
java.lang.String param1,
java.lang.String param2)
throws ECApplicationException
- Throws and ECException based on the request properties and passed parameters.
- Parameters:
exc
- com.ibm.commerce.exception.ECExceptionmethod
- java.lang.Stringparam1
- java.lang.Stringparam2
- java.lang.String- Throws:
ECApplicationException
-
throwException
public void throwException(TypedProperty res_prop,
java.lang.String xmlFile,
ECMessage ecm,
java.lang.String classname,
java.lang.String method,
java.lang.String navigation,
java.lang.String param1,
java.lang.String param2)
throws ECApplicationException
- Throw exception.
Creation date: (10/13/00 12:07:52 AM)
- Parameters:
exc
- com.ibm.commerce.exception.ECExceptionmethod
- java.lang.Stringparam1
- java.lang.Stringparam2
- java.lang.String- Throws:
ECApplicationException
- The exception description.