com.ibm.commerce.content.commands

Interface GetContentCmd

All Superinterfaces:

com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand

All Known Implementing Classes:

GetContentCmdImpl

public interface GetContentCmd
extends TaskCommand

This task command is used by the wcst:getContent tag to retrieve content.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT Copyright statement.
static java.lang.String	defaultCommandClassName The default implementation class name.
static java.lang.String	NAME The full class name for this interface file.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContent() Return the content text.
void	setIncludeHostName(boolean includeHostName) Indicates that URLs in the embedded content must be a fully qualified URLs that includes the scheme, host name and port.
void	setPreview(boolean preview) Indicates that the content URL is to be retrieved for preview mode.
void	setURL(java.lang.String url) Set the content URL.

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

execute

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

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

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

getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

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

isReadyToCallExecute, reset

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

unionDependencies

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

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

Copyright statement.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The full class name for this interface file.

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation class name. This is used if there is no record found in the CMDREG table.

Method Detail

setURL

void setURL(java.lang.String url)

Set the content URL.

Parameters:

url - content URL

setPreview

void setPreview(boolean preview)

Indicates that the content URL is to be retrieved for preview mode. Set to false to indicate that the production configuration is to be used to retrieve the content.

Parameters:

preview - preview option

setIncludeHostName

void setIncludeHostName(boolean includeHostName)

Indicates that URLs in the embedded content must be a fully qualified URLs that includes the scheme, host name and port. Set this property to true to force the URLs to be fully qualified with the content host name. For example, if the URL is intended for inclusion in an e-mail, then the embedded URLs must be fully qualified.

Parameters:

includeHostName - includeHostName option

getContent

java.lang.String getContent()

Return the content text.

Returns:

the content text