com.ibm.commerce.command
Interface CommandContext

All Superinterfaces:
java.lang.Cloneable
All Known Implementing Classes:
CommandContextImpl

public interface CommandContext
extends java.lang.Cloneable

The command context contains session and user information. It is set in the controller command before the execute method is called


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 java.lang.Long becomeUser(java.lang.Long userId)
          Become another user.
 java.lang.String buildRedirectUrl(TypedProperty prop)
          Returns a redirect url based on the properties.
 void changeStore(java.lang.Integer newValue)
          Changes the store and store associated information
 java.lang.Object clone()
          This method returns a clone of this command context.
 void generateLogId()
          Generate a Log Id.
 long getActivityId()
          Gets the activity ID associated with this command.
 boolean getAsyncCommand()
          Returns true if this command is an asynchronize command.
 boolean getClearForUser()
          Returns true if the parameter for clearing the for User Id is set.
 ECCommand getCommand()
          Gets the command associated with this command context.
 java.lang.String getCommandName()
          Gets the name of the command.
 java.lang.String getCountry()
          Gets the 2 character country code associated with this command.
 java.lang.String getCurrency()
          Gets the currency associated with this request.
 java.lang.String getCurrentCommandName()
          Gets the interface name of the current command.
 java.lang.String getCurrentTradingAgreementIdsAsString()
          Reserved for IBM internal use.
 TradingAgreementAccessBean[] getCurrentTradingAgreements()
          Gets the current set of trading agreements.
 java.lang.Integer getDefaultDeviceFormat()
          Gets the default device type.
 DeviceFormatAdapter getDeviceFormatAdapter()
          Gets the device format adapter associated with this command.
 java.lang.Integer getDeviceFormatId()
          Gets the device format id for the adapter associated with this request.
 java.lang.Integer getDeviceFormatTypeId()
          Gets the device type associated with this request.
 java.lang.Integer getDeviceType()
          Gets the device format type id for the adapter associated with this request.
 java.lang.String getDocumentPathName(java.lang.String baseName)
          Returns the actual output document path name give a base name
 java.lang.String[] getEligibleTradingAgreementIds()
          Gets the eligible trading agreemnt ids as an array.
 java.lang.String getEligibleTradingAgreementIdsAsString()
          Reserved for IBM internal use.
 java.lang.String getEncCurContr()
          Reserved for IBM internal use.
 java.lang.String getEncElgContr()
          Reserved for IBM internal use.
 java.lang.String getEncoding()
          Returns the character encoding.
 java.lang.String getEncParOrg()
          Reserved for IBM internal use.
 java.lang.String getEncParOrgAndCurContr()
          Reserved for IBM internal use.
 java.lang.String getEncSesContr()
          Reserved for IBM internal use.
 java.lang.String getErrorViewName()
          Gets the error view name.
 java.sql.Timestamp getExpiryDate()
          Gets the expiry date of a cached page.
 java.lang.Integer getForStoreId()
          Gets the forStoreId.
 java.lang.Long getForUserId()
          Gets the for user ID for this request.
 java.lang.Integer getInitialPreferredLanguage()
          Gets the preferred language Id for this request.
 java.lang.String getLanguage()
          Gets the 2 character language code associated with this command.
 java.lang.Integer getLanguageId()
          Gets the language Id associated with this request.
 java.util.Locale getLocale()
          Returns the locale associated with this request.
 java.util.Locale getLocale(java.lang.Integer languageId)
          Returns the locale associated with a given language.
 java.lang.String getLocaleVariant()
          Gets the locale variant associated with this request.
 long getLogId()
          Gets the Log id.
 StoreAccessBean getNonNullStore()
          Returns a non null store access bean object.
 java.lang.Long getOriginalUserId()
          Gets the user Id for the caller of this request.
 java.lang.String getParentOrg()
          Reserved for IBM internal use.
 java.lang.String getPreferredCurrency()
          Gets the preferred currency associated with this request.
 java.lang.Integer getPreferredLanguage()
          Gets the preferred language Id for this request.
 java.lang.String getRedirectionURL()
          Gets the redirect URL for this request.
 java.lang.String getRemoteAddr()
          Gets the address of the remote host.
 java.lang.String getRemoteHost()
          Gets the name of the remote host.
 java.lang.Object getRequest()
          Gets the controller request object associated with this request.
 TypedProperty getRequestProperties()
          Gets the request properties associated with this request.
 java.lang.String getResolvedQueryString()
          Gets the resolved request properties as a queryString.
 java.lang.Object getResponse()
          Gets the response object associated with this request.
 boolean getResult()
          Returns true when the command is successful.
 SessionContext getSessionContext()
          Return a session context associated with this request.
 SessionData getSessionData()
          Gets the sessionData associated with this request.
 java.lang.String getSessionTradingAgreementIdsAsString()
          Reserved for IBM internal use.
 StoreAccessBean getStore()
          Gets the Store Access Bean associated with this request.
 StoreAccessBean getStore(java.lang.Integer storeId)
          Returns a Store Access Bean give a store Id.
 java.lang.Integer getStoreId()
          Gets the store Id for this request.
 java.sql.Timestamp getTimestamp()
          Gets the timestamp when the request starts.
 TradingAgreementAccessBean getTradingAgreement(java.lang.Long id)
          Gets a trading agreement given an id.
 TradingAgreementAccessBean getTradingAgreement(java.lang.String id)
          Gets a trading agreement given an id.
 CustomProperties getTransactionCache()
          Gets the cache of custom properties.
 boolean getUncacheable()
          Returns true if page cannot be cached
 java.lang.String getUniqueSessionTag()
          Return a tag that is unique for the session.
 com.ibm.commerce.user.objects.UserAccessBean getUser()
          Gets the user access bean for the user of this request.
 java.lang.Long getUserId()
          Gets the user Id for the caller of this request.
 java.lang.String getViewCommand()
          Gets the view task associated with this command.
 java.lang.String getWebpath()
          Returns the web path for an Http request.
 void invalidateTradingAgreement(java.lang.Long id)
          Remove a trading agreement from cache.
 void invalidateTradingAgreement(java.lang.String id)
          Remove a trading agreement from cache.
 boolean isCacheTarget()
          Returns true if this command is a cache target.
 boolean isResponseNecessary()
          Returns true if response is necessary for this command.
 boolean isSecure()
          Returns true if this is an https commands and returns false otherwise.
 boolean isStoreCommand()
          Returns true if this is a store command.
 void resetStoreRef()
          Resets the EJB reference to the StoreAccessBean.
 void resetTradingAgreementInfo()
          Resets all trading agreement information.
 void restoreStore()
          Restore store and store associated information
 void restoreUser(java.lang.Long user)
          Restore to original user.
 void setActivityId(long newValue)
          Sets the activity ID associated with this command.
 void setAsyncCommand(boolean newValue)
          Sets the value to indicate whether this is an asynchronize command.
 void setCacheTarget(boolean newValue)
          Sets the isCacheTarget value for this command.
 void setCommand(ECCommand command)
          Sets the command associated with this command context.
 void setCommandName(java.lang.String value)
          Sets the command name.
 void setCountry(java.lang.String value)
          Sets the 2 character country code associated with this command.
 void setCurrency(java.lang.String value)
          Sets the currency to be used for this command.
 void setCurrentCommandName(java.lang.String name)
          Sets the interface name of the current command to be executed.
 void setCurrentTradingAgreements(TradingAgreementAccessBean[] contracts)
          Sets the current trading agreements.
 void setDefaultDeviceFormat(java.lang.Integer newValue)
          Sets the default device format type for this request.
 void setDeviceFormatAdapter(DeviceFormatAdapter newValue)
          Sets the device format adapter used for this request.
 void setDeviceFormatId(java.lang.Integer newValue)
          Sets the device format id for this request.
 void setDeviceFormatTypeId(java.lang.Integer newValue)
          Sets the device format type id for this request.
 void setDeviceType(java.lang.Integer newValue)
          Sets the device format type id for this request.
 void setEligibleTradingAgreementIdsAsString(java.lang.String newValue)
          Reserved for IBM internal use.
 void setEncCurContr(java.lang.String newValue)
          Reserved for IBM internal use.
 void setEncElgContr(java.lang.String newValue)
          Reserved for IBM internal use.
 void setEncoding(java.lang.String encoding)
          Sets the character encoding.
 void setEncParOrg(java.lang.String newValue)
          Reserved for IBM internal use.
 void setEncSesContr(java.lang.String newValue)
          Reserved for IBM internal use.
 void setErrorViewName(java.lang.String value)
          Sets the error view name.
 void setExpiryDate(java.sql.Timestamp newValue)
          Sets the expiry date for a cached page.
 void setForStoreId(java.lang.Integer val)
          Sets the forStoreId.
 void setForUserId(java.lang.Long value)
          Sets the for User Id for this request.
 void setLanguage(java.lang.String value)
          Sets the negotiated language for this command.
 void setLanguageId(java.lang.Integer newValue)
          Sets the negotiated language Id associated with this command.
 void setLocale(java.util.Locale newValue)
          Sets the locale for the command.
 void setLocaleVariant(java.lang.String value)
          Sets the locale variant to be used for this request.
 void setPreferredCurrency(java.lang.String value)
          Sets the preferred currency for the user for this command.
 void setPreferredLanguage(java.lang.Integer value)
          Sets the preferred language for this request.
 void setRedirectionURL(java.lang.String value)
          Sets the redirect URL name .
 void setRemoteAddr(java.lang.String newRemoteAddr)
          Sets the remote host address.
 void setRemoteHost(java.lang.String newRemoteHost)
          Sets the remote host name.
 void setRequest(java.lang.Object value)
          Sets the controller request object associated with this command.
 void setRequestProperties(TypedProperty prop)
          Sets the request property object associated with this request.
 void setResponse(java.lang.Object value)
          Sets the response object associated with this command.
 void setResponseNecessary(boolean newValue)
          Sets the isSecure value for this command.
 void setResult(boolean newValue)
          Sets the result for this command.This is for internal use by the framework only.
 void setSecure(boolean newValue)
          Sets the isSecure value for this command.
 void setSessionContext(SessionContext sessionContext)
          Sets the SessionContext object associated with this request.
 void setSessionData(SessionData sessionData)
          Sets the SessionData object associated with this request.
 void setSessionTradingAgreementIdsAsString(java.lang.String newValue)
          Reserved for IBM internal use.
 void setStore(StoreAccessBean newValue)
          Sets the store associated with this command.
 void setStoreCommand(boolean value)
          Sets the value for store command.
 void setStoreId(java.lang.Integer newValue)
          Sets the store Id associated with this command.
 void setTimestamp(java.sql.Timestamp value)
          Sets the timestamp for the comamnd.
 CustomProperties setTransactionCache(CustomProperties aCustomProperties)
          Sets the cache of custom properties.
 void setUncacheable(boolean newValue)
          Sets the value to indicate whether a page should be cached or not.
 void setUniqueSessionTag(java.lang.String value)
          Sets a tag that is unique for the session.
 void setUserId(java.lang.Long value)
          Sets the user Id for this request.
 void setViewCommand(java.lang.String value)
          Sets the view name for this command.
 void setWebpath(java.lang.String webpath)
          Sets the webpath associated with this command.
 boolean userCanExecuteCommand( AccCommand command)           Reserved for IBM internal use.
 

