com.ibm.commerce.command
Interface DirectViewCommand

All Superinterfaces:
AccCommand, ECCommand, Protectable, ViewCommand
All Known Implementing Classes:
AbstractDirectViewCommand

public interface DirectViewCommand
extends ViewCommand

Interface for defining a direct view command. A direct view command is used to return raw data or text data as a stream.


Field Summary
static java.lang.String COPYRIGHT
           
 
Fields inherited from interface com.ibm.commerce.command.ECCommand
defaultCommandClassName
 
Method Summary
 int getContentLength()
          Returns the length of the data.
 java.lang.String getContentType()
          Returns the content type.
 java.lang.Object getRawDocument()
          Gets the raw document data.
 java.io.InputStream getTextDocument()
          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, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, execute, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Method Detail

getContentLength

public int getContentLength()
Returns the length of the data.

Returns:
int - length

getContentType

public java.lang.String getContentType()
Returns the content type. Content type can be Text/html etc.

Returns:
String - content type

getRawDocument

public java.lang.Object getRawDocument()
Gets the raw document data.

Returns:
java.lang.Object

getTextDocument

public java.io.InputStream getTextDocument()
Gets the text document data as an input stream.

Returns:
java.io.InputStream