com.ibm.commerce.command

Class AbstractDirectViewCommand

java.lang.Object

com.ibm.commerce.command.AbstractECCommand

com.ibm.commerce.command.AbstractViewCommand

com.ibm.commerce.command.AbstractDirectViewCommand

All Implemented Interfaces:

AccCommand, DirectViewCommand, ECCommand, ViewCommand, Protectable, com.ibm.websphere.command.Command, java.io.Serializable

Direct Known Subclasses:

HttpDirectViewCommandImpl

public abstract class AbstractDirectViewCommand
extends AbstractViewCommand
implements DirectViewCommand

This is the abstract base implementation of a direct view command.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.ibm.commerce.command.ECCommand

defaultCommandClassName

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
AbstractDirectViewCommand() This is the default constructor for this class.

Method Summary

Modifier and Type	Method and Description
static TypedProperty	createTextResponse(java.lang.String textResponse) This method prepares a TypedProperty object for sending a text response.
int	getContentLength() This method gets the length of the data.
java.lang.String	getContentType() This method gets the content type.
java.lang.Object	getRawDocument() This method gets the raw document data from the RequestProperties object.
java.io.InputStream	getTextDocument() This method gets the text document data as an input stream from the RequestProperties object.

Methods inherited from class com.ibm.commerce.command.AbstractViewCommand

fulfills, getForUserId, getOwner, getRequestProperties, getResourceOwners, getResponseProperties, getViewCommandContext, getViewName, mergeProperties, performExecute, setForUserId, setOwner, setRequestProperties, setViewCommandContext, setViewName

Methods inherited from class com.ibm.commerce.command.AbstractECCommand

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, setForUserId, setUserId, validateParameters

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.command.ViewCommand

getRequestProperties, getResponseProperties, getViewName, mergeProperties, setRequestProperties, setViewName

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, execute, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Methods inherited from interface com.ibm.websphere.command.Command

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Constructor Detail

AbstractDirectViewCommand

public AbstractDirectViewCommand()

This is the default constructor for this class. It calls the constructor from the superclass.

Method Detail

getContentLength

public final int getContentLength()

This method gets the length of the data.

Specified by:

getContentLength in interface DirectViewCommand

Returns:

This method returns the length of the data.

getContentType

public final java.lang.String getContentType()

This method gets the content type. Two examples of content types are text and html.

Specified by:

getContentType in interface DirectViewCommand

Returns:

This method returns the content type.

getRawDocument

public final java.lang.Object getRawDocument()

This method gets the raw document data from the RequestProperties object.

Specified by:

getRawDocument in interface DirectViewCommand

Returns:

This method returns the raw document object.

getTextDocument

public final java.io.InputStream getTextDocument()

This method gets the text document data as an input stream from the RequestProperties object.

Specified by:

getTextDocument in interface DirectViewCommand

Returns:

This method returns an InputStream of the text document.

createTextResponse

public static TypedProperty createTextResponse(java.lang.String textResponse)

This method prepares a TypedProperty object for sending a text response. This is done by adding the additional values to the TypedProperty object that enable it to call the DirectView.

Parameters:

textResponse - This is the text to be returned.

Returns:

This method returns a TypedProperty object representation of the given text.