Field Detail
public static final java.lang.String COPYRIGHT
Method Detail

becomeUser

public java.lang.Long becomeUser(java.lang.Long userId)
Become another user.

buildRedirectUrl

public java.lang.String buildRedirectUrl(TypedProperty prop)
                                  throws ECApplicationException
Returns a redirect url based on the properties.
Parameters:
prop - TypedProperty - parameters for the redirect url
ECApplicationException

clone

public java.lang.Object clone()
This method returns a clone of this command context.

generateLogId

public void generateLogId()
Generate a Log Id. This is for internal use only.

getActivityId

public long getActivityId()
Gets the activity ID associated with this command. This is used by the Logging component.
Returns:
the activity Id

getAsyncCommand

public boolean getAsyncCommand()
Returns true if this command is an asynchronize command.
Returns:
boolean - asynchronize command

getUncacheable

public boolean getUncacheable()
Returns true if page cannot be cached
Returns:
boolean

getClearForUser

public boolean getClearForUser()
Returns true if the parameter for clearing the for User Id is set. This method is for internal use only
Returns:
boolean

getCommand

public ECCommand getCommand()
Gets the command associated with this command context.
Returns:
ECCommand

getCommandName

public java.lang.String getCommandName()
Gets the name of the command.
Returns:
java.lang.String

getCountry

public java.lang.String getCountry()
Gets the 2 character country code associated with this command.
Returns:
country code

getCurrency

public java.lang.String getCurrency()
                             throws ECSystemException
Gets the currency associated with this request.
Returns:
the currency
Throws:
ECSystemException

getCurrentCommandName

public java.lang.String getCurrentCommandName()
Gets the interface name of the current command.
Returns:
String - current command interface name

getCurrentTradingAgreements

public TradingAgreementAccessBean[] getCurrentTradingAgreements()
                                                         throws ECException
Gets the current set of trading agreements.
Returns:
TradingAgreementAccessBean[]
ECException

getDefaultDeviceFormat

public java.lang.Integer getDefaultDeviceFormat()
Gets the default device type. This default device type is used to locate a view command implementation from the viewreg when no view command is defined for the input device type.
Returns:
default device type

getDeviceFormatAdapter

public DeviceFormatAdapter getDeviceFormatAdapter()
Gets the device format adapter associated with this command.
Returns:
DeviceFormatAdapter

getDeviceFormatId

public java.lang.Integer getDeviceFormatId()
Gets the device format id for the adapter associated with this request.
Returns:
the device format Id

getDeviceFormatTypeId

public java.lang.Integer getDeviceFormatTypeId()
Gets the device type associated with this request. The device type is used for locating view commands from the viewreg.
Returns:
Integer

getDeviceType

public java.lang.Integer getDeviceType()
Gets the device format type id for the adapter associated with this request.
Returns:
Integer

getDocumentPathName

public java.lang.String getDocumentPathName(java.lang.String baseName)
Returns the actual output document path name give a base name
Parameters:
baseName - String - base name of the document
Returns:
String - actual output document name

getEligibleTradingAgreementIds

public java.lang.String[] getEligibleTradingAgreementIds()
                                                  throws ECException
Gets the eligible trading agreemnt ids as an array.
Returns:
String[] - array of trading agreement Ids
ECException

getEligibleTradingAgreementIdsAsString

public java.lang.String getEligibleTradingAgreementIdsAsString()
Reserved for IBM internal use. Gets the eligible trading agreement ids as a string seperated by ";" For Internal use only.
Returns:
String

getExpiryDate

public java.sql.Timestamp getExpiryDate()
Gets the expiry date of a cached page.
Returns:
TimeStamp

getForUserId

public java.lang.Long getForUserId()
                            throws ECException
Gets the for user ID for this request.
Returns:
Long - user Id
ECException

getInitialPreferredLanguage

public java.lang.Integer getInitialPreferredLanguage()
Gets the preferred language Id for this request.
Returns:
Integer
Throws:
ECSystemException

getLanguage

public java.lang.String getLanguage()
Gets the 2 character language code associated with this command.
Returns:
java.lang.String

getLanguageId

public java.lang.Integer getLanguageId()
                                throws ECSystemException
Gets the language Id associated with this request.
Returns:
Integer
Throws:
ECSystemException

getLocale

public java.util.Locale getLocale()
Returns the locale associated with this request.
Returns:
Locale

getLocale

public java.util.Locale getLocale(java.lang.Integer languageId)
Returns the locale associated with a given language.
Returns:
Locale

getLocaleVariant

public java.lang.String getLocaleVariant()
Gets the locale variant associated with this request.
Returns:
java.lang.String

getLogId

public long getLogId()
Gets the Log id. This method is for internal use only.
Returns:
long

getNonNullStore

public StoreAccessBean getNonNullStore()
                                throws ECSystemException
Returns a non null store access bean object. An exception is thrown if the StoreAccessBean object accociated with this command is null.
Returns:
StoreAccessBean, - non null store access bean object
Throws:
ECSystemException

getOriginalUserId

public java.lang.Long getOriginalUserId()
Gets the user Id for the caller of this request. This method is for internal use only.
Returns:
The original user id.

getPreferredCurrency

public java.lang.String getPreferredCurrency()
                                      throws ECSystemException
Gets the preferred currency associated with this request.
Returns:
java.lang.String
Throws:
ECSystemException

getPreferredLanguage

public java.lang.Integer getPreferredLanguage()
                                       throws ECSystemException
Gets the preferred language Id for this request.
Returns:
Integer
Throws:
ECSystemException

getRedirectionURL

public java.lang.String getRedirectionURL()
Gets the redirect URL for this request.
Returns:
String

getRemoteAddr

public java.lang.String getRemoteAddr()
Gets the address of the remote host.
Returns:
java.lang.String

getRemoteHost

public java.lang.String getRemoteHost()
Gets the name of the remote host.
Returns:
java.lang.String

getRequest

public java.lang.Object getRequest()
Gets the controller request object associated with this request.
Returns:
Object - the request object

getRequestProperties

public TypedProperty getRequestProperties()
Gets the request properties associated with this request.
Returns:
the request properties

getResolvedQueryString

public java.lang.String getResolvedQueryString()
Gets the resolved request properties as a queryString.
Returns:
the resolved query string

getResponse

public java.lang.Object getResponse()
Gets the response object associated with this request.
Returns:
the response object

getResult

public boolean getResult()
Returns true when the command is successful. This method is for internal use only.
Returns:
boolean

getSessionContext

public SessionContext getSessionContext()
                                 throws ECException
Return a session context associated with this request. This method is for internal use only.
Returns:
SessionContext
Throws:
ECException

getSessionData

public SessionData getSessionData()
Gets the sessionData associated with this request. This method is for internal use only.
Returns:
SessionData - the sessionData

getSessionTradingAgreementIdsAsString

public java.lang.String getSessionTradingAgreementIdsAsString()
                                                       throws ECException
Reserved for IBM internal use. Gets the session trading agreement ids as a string seperated by ";" For Internal use only.
Returns:
String
ECException

getStore

public StoreAccessBean getStore()
                         throws ECSystemException
Gets the Store Access Bean associated with this request. It will return null if no store is associated with this request.
Returns:
StoreAccessBean
ECSystemException

getStore

public StoreAccessBean getStore(java.lang.Integer storeId)
                         throws ECSystemException
Returns a Store Access Bean give a store Id.
Returns:
StoreAccessBean
ECSystemException

getStoreId

public java.lang.Integer getStoreId()
Gets the store Id for this request.
Returns:
Integer - the store Id

getTimestamp

public java.sql.Timestamp getTimestamp()
Gets the timestamp when the request starts. This method is for internal use only.
Returns:
Timestamp

getTradingAgreement

public TradingAgreementAccessBean getTradingAgreement(java.lang.Long id)
                                               throws ECException
Gets a trading agreement given an id.
Parameters:
id - Long - trading agreement id
Returns:
TradingAgreementAccessBean
ECException

getTradingAgreement

public TradingAgreementAccessBean getTradingAgreement(java.lang.String id)
                                               throws ECException
Gets a trading agreement given an id.
Parameters:
id - String - trading agreement id
Returns:
TradingAgreementAccessBean
ECException

getUniqueSessionTag

public java.lang.String getUniqueSessionTag()
Return a tag that is unique for the session. This method is for internal use only.
Returns:
java.lang.String

getUser

public com.ibm.commerce.user.objects.UserAccessBean getUser()
                                                     throws ECSystemException
Gets the user access bean for the user of this request. Returns null if no user is defined.
Returns:
UserAccessBean
ECSystemException

getUserId

public java.lang.Long getUserId()
Gets the user Id for the caller of this request.
Returns:
Long

getViewCommand

public java.lang.String getViewCommand()
Gets the view task associated with this command.
Returns:
view command name

