|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.commerce.messaging.composer.Composer
Creates the content of a message by calling a view based on the given device formats.
Field Summary | |
static java.lang.String |
EC_DEVICEFORMAT
|
static java.lang.String |
EC_JSPERROR
|
static java.lang.String |
LanguageID
|
Constructor Summary | |
Composer()
Constructs the Composer object. |
|
Composer(java.lang.String view,
CommandContext comContext,
TypedProperty inparms,
java.util.Vector formats)
Constructs the Composer Object. |
|
Composer(java.lang.String view,
CommandContext comContext,
TypedProperty inparms,
java.util.Vector formats,
java.lang.Integer languageId)
Constructs the Composer Object. |
|
Composer(java.lang.String view,
CommandContext comContext,
TypedProperty inparms,
java.util.Vector formats,
java.lang.String languageId)
Constructs the Composer Object. |
Method Summary | |
ComposerResult |
compose()
Call the MessagingViewCommand to return a TypedProperty object that will contain a result key that will have a value which is the output when the view command is executed. |
CommandContext |
getCommandContext()
Gets the commandContext property (com.ibm.commerce.command.CommandContext) value. |
java.util.Vector |
getDeviceFormats()
Gets the deviceFormat property (java.util.Vector) value. |
TypedProperty |
getInputParms()
Gets the inputParms property (com.ibm.commerce.datatype.TypedProperty) value. |
java.lang.Integer |
getLanguageId()
Gets the languageId property (java.lang.Integer) value. |
TypedProperty |
getOutputParms()
Gets the outputParms property (com.ibm.commerce.datatype.TypedProperty) value. |
java.lang.String |
getURLResult(java.lang.Integer format)
Call the view and returns the generated output. |
java.lang.String |
getViewName()
Gets the viewName property (java.lang.String) value. |
void |
setCommandContext(CommandContext commandContext)
Sets the commandContext property (com.ibm.commerce.command.CommandContext) value. |
void |
setDeviceFormats(java.util.Vector deviceFormats)
Sets the deviceFormat property (java.util.Vector) value. |
void |
setInputParms(TypedProperty inputParms)
Sets the inputParms property (com.ibm.commerce.datatype.TypedProperty) value. |
void |
setLanguageId(java.lang.Integer languageId)
Sets the languageId property (java.lang.Integer) value. |
void |
setOutputParms(TypedProperty outputParms)
Sets the outputParms property (com.ibm.commerce.datatype.TypedProperty) value. |
void |
setViewName(java.lang.String viewName)
Sets the viewName property (java.lang.String) value. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String EC_DEVICEFORMAT
public static final java.lang.String EC_JSPERROR
public static final java.lang.String LanguageID
Constructor Detail |
public Composer()
public Composer(java.lang.String view, CommandContext comContext, TypedProperty inparms, java.util.Vector formats)
view
- java.lang.String The view to call.comContext
- com.ibm.commerce.command.CommandContext The command context when the view is called.inparms
- com.ibm.commerce.datatype.TypedProperty The request properties of the view.transports
- java.util.Vector All the device formats used to call the view.public Composer(java.lang.String view, CommandContext comContext, TypedProperty inparms, java.util.Vector formats, java.lang.Integer languageId)
view
- java.lang.String The view to call.comContext
- com.ibm.commerce.command.CommandContext The command context when the view is called.inparms
- com.ibm.commerce.datatype.TypedProperty The request properties of the view.transports
- java.util.Vector All the device formats used to call the view.languageId
- java.lang.Integer The language Id when calling the view.public Composer(java.lang.String view, CommandContext comContext, TypedProperty inparms, java.util.Vector formats, java.lang.String languageId)
view
- java.lang.String The view to call.comContext
- com.ibm.commerce.command.CommandContext The command context when the view is called.inparms
- com.ibm.commerce.datatype.TypedProperty The request properties of the view.transports
- java.util.Vector All the device formats used to call the view.languageId
- java.lang.String The language Id when calling the view.Method Detail |
public ComposerResult compose() throws ECException
public CommandContext getCommandContext()
setCommandContext(com.ibm.commerce.command.CommandContext)
public java.util.Vector getDeviceFormats()
#setDeviceFormat
public TypedProperty getInputParms()
setInputParms(com.ibm.commerce.datatype.TypedProperty)
public java.lang.Integer getLanguageId()
setLanguageId(java.lang.Integer)
public TypedProperty getOutputParms()
setOutputParms(com.ibm.commerce.datatype.TypedProperty)
public java.lang.String getURLResult(java.lang.Integer format) throws ECException
format
- java.lang.String The device format of the view.ECException
- public java.lang.String getViewName()
setViewName(java.lang.String)
public void setCommandContext(CommandContext commandContext)
commandContext
- The new value for the property.getCommandContext()
public void setDeviceFormats(java.util.Vector deviceFormats)
deviceFormat
- The new value for the property.#getDeviceFormat
public void setInputParms(TypedProperty inputParms)
inputParms
- The new value for the property.getInputParms()
public void setLanguageId(java.lang.Integer languageId)
languageId
- The new value for the property.getLanguageId()
public void setOutputParms(TypedProperty outputParms)
outputParms
- The new value for the property.getOutputParms()
public void setViewName(java.lang.String viewName)
viewName
- The new value for the property.getViewName()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |