com.ibm.commerce.command

Interface DirectViewCommand

All Superinterfaces:

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

All Known Implementing Classes:

AbstractDirectViewCommand, HttpDirectViewCommandImpl

public interface DirectViewCommand
extends ViewCommand

This interface defines a direct view command. A direct view command is used to return raw data or text data as a stream.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

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

defaultCommandClassName

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
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.
java.io.InputStream	getTextDocument() This method gets the text document data as an input stream.

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

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Method Detail

getContentLength

int getContentLength()

This method gets the length of the data.

Returns:

This method returns the length of the data.

getContentType

java.lang.String getContentType()

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

Returns:

This method returns the content type.

getTextDocument

java.io.InputStream getTextDocument()

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

Returns:

This method returns the text document data as an input stream.

getRawDocument

java.lang.Object getRawDocument()

This method gets the raw document data.

Returns:

This method returns the raw document data.