getWebpath

public java.lang.String getWebpath()
Returns the web path for an Http request. This method is for internal use only.
Returns:
java.lang.String

invalidateTradingAgreement

public void invalidateTradingAgreement(java.lang.Long id)
                                throws ECException
Remove a trading agreement from cache.
Parameters:
id - Long - trading agreement id.
ECException

invalidateTradingAgreement

public void invalidateTradingAgreement(java.lang.String id)
                                throws ECException
Remove a trading agreement from cache.
Parameters:
id - String - trading agreement id.
ECException

isCacheTarget

public boolean isCacheTarget()
Returns true if this command is a cache target. This method is for internal use only.
Returns:
boolean - cacheTarget

isResponseNecessary

public boolean isResponseNecessary()
Returns true if response is necessary for this command. This method is for internal use only.

isSecure

public boolean isSecure()
Returns true if this is an https commands and returns false otherwise.

isStoreCommand

public boolean isStoreCommand()
Returns true if this is a store command. This implied that the store directory will be automatically added to the document path for any forward view command. This method is for internal use only.

resetStoreRef

public void resetStoreRef()
Resets the EJB reference to the StoreAccessBean. This is for internal use only.

resetTradingAgreementInfo

public void resetTradingAgreementInfo()
Resets all trading agreement information.

restoreUser

public void restoreUser(java.lang.Long user)
Restore to original user. This is for internal use only.
Parameters:
user - Long - original user Id

setActivityId

public void setActivityId(long newValue)
Sets the activity ID associated with this command. This is for internal use only.

setAsyncCommand

public void setAsyncCommand(boolean newValue)
Sets the value to indicate whether this is an asynchronize command.
Parameters:
newValue - boolean - true for asynchronize command

setUncacheable

public void setUncacheable(boolean newValue)
Sets the value to indicate whether a page should be cached or not. This method is for internal use only.
Parameters:
newValue - boolean

setCacheTarget

public void setCacheTarget(boolean newValue)
Sets the isCacheTarget value for this command. This method is for internal use only.
Parameters:
newValue - boolean

setCommand

public void setCommand(ECCommand command)
Sets the command associated with this command context. This method is for internal use only.
Parameters:
command - ECCommand

setCommandName

public void setCommandName(java.lang.String value)
Sets the command name. This method is used by the command framework only.
Parameters:
value - language java.lang.String

setCountry

public void setCountry(java.lang.String value)
Sets the 2 character country code associated with this command.

setCurrency

public void setCurrency(java.lang.String value)
Sets the currency to be used for this command.

setCurrentCommandName

public void setCurrentCommandName(java.lang.String name)
Sets the interface name of the current command to be executed.

setCurrentTradingAgreements

public void setCurrentTradingAgreements(TradingAgreementAccessBean[] contracts)
Sets the current trading agreements. This method is for internal use only.

setDefaultDeviceFormat

public void setDefaultDeviceFormat(java.lang.Integer newValue)
Sets the default device format type for this request.

setDeviceFormatAdapter

public void setDeviceFormatAdapter(DeviceFormatAdapter newValue)
Sets the device format adapter used for this request. This method is for use by the framework only.

setDeviceFormatId

public void setDeviceFormatId(java.lang.Integer newValue)
Sets the device format id for this request. This method is for internal use by the framwork only.
Parameters:
newValue - java.lang.Integer - device format id

setDeviceFormatTypeId

public void setDeviceFormatTypeId(java.lang.Integer newValue)
Sets the device format type id for this request. This method is for internal use by the framework only.
Parameters:
newValue - java.lang.Integer - device format type id

setDeviceType

public void setDeviceType(java.lang.Integer newValue)
Sets the device format type id for this request. This method is for internal use by the framework only.
Parameters:
newValue - java.lang.Integer - device format type id

setEligibleTradingAgreementIdsAsString

public void setEligibleTradingAgreementIdsAsString(java.lang.String newValue)
Reserved for IBM internal use. Sets the eligible trading agreement ids as a string. For Internal use only.

setExpiryDate

public void setExpiryDate(java.sql.Timestamp newValue)
Sets the expiry date for a cached page. This method is for internal use only.
Parameters:
newValue - - TimeStamp

setForUserId

public void setForUserId(java.lang.Long value)
Sets the for User Id for this request. This method is for internal used by the framework only.

setLanguage

public void setLanguage(java.lang.String value)
Sets the negotiated language for this command. This is for internal use by the framework only.
Parameters:
value - language java.lang.String - a 2 characeter String that represents the language

setLanguageId

public void setLanguageId(java.lang.Integer newValue)
Sets the negotiated language Id associated with this command. This method is for internal use by the framework.
Parameters:
newValue - java.lang.Integer

setLocale

public void setLocale(java.util.Locale newValue)
Sets the locale for the command. This method is for internal use by the framework.

setLocaleVariant

public void setLocaleVariant(java.lang.String value)
Sets the locale variant to be used for this request. This method is for internal use by the framework.
Parameters:
value - language java.lang.String

setPreferredCurrency

public void setPreferredCurrency(java.lang.String value)
Sets the preferred currency for the user for this command. This method is for internal use by the framework only.
Parameters:
value - java.lang.String - a characeter String that represents the currency

setPreferredLanguage

public void setPreferredLanguage(java.lang.Integer value)
Sets the preferred language for this request. This is for internal use by the command framework only.

setRedirectionURL

public void setRedirectionURL(java.lang.String value)
Sets the redirect URL name . This method is for internal use by the framework.
Parameters:
value - String - redirect URL name

setRemoteAddr

public void setRemoteAddr(java.lang.String newRemoteAddr)
Sets the remote host address.

setRemoteHost

public void setRemoteHost(java.lang.String newRemoteHost)
Sets the remote host name.
Parameters:
newRemoteHost - java.lang.String

setRequest

public void setRequest(java.lang.Object value)
Sets the controller request object associated with this command. This is for internal used by the framework only.

setRequestProperties

public void setRequestProperties(TypedProperty prop)
Sets the request property object associated with this request. This is used by the framework only.

setResponse

public void setResponse(java.lang.Object value)
Sets the response object associated with this command. This method is for internal use by the framework only.
Parameters:
value - Object - response object.

setResponseNecessary

public void setResponseNecessary(boolean newValue)
Sets the isSecure value for this command. This method is for internal use by the framework only.
Parameters:
newValue - boolean

setResult

public void setResult(boolean newValue)
Sets the result for this command.This is for internal use by the framework only.
Parameters:
newValue - boolean

setSecure

public void setSecure(boolean newValue)
Sets the isSecure value for this command. This method is for internal use by the framework only.
Parameters:
newValue - boolean

setSessionContext

public void setSessionContext(SessionContext sessionContext)
Sets the SessionContext object associated with this request. This method is for internal use by the framework only.
Parameters:
sessionContext - SessionContext

setSessionData

public void setSessionData(SessionData sessionData)
Sets the SessionData object associated with this request. This method is for internal use by the framework only.
Parameters:
sessionData - SessionData

setSessionTradingAgreementIdsAsString

public void setSessionTradingAgreementIdsAsString(java.lang.String newValue)
Reserved for IBM internal use. Sets the session trading agreemnt ids as a string. This method is for internal use only.

setStore

public void setStore(StoreAccessBean newValue)
Sets the store associated with this command. This method is for internal use by the framework only.

setStoreCommand

public void setStoreCommand(boolean value)
Sets the value for store command. True if this is a store level command. False otherwise.
Parameters:
value - boolean

setStoreId

public void setStoreId(java.lang.Integer newValue)
Sets the store Id associated with this command. This method is for internal use by the command framework only.

setTimestamp

public void setTimestamp(java.sql.Timestamp value)
Sets the timestamp for the comamnd. This method is for internal use only.
Parameters:
value - Timestamp

setUniqueSessionTag

public void setUniqueSessionTag(java.lang.String value)
                         throws ECException
Sets a tag that is unique for the session. This method is for internal use by the framework only.
Parameters:
value - - java.lang.String
ECException

setUserId

public void setUserId(java.lang.Long value)
Sets the user Id for this request. This method is for internal used by the framework only.

setViewCommand

public void setViewCommand(java.lang.String value)
Sets the view name for this command. This method is for internal use by the framework only.
Parameters:
value - String - view name

setWebpath

public void setWebpath(java.lang.String webpath)
Sets the webpath associated with this command. This method is for internal use by the framework only.
Parameters:
webpath - String

userCanExecuteCommand

public boolean userCanExecuteCommand(AccCommand command)
                              throws ECException
Reserved for IBM internal use. This methods checks whether the user can execute a command. This method is for internal use by the framework only.
Returns:
true - if user can execute command false - if user cannot execute command
Throws:
ECException -

getErrorViewName

public java.lang.String getErrorViewName()
Gets the error view name. This method is used by the command framework.
Returns:
String

setErrorViewName

public void setErrorViewName(java.lang.String value)
Sets the error view name. This method is used by the command framework only.
Parameters:
value - language java.lang.String

changeStore

public void changeStore(java.lang.Integer newValue)
Changes the store and store associated information

restoreStore

public void restoreStore()
Restore store and store associated information

setEncElgContr

public void setEncElgContr(java.lang.String newValue)
Reserved for IBM internal use. Sets the encrypted eligible contracts.
Parameters:
newValue - The eligible contracts

getEncElgContr

public java.lang.String getEncElgContr()
Reserved for IBM internal use. Gets the encrypted eligible contracts.
Returns:
java.lang.String

getEncParOrgAndCurContr

public java.lang.String getEncParOrgAndCurContr()
Reserved for IBM internal use. Gets the encrypted parent organization and current contract.
Returns:
java.lang.String

getEncCurContr

public java.lang.String getEncCurContr()
Reserved for IBM internal use. Gets the encrypted current contracts.
Returns:
java.lang.String

getEncParOrg

public java.lang.String getEncParOrg()
Reserved for IBM internal use. Gets the encrypted parent organization.
Returns:
java.lang.String

getEncSesContr

public java.lang.String getEncSesContr()
Reserved for IBM internal use. Gets the encrypted session contracts.
Returns:
encrypted session contracts.

setEncCurContr

public void setEncCurContr(java.lang.String newValue)
Reserved for IBM internal use. Sets the encrypted current contracts.
Parameters:
newValue - encrypted current contracts.

setEncParOrg

public void setEncParOrg(java.lang.String newValue)
Reserved for IBM internal use. Sets the encrypted parent organization.
Parameters:
newValue - encrypted parent organization

setEncSesContr

public void setEncSesContr(java.lang.String newValue)
Reserved for IBM internal use. Sets the encrypted session contract.
Parameters:
newValue - encrypted session contract

getCurrentTradingAgreementIdsAsString

public java.lang.String getCurrentTradingAgreementIdsAsString()
                                                       throws ECException
Reserved for IBM internal use. Gets the current trading agreement ids as a string seperated by "." For Internal use only.
Returns:
String
ECException

getParentOrg

public java.lang.String getParentOrg()
Reserved for IBM internal use. Gets the parent Organization.
Returns:
java.lang.String

getForStoreId

public java.lang.Integer getForStoreId()
Gets the forStoreId.
Returns:
the forStoreId

setForStoreId

public void setForStoreId(java.lang.Integer val)
Sets the forStoreId.
Parameters:
val - The forStoreId

getEncoding

public java.lang.String getEncoding()
Returns the character encoding.
Returns:
character encoding.

setEncoding

public void setEncoding(java.lang.String encoding)
Sets the character encoding.
Parameters:
encoding - The character encoding to set

getTransactionCache

public CustomProperties getTransactionCache()
Gets the cache of custom properties. Creates it if it does not yet exist. When adding an Object to this cache, use the following naming conventions to avoid naming collisions:
Returns:
the custom properties. Guaranteed not to return null;

setTransactionCache

public CustomProperties setTransactionCache(CustomProperties aCustomProperties)
Sets the cache of custom properties. The cache contents can be cleared by the CommandContext at any time.
Returns:
the previous cache of custom properties.