com.ibm.commerce.command
Class CommandContextImpl

java.lang.Object
  |
  +--com.ibm.commerce.command.CommandContextImpl
All Implemented Interfaces:
java.lang.Cloneable, CommandContext

public class CommandContextImpl
extends java.lang.Object
implements CommandContext

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


Nested Class Summary
 class CommandContextImpl.UserDependantInfo
           
 
Field Summary
protected  long activityId
           
protected  DeviceFormatAdapter adapter
           
protected   CommandContextImpl.UserDependantInfo curUserInfo
           
 java.lang.String preferredCurrency
           
 java.lang.Integer preferredLanguage
           
protected  java.lang.Object request
           
protected  java.lang.Object response
           
protected  java.lang.String webpath
           
 
Fields inherited from interface com.ibm.commerce.command. CommandContext
COPYRIGHT
 
Constructor Summary
CommandContextImpl()
          Default CommandContextImpl Constructor.
 
Method Summary
 java.lang.Long becomeUser(java.lang.Long userId)
          Become another user.
 java.lang.String buildRedirectUrl(TypedProperty prop)
          Returns a redirect url with the properties are part of parameters for the url.
 boolean canUserExecuteCommand( AccCommand command)
          This methods checks whether the user can execute a command.
 void changeStore(java.lang.Integer newValue)
          Changes the store and store associated information
 void changeUser(java.lang.Long newValue)
          Reserved for IBM internal use.
 void clearForUser()
          Clear for user parameter.
 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 getCachePage()
          Reserved for IBM internal use.
 boolean getClearForUser()
          Returns true if the parameter for clearing the for User Id is set.
 ECCommand getCommand()
          Gets the command.
 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 negotiated currency code associated with this request.
 java.lang.String getCurrentCommandName()
          Gets the class name of the current command.
 java.lang.String getCurrentTradingAgreementIdsAsString()
          Reserved for IBM internal use.
 TradingAgreementAccessBean[] getCurrentTradingAgreements()
          Gets the current set of trading agreements.
 com.ibm.commerce.command.CommandContextImpl.StoreDependantInfo getCurStoreInfo()
          Gets the curStoreInfo.
  CommandContextImpl.UserDependantInfo getCurUserInfo()
          Gets the curUserInfo.
 java.lang.Integer getDefaultDeviceFormat()
          Gets the default device type to be used for this request.
 DeviceFormatAdapter getDeviceFormatAdapter()
          Gets the device format adapter associated with this request.
 java.lang.Integer getDeviceFormatId()
          Gets the device format Id associated with this request.
 java.lang.Integer getDeviceFormatTypeId()
          Gets the device format type associated with this request.
 java.lang.Integer getDeviceType()
          Gets the device format type associated with this request.
 java.lang.String getDocumentPathName(java.lang.String baseName)
          Return the output document path name based on a base name.
 java.lang.String[] getEligibleTradingAgreementIds()
          Gets the eligible trading agreemnt ids as an array for type contract only.
 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 for a cached page.
 java.lang.Integer getForStoreId()
          Gets the forStoreId.
 java.lang.Long getForUserId()
          Gets the for user ID for this command.
  CommandContextImpl.UserDependantInfo getForUserInfo()
          Gets the forUserInfo
 java.lang.Integer getInitialPreferredLanguage()
          Gets the preferred language Id for this request.
 java.lang.Integer getInvokerStoreId()
          Gets the original store id.
 java.lang.String getLanguage()
          Gets the language associated with this request.
 java.lang.Integer getLanguageId()
          Gets the negotiated language Id for this request.
 java.util.Locale getLocale()
          Returns the locale for this command.
 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.
 java.util.ArrayList getNewStores()
          Gets the newStores
 StoreAccessBean getNonNullStore()
          Returns a non null store access bean object.
  CommandContextImpl.UserDependantInfo getOrgUserInfo()
          Gets the orgUserInfo
 java.lang.Long getOriginalUserId()
          Gets the user ID for the caller of this request.
 java.lang.String getParentOrg()
          Reserved for IBM internal use.
 java.util.ArrayList getParentStores()
          Gets the parentStores
 java.lang.String getPreferredCurrency()
          Gets the preferred currency code 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 request object associated with this request.
 TypedProperty getRequestProperties()
          Gets the request properties associated with this request.
 java.lang.String getResolvedQueryString()
          Gets the interpreted request properties as a queryString.
 java.lang.Object getResponse()
          Gets the response object associated with this request.
 boolean getResult()
          Gets the result of this request.
 com.ibm.commerce.adapter.SessionContext getSessionContext()
          Gets the SessionContext associated with this request.
 SessionData getSessionData()
          Gets the session data associated with this request.
 java.lang.String getSessionTradingAgreementIdsAsString()
          Reserved for IBM internal use.
 StoreAccessBean getStore()
          Gets the store access bean for this request.
 StoreAccessBean getStore(java.lang.Integer aStoreId)
          Gets the store access bean based on a store Id.
 java.lang.Integer getStoreId()
          Gets the store Id for this request.
 java.sql.Timestamp getTimestamp()
          Gets the current timestamp.
 TradingAgreementAccessBean getTradingAgreement(java.lang.Long id)
          Gets the trading agreement given an id.
 TradingAgreementAccessBean getTradingAgreement(java.lang.String id)
          Gets the trading agreement given an id.
 CustomProperties getTransactionCache()
          Gets the cache of custom properties.
 boolean getUncacheable()
          Gets the uncacheable value.
 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.
protected  TradingAgreementAccessBean[] getValidTradingAgreements(TradingAgreementAccessBean[] inTAs)
          Gets the valid set of trading agreements.
 java.lang.String getViewCommand()
          Gets the view name with this request.
 java.lang.String getWebpath()
          Gets the web path associated with this 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 this is an https commands and returns false otherwise.
 boolean isSecure()
          Returns true if this is a https command, returns false otherwise.
 boolean isStoreCommand()
          Returns true if this is a store command.
protected static java.lang.String removeTradingAgreementFromTradingAgreementIds(java.lang.String taIds, java.lang.String id)
          Remove a trading agreement Id from the input trading agremment id string.
 void resetStoreRef()
          Resets the EJB reference for the store associated with this command.
 void resetTradingAgreementInfo()
          Resets all trading agreement information.
 void restoreStore()
          Restore store and store associated information
 void restoreUser(java.lang.Long uId)
          Restores to original user.
 void setActivityId(long newActivityId)
          Sets the activity ID associated with this command.
 void setAsyncCommand(boolean newValue)
          Sets the value to indicate whether this is an asynchronize command.
 void setCachePage(boolean newValue)
          Reserved for IBM internal use.
 void setCacheTarget(boolean newValue)
          Sets the isCacheTarget value for this command.
 void setCommand(ECCommand aCommand)
          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 negotiated currency to be used for this request.
 void setCurrentCommandName(java.lang.String name)
          Sets the class name of the current command to be executed.
 void setCurrentTradingAgreementIdsAsString(java.lang.String newValue)
          Sets the session trading agreemnt ids as a string.
 void setCurrentTradingAgreements(TradingAgreementAccessBean[] newValue)
          Sets the current trading agreements.
 void setCurStoreInfo(com.ibm.commerce.command.CommandContextImpl.StoreDependantInfo curStoreInfo)
          Sets the curStoreInfo.
 void setCurUserInfo( CommandContextImpl.UserDependantInfo curUserInfo)
          Sets the curUserInfo.
 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 newEncCurContr)
          Reserved for IBM internal use.
 void setEncElgContr(java.lang.String newEncElgContr)
          Reserved for IBM internal use.
 void setEncoding(java.lang.String encoding)
          Sets the character encoding.
 void setEncParOrg(java.lang.String newEncParOrg)
          Reserved for IBM internal use.
 void setEncSesContr(java.lang.String newEncSesContr)
          Reserved for IBM internal use.
 void setErrorViewName(java.lang.String value)
          Sets the error view name.
 void setExpiryDate(java.sql.Timestamp value)
          Sets the expiry date for a cached page.
 void setForStoreId(java.lang.Integer val)
          Sets the forStoreId.
 void setForUserId(java.lang.Long userId)
          Sets the user Id for this request.
 void setForUserInfo( CommandContextImpl.UserDependantInfo forUserInfo)
          Sets the forUserInfo
 void setLanguage(java.lang.String value)
          Sets the negotiated language for this command.
 void setLanguageId(java.lang.Integer value)
          Sets the negotiated language Id for 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 setNewStores(java.util.ArrayList newStores)
          Sets the newStores
 void setOrgUserInfo( CommandContextImpl.UserDependantInfo orgUserInfo)
          Sets the orgUserInfo
 void setParentOrg(java.lang.String newParentOrg)
          Insert the method's description here.
 void setParentStores(java.util.ArrayList parentStores)
          Sets the parentStores
 void setPreferredCurrency(java.lang.String value)
          Sets the preferred currency to use for this request.
 void setPreferredLanguage(java.lang.Integer value)
          Sets the preferred language for this request.
 void setRedirectionURL(java.lang.String url)
          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 value)
          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.
 void setSecure(boolean newValue)
          Sets the isSecure value for this command.
 void setSessionContext(com.ibm.commerce.adapter.SessionContext aSessionContext)
          Sets the SessionContext object associated with this request.
 void setSessionData(SessionData value)
          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)
          Returns true if this is a store level 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 newUserReferenceNumber)
          Sets the user Id for this request.
 void setViewCommand(java.lang.String view)
          Sets the view name for this command.
 void setWebpath(java.lang.String newValue)
          Sets the webpath associated with this command.
 boolean userCanExecuteCommand( AccCommand command)
          Reserved for IBM internal use.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.commerce.command. CommandContext
setSessionContext
 

Field Detail

request

protected java.lang.Object request

response

protected java.lang.Object response

activityId

protected long activityId

webpath

protected java.lang.String webpath

adapter

protected DeviceFormatAdapter adapter

curUserInfo

protected CommandContextImpl.UserDependantInfo curUserInfo

preferredCurrency

public java.lang.String preferredCurrency

preferredLanguage

public java.lang.Integer preferredLanguage
Constructor Detail

CommandContextImpl

public CommandContextImpl()
Default CommandContextImpl Constructor.
Method Detail

becomeUser

public java.lang.Long becomeUser(java.lang.Long userId)
Become another user. This method is for internal use by the framework only.
Specified by:
becomeUser in interface CommandContext
Parameters:
userId - Long

buildRedirectUrl

public java.lang.String buildRedirectUrl(TypedProperty prop)
                                  throws ECApplicationException
Returns a redirect url with the properties are part of parameters for the url.
Specified by:
buildRedirectUrl in interface CommandContext
Parameters:
prop - TypedProperty - parameters for the redirect url
ECApplicationException

canUserExecuteCommand

public final boolean canUserExecuteCommand(AccCommand command)
                                    throws ECException
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
ECException

getInvokerStoreId

public java.lang.Integer getInvokerStoreId()
Gets the original store id.
Returns:
returns the original store Id.

changeStore

public void changeStore(java.lang.Integer newValue)
Changes the store and store associated information
Specified by:
changeStore in interface CommandContext

restoreStore

public void restoreStore()
Restore store and store associated information
Specified by:
restoreStore in interface CommandContext

clone

public java.lang.Object clone()
This method returns a clone of this command context.
Specified by:
clone in interface CommandContext
Overrides:
clone in class java.lang.Object

generateLogId

public final void generateLogId()
Generate a Log Id. This is for internal use only.
Specified by:
generateLogId in interface CommandContext

getActivityId

public final long getActivityId()
Gets the activity ID associated with this command. This method is for internal use by the framework only.
Specified by:
getActivityId in interface CommandContext
Returns:
long - the activity Id

getAsyncCommand

public boolean getAsyncCommand()
Returns true if this command is an asynchronize command. This method is for internal use by the framework only
Specified by:
getAsyncCommand in interface CommandContext
Returns:
boolean - asynchronize command

getUncacheable

public final boolean getUncacheable()
Gets the uncacheable value. Returns false if page has to be cached. True otherwise. This method is for internal use only.
Specified by:
getUncacheable in interface CommandContext
Returns:
boolean - the uncacheable value

getClearForUser

public final boolean getClearForUser()
Returns true if the parameter for clearing the for User Id is set. This method is for internal use by the framework only
Specified by:
getClearForUser in interface CommandContext
Returns:
boolean

getCommand

public final ECCommand getCommand()
Gets the command.
Specified by:
getCommand in interface CommandContext
Returns:
ECCommand

getCommandName

public final java.lang.String getCommandName()
Gets the name of the command.
Specified by:
getCommandName in interface CommandContext
Returns:
java.lang.String

getCountry

public final java.lang.String getCountry()
Gets the 2 character country code associated with this command.
Specified by:
getCountry in interface CommandContext
Returns:
java.lang.String

getCurrency

public final java.lang.String getCurrency()
                                   throws ECSystemException
Gets the negotiated currency code associated with this request.
Specified by:
getCurrency in interface CommandContext
Returns:
java.lang.String
ECSystemException

getCurrentCommandName

public java.lang.String getCurrentCommandName()
Gets the class name of the current command.
Specified by:
getCurrentCommandName in interface CommandContext
Returns:
String - command class name

getCurrentTradingAgreementIdsAsString

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

getCurrentTradingAgreements

public TradingAgreementAccessBean[] getCurrentTradingAgreements()
                                                         throws ECException
Gets the current set of trading agreements.
Specified by:
getCurrentTradingAgreements in interface CommandContext
Returns:
TradingAgreementAccessBean[]
ECException

getDefaultDeviceFormat

public java.lang.Integer getDefaultDeviceFormat()
Gets the default device type to be used for this request.
Specified by:
getDefaultDeviceFormat in interface CommandContext
Returns:
java.lang.Integer

getDeviceFormatAdapter

public DeviceFormatAdapter getDeviceFormatAdapter()
Gets the device format adapter associated with this request.
Specified by:
getDeviceFormatAdapter in interface CommandContext
Returns:
DeviceFormatAdapter

getDeviceFormatId

public final java.lang.Integer getDeviceFormatId()
Gets the device format Id associated with this request.
Specified by:
getDeviceFormatId in interface CommandContext
Returns:
java.lang.Integer

getDeviceFormatTypeId

public final java.lang.Integer getDeviceFormatTypeId()
Gets the device format type associated with this request.
Specified by:
getDeviceFormatTypeId in interface CommandContext
Returns:
java.lang.Integer

getDeviceType

public final java.lang.Integer getDeviceType()
Gets the device format type associated with this request.
Specified by:
getDeviceType in interface CommandContext
Returns:
java.lang.Integer

getDocumentPathName

public java.lang.String getDocumentPathName(java.lang.String baseName)
Return the output document path name based on a base name. The document path name returned is dependant on the device format adapter.
Specified by:
getDocumentPathName in interface CommandContext
Parameters:
baseName - String - base name of the document
Returns:
String - actual name of output document

getEligibleTradingAgreementIds

public java.lang.String[] getEligibleTradingAgreementIds()
                                                  throws ECException
Gets the eligible trading agreemnt ids as an array for type contract only.
Specified by:
getEligibleTradingAgreementIds in interface CommandContext
Returns:
String[] - 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.
Specified by:
getEligibleTradingAgreementIdsAsString in interface CommandContext
Returns:
String

getEncCurContr

public final java.lang.String getEncCurContr()
Reserved for IBM internal use.
Specified by:
getEncCurContr in interface CommandContext
Returns:
java.lang.String

getEncElgContr

public final java.lang.String getEncElgContr()
Reserved for IBM internal use.
Specified by:
getEncElgContr in interface CommandContext
Returns:
java.lang.String

getEncParOrg

public final java.lang.String getEncParOrg()
Reserved for IBM internal use.
Specified by:
getEncParOrg in interface CommandContext
Returns:
java.lang.String

getEncParOrgAndCurContr

public final java.lang.String getEncParOrgAndCurContr()
Reserved for IBM internal use.
Specified by:
getEncParOrgAndCurContr in interface CommandContext
Returns:
java.lang.String

getEncSesContr

public final java.lang.String getEncSesContr()
Reserved for IBM internal use.
Specified by:
getEncSesContr in interface CommandContext
Returns:
java.lang.String

getErrorViewName

public java.lang.String getErrorViewName()
Gets the error view name. This method is used by the command framework only.
Specified by:
getErrorViewName in interface CommandContext
Returns:
String - name of error view

getExpiryDate

public final java.sql.Timestamp getExpiryDate()
Gets the expiry date for a cached page. This method is for internal use by the framework only
Specified by:
getExpiryDate in interface CommandContext
Returns:
Timestamp - the expiry date

getForUserId

public final java.lang.Long getForUserId()
                                  throws ECException
Gets the for user ID for this command. The forUserId is extracted from the requestProperties saved in the commandContext. This method is for internal use by the framework only
Specified by:
getForUserId in interface CommandContext
Returns:
Long - user Id
ECException

getInitialPreferredLanguage

public final java.lang.Integer getInitialPreferredLanguage()
Gets the preferred language Id for this request.
Specified by:
getInitialPreferredLanguage in interface CommandContext
Returns:
Integer
Throws:
ECSystemException

getLanguage

public final java.lang.String getLanguage()
Gets the language associated with this request.
Specified by:
getLanguage in interface CommandContext
Returns:
String

getLanguageId

public final java.lang.Integer getLanguageId()
Gets the negotiated language Id for this request. If this is a command associated with a store, then the negotiated language Id is the preferred langauge if it is supported by the store. Otherwise, the store default language will be returned. If this is a site wide command, then the negotiated langauge is the preferred language if it is supported by the site. Otherwise, the site default language will e returned.
Specified by:
getLanguageId in interface CommandContext
Returns:
Integer - the negotiated language Id.

getLocale

public final java.util.Locale getLocale()
Returns the locale for this command.
Specified by:
getLocale in interface CommandContext
Returns:
Locale

getLocale

public final java.util.Locale getLocale(java.lang.Integer languageId)
Returns the locale associated with a given language. Returns the default system locale if no language access bean is found.
Specified by:
getLocale in interface CommandContext
Returns:
Locale

getLocaleVariant

public final java.lang.String getLocaleVariant()
Gets the locale variant associated with this request.
Specified by:
getLocaleVariant in interface CommandContext
Returns:
java.lang.String

getLogId

public final long getLogId()
Gets the Log id. This method is for internal use only.
Specified by:
getLogId in interface CommandContext
Returns:
long

getNonNullStore

public final 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.
Specified by:
getNonNullStore in interface CommandContext
Returns:
StoreAccessBean, - non null store access bean object
Throws:
ECSystemException

getOriginalUserId

public final java.lang.Long getOriginalUserId()
Gets the user ID for the caller of this request.
Specified by:
getOriginalUserId in interface CommandContext
Returns:
Long - user Id

getParentOrg

public final java.lang.String getParentOrg()
Reserved for IBM internal use.
Specified by:
getParentOrg in interface CommandContext
Returns:
java.lang.String

getPreferredCurrency

public final java.lang.String getPreferredCurrency()
                                            throws ECSystemException
Gets the preferred currency code associated with this request. The preferred currency is retrieved from the session if one is present or from the user object if it is not found in the session.
Specified by:
getPreferredCurrency in interface CommandContext
Returns:
java.lang.String
ECSystemException

getPreferredLanguage

public final java.lang.Integer getPreferredLanguage()
                                             throws ECSystemException
Gets the preferred language Id for this request. The preferred language Id is the value of the "langId" parameter found in the request properties. If the language Id is not present in the request properties, the language Id found in the session will be used. If the language Id is not found in the session, the preferred language of the user as defined in the user access bean will be returned.
Specified by:
getPreferredLanguage in interface CommandContext
Returns:
Integer
Throws:
ECSystemException

getRedirectionURL

public final java.lang.String getRedirectionURL()
Gets the redirect URL for this request. This method is for internal use only.
Specified by:
getRedirectionURL in interface CommandContext
Returns:
String

getRemoteAddr

public final java.lang.String getRemoteAddr()
Gets the address of the remote host.
Specified by:
getRemoteAddr in interface CommandContext
Returns:
java.lang.String

getRemoteHost

public final java.lang.String getRemoteHost()
Gets the name of the remote host.
Specified by:
getRemoteHost in interface CommandContext
Returns:
java.lang.String

getRequest

public final java.lang.Object getRequest()
Gets the request object associated with this request.
Specified by:
getRequest in interface CommandContext
Returns:
Object - the request object

getRequestProperties

public final TypedProperty getRequestProperties()
Gets the request properties associated with this request.
Specified by:
getRequestProperties in interface CommandContext
Returns:
TypedProperty - the request properties

getResolvedQueryString

public java.lang.String getResolvedQueryString()
Gets the interpreted request properties as a queryString.
Specified by:
getResolvedQueryString in interface CommandContext
Returns:
String - the interpreted query string

getResponse

public final java.lang.Object getResponse()
Gets the response object associated with this request.
Specified by:
getResponse in interface CommandContext
Returns:
Object - the response object

getResult

public final boolean getResult()
Gets the result of this request. True if successful, false otherwise This method is for inernal use only.
Specified by:
getResult in interface CommandContext
Returns:
boolean

getSessionContext

public com.ibm.commerce.adapter.SessionContext getSessionContext()
                                                          throws ECException
Gets the SessionContext associated with this request.
Specified by:
getSessionContext in interface CommandContext
Returns:
SessionContext
ECException

getSessionData

public final SessionData getSessionData()
Gets the session data associated with this request.
Specified by:
getSessionData in interface CommandContext
Returns:
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 ";" This method is for internal use only.
Specified by:
getSessionTradingAgreementIdsAsString in interface CommandContext
Returns:
String
ECException

getStore

public final StoreAccessBean getStore()
                               throws ECSystemException
Gets the store access bean for this request.
Specified by:
getStore in interface CommandContext
Returns:
StoreAccessBean - the store access bean
ECSystemException

getStore

public final StoreAccessBean getStore(java.lang.Integer aStoreId)
                               throws ECSystemException
Gets the store access bean based on a store Id.
Specified by:
getStore in interface CommandContext
Returns:
StoreAccessBean - the store access bean
ECSystemException

getStoreId

public final java.lang.Integer getStoreId()
Gets the store Id for this request.
Specified by:
getStoreId in interface CommandContext
Returns:
Integer - the store Id

getTimestamp

public final java.sql.Timestamp getTimestamp()
Gets the current timestamp. This is set once for the duration of the command.
Specified by:
getTimestamp in interface CommandContext
Returns:
Timestamp - the current timestamp

getTradingAgreement

public TradingAgreementAccessBean getTradingAgreement(java.lang.Long id)
                                               throws ECException
Gets the trading agreement given an id.
Specified by:
getTradingAgreement in interface CommandContext
Parameters:
id - Long - trading agreement id
Returns:
TradingAgreementAccessBean
ECException

getTradingAgreement

public TradingAgreementAccessBean getTradingAgreement(java.lang.String id)
                                               throws ECException
Gets the trading agreement given an id.
Specified by:
getTradingAgreement in interface CommandContext
Parameters:
id - String - trading agreement id
Returns:
TradingAgreementAccessBean
ECException

getUniqueSessionTag

public final java.lang.String getUniqueSessionTag()
Return a tag that is unique for the session.
Specified by:
getUniqueSessionTag in interface CommandContext
Returns:
java.lang.String

getUser

public final com.ibm.commerce.user.objects.UserAccessBean getUser()
                                                           throws ECSystemException
Gets the user access bean for the user of this request.
Specified by:
getUser in interface CommandContext
Returns:
UserAccessBean
ECSystemException

getUserId

public final java.lang.Long getUserId()
Gets the user ID for the caller of this request.
Specified by:
getUserId in interface CommandContext
Returns:
Long - user Id

getValidTradingAgreements

protected TradingAgreementAccessBean[] getValidTradingAgreements(TradingAgreementAccessBean[] inTAs)
                                                          throws java.lang.Exception
Gets the valid set of trading agreements.
Returns:
TradingAgreementAccessBean[]
java.lang.Exception

getViewCommand

public final java.lang.String getViewCommand()
Gets the view name with this request. This method is for internal use only.
Specified by:
getViewCommand in interface CommandContext
Returns:
String

getWebpath

public java.lang.String getWebpath()
Gets the web path associated with this request. If this is an Http request, the webpath for the command will be returned. Otherwise, the stores webpath as defined in the configuration xml file will be returned.
Specified by:
getWebpath in interface CommandContext
Returns:
String

invalidateTradingAgreement

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

invalidateTradingAgreement

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

isCacheTarget

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

isResponseNecessary

public boolean isResponseNecessary()
Returns true if this is an https commands and returns false otherwise. This method is for internal use only.
Specified by:
isResponseNecessary in interface CommandContext

isSecure

public final boolean isSecure()
Returns true if this is a https command, returns false otherwise.
Specified by:
isSecure in interface CommandContext
Returns:
boolean

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.
Specified by:
isStoreCommand in interface CommandContext

removeTradingAgreementFromTradingAgreementIds

protected static java.lang.String removeTradingAgreementFromTradingAgreementIds(java.lang.String taIds,
                                                                                java.lang.String id)
Remove a trading agreement Id from the input trading agremment id string. This method is for internal use only.
Returns:
String

resetStoreRef

public final void resetStoreRef()
Resets the EJB reference for the store associated with this command. This method is for internal use only.
Specified by:
resetStoreRef in interface CommandContext

restoreUser

public void restoreUser(java.lang.Long uId)
Restores to original user. This method is for internal use by the framework only.
Specified by:
restoreUser in interface CommandContext
Parameters:
uId - - original user Id

setActivityId

public void setActivityId(long newActivityId)
Sets the activity ID associated with this command. This is for internal use only.
Specified by:
setActivityId in interface CommandContext

setAsyncCommand

public void setAsyncCommand(boolean newValue)
Sets the value to indicate whether this is an asynchronize command. This method is for internal use only.
Specified by:
setAsyncCommand in interface CommandContext
Parameters:
newValue - boolean - true for asynchronize command

setUncacheable

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

setCacheTarget

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

setCommand

public final void setCommand(ECCommand aCommand)
Sets the command associated with this command context. This method is used by the command framework only.
Specified by:
setCommand in interface CommandContext
Parameters:
aCommand - ECCommand

setCommandName

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

setCountry

public final void setCountry(java.lang.String value)
Sets the 2 character country code associated with this command.
Specified by:
setCountry in interface CommandContext

setCurrency

public final void setCurrency(java.lang.String value)
Sets the negotiated currency to be used for this request.
Specified by:
setCurrency in interface CommandContext
Parameters:
value - java.lang.String - a characeter String that represents the currency

setCurrentCommandName

public void setCurrentCommandName(java.lang.String name)
Sets the class name of the current command to be executed.
Specified by:
setCurrentCommandName in interface CommandContext

setCurrentTradingAgreementIdsAsString

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

setCurrentTradingAgreements

public void setCurrentTradingAgreements(TradingAgreementAccessBean[] newValue)
Sets the current trading agreements. This method is for internal use only.
Specified by:
setCurrentTradingAgreements in interface CommandContext

setDefaultDeviceFormat

public final void setDefaultDeviceFormat(java.lang.Integer newValue)
Sets the default device format type for this request.
Specified by:
setDefaultDeviceFormat in interface CommandContext

setDeviceFormatAdapter

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

setDeviceFormatId

public final void setDeviceFormatId(java.lang.Integer newValue)
Sets the device format Id for this request. This method is for use by the framework only.
Specified by:
setDeviceFormatId in interface CommandContext
Parameters:
newValue - java.lang.Integer - device format id

setDeviceFormatTypeId

public final 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.
Specified by:
setDeviceFormatTypeId in interface CommandContext
Parameters:
newValue - java.lang.Integer - device format type id

setDeviceType

public final 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.
Specified by:
setDeviceType in interface CommandContext
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 agreemnt ids as a string. This method is for internal use only.
Specified by:
setEligibleTradingAgreementIdsAsString in interface CommandContext

setEncCurContr

public void setEncCurContr(java.lang.String newEncCurContr)
Reserved for IBM internal use.
Specified by:
setEncCurContr in interface CommandContext
Parameters:
newEncCurContr - encrypted current contracts.

setEncElgContr

public void setEncElgContr(java.lang.String newEncElgContr)
Reserved for IBM internal use.
Specified by:
setEncElgContr in interface CommandContext
Parameters:
newEncElgContr - The eligible contracts

setEncParOrg

public void setEncParOrg(java.lang.String newEncParOrg)
Reserved for IBM internal use.
Specified by:
setEncParOrg in interface CommandContext
Parameters:
newEncParOrg - encrypted parent organization

setEncSesContr

public void setEncSesContr(java.lang.String newEncSesContr)
Reserved for IBM internal use.
Specified by:
setEncSesContr in interface CommandContext
Parameters:
newEncSesContr - encrypted session contract

setErrorViewName

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

setExpiryDate

public final void setExpiryDate(java.sql.Timestamp value)
Sets the expiry date for a cached page. This method is for internal use only.
Specified by:
setExpiryDate in interface CommandContext
Parameters:
value - - TimeStamp

setForUserId

public final void setForUserId(java.lang.Long userId)
Sets the user Id for this request. This method is for internal used by the framework only.
Specified by:
setForUserId in interface CommandContext

setLanguage

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

setLanguageId

public final void setLanguageId(java.lang.Integer value)
Sets the negotiated language Id for this command. This is for internal use by the framework only.
Specified by:
setLanguageId in interface CommandContext
Parameters:
value - Integer - an Id represents the language

setLocale

public final void setLocale(java.util.Locale newValue)
Sets the locale for the command. This method is for internal use by the framework.
Specified by:
setLocale in interface CommandContext

setLocaleVariant

public final 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.
Specified by:
setLocaleVariant in interface CommandContext
Parameters:
value - language java.lang.String

setParentOrg

public final void setParentOrg(java.lang.String newParentOrg)
Insert the method's description here. Creation date: (1/28/2002 5:05:53 PM)

setPreferredCurrency

public final void setPreferredCurrency(java.lang.String value)
Sets the preferred currency to use for this request. This method is for internal use by the framework only.
Specified by:
setPreferredCurrency in interface CommandContext
Parameters:
value - String - the preferred currency

setPreferredLanguage

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

setRedirectionURL

public final void setRedirectionURL(java.lang.String url)
Sets the redirect URL name . This method is for internal use by the framework.
Specified by:
setRedirectionURL in interface CommandContext
Parameters:
url - String - redirect URL name

setRemoteAddr

public final void setRemoteAddr(java.lang.String newRemoteAddr)
Sets the remote host address.
Specified by:
setRemoteAddr in interface CommandContext
Parameters:
newRemoteAddr - java.lang.String

setRemoteHost

public final void setRemoteHost(java.lang.String newRemoteHost)
Sets the remote host name.
Specified by:
setRemoteHost in interface CommandContext
Parameters:
newRemoteHost - java.lang.String

setRequest

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

setRequestProperties

public final void setRequestProperties(TypedProperty value)
Sets the request property object associated with this request. This is used by the framework only.
Specified by:
setRequestProperties in interface CommandContext
Parameters:
value - - TypedProperty

setResponse

public final void setResponse(java.lang.Object value)
Sets the response object associated with this command. This method is for internal use by the framework only.
Specified by:
setResponse in interface CommandContext
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.
Specified by:
setResponseNecessary in interface CommandContext
Parameters:
newValue - boolean

setResult

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

setSecure

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

setSessionContext

public final void setSessionContext(com.ibm.commerce.adapter.SessionContext aSessionContext)
Sets the SessionContext object associated with this request. This method is for internal use by the framework only.

setSessionData

public final void setSessionData(SessionData value)
Sets the SessionData object associated with this request. This method is for internal use by the framework only.
Specified by:
setSessionData in interface CommandContext
Parameters:
value - 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.
Specified by:
setSessionTradingAgreementIdsAsString in interface CommandContext

setStore

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

setStoreCommand

public void setStoreCommand(boolean value)
Returns true if this is a store level command. Returns false otherwise. This method is for internal use by the framework only.
Specified by:
setStoreCommand in interface CommandContext
Parameters:
value - boolean

setStoreId

public final 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.
Specified by:
setStoreId in interface CommandContext

resetTradingAgreementInfo

public void resetTradingAgreementInfo()
Description copied from interface: CommandContext
Resets all trading agreement information.
Specified by:
resetTradingAgreementInfo in interface CommandContext

setTimestamp

public final void setTimestamp(java.sql.Timestamp value)
Sets the timestamp for the comamnd. This method is for internal use by the framework only.
Specified by:
setTimestamp in interface CommandContext
Parameters:
value - Timestamp

setUniqueSessionTag

public final 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.
Specified by:
setUniqueSessionTag in interface CommandContext
Parameters:
value - - java.lang.String
ECException

setUserId

public final void setUserId(java.lang.Long newUserReferenceNumber)
Sets the user Id for this request. This method is for internal used by the framework only.
Specified by:
setUserId in interface CommandContext

setViewCommand

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

setWebpath

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

userCanExecuteCommand

public final 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.
Specified by:
userCanExecuteCommand in interface CommandContext
Returns:
true - if user can execute command false - if user cannot execute command
Throws:
ECException -

clearForUser

public void clearForUser()
Clear for user parameter. This is called internally by the command framework before after the completion of command execution and before executing the view This will be called if the clear for user flag has been set

getForStoreId

public java.lang.Integer getForStoreId()
Gets the forStoreId.
Specified by:
getForStoreId in interface CommandContext
Returns:
the forStoreId

setForStoreId

public void setForStoreId(java.lang.Integer val)
Sets the forStoreId.
Specified by:
setForStoreId in interface CommandContext
Parameters:
val - The forStoreId

getOrgUserInfo

public CommandContextImpl.UserDependantInfo getOrgUserInfo()
Gets the orgUserInfo
Returns:
Returns a UserDependantInfo

setOrgUserInfo

public void setOrgUserInfo(CommandContextImpl.UserDependantInfo orgUserInfo)
Sets the orgUserInfo
Parameters:
orgUserInfo - The orgUserInfo to set

getCurUserInfo

public CommandContextImpl.UserDependantInfo getCurUserInfo()
Gets the curUserInfo.
Returns:
Returns a UserDependantInfo

setCurUserInfo

public void setCurUserInfo(CommandContextImpl.UserDependantInfo curUserInfo)
Sets the curUserInfo.
Parameters:
curUserInfo - The curUserInfo to set

getForUserInfo

public CommandContextImpl.UserDependantInfo getForUserInfo()
Gets the forUserInfo
Returns:
Returns a UserDependantInfo

setForUserInfo

public void setForUserInfo(CommandContextImpl.UserDependantInfo forUserInfo)
Sets the forUserInfo
Parameters:
forUserInfo - The forUserInfo to set

getCurStoreInfo

public com.ibm.commerce.command.CommandContextImpl.StoreDependantInfo getCurStoreInfo()
Gets the curStoreInfo.
Returns:
Returns current store information

setCurStoreInfo

public void setCurStoreInfo(com.ibm.commerce.command.CommandContextImpl.StoreDependantInfo curStoreInfo)
Sets the curStoreInfo.
Parameters:
curStoreInfo - The current store Information to set

getNewStores

public java.util.ArrayList getNewStores()
Gets the newStores
Returns:
Returns a ArrayList

setNewStores

public void setNewStores(java.util.ArrayList newStores)
Sets the newStores
Parameters:
newStores - The newStores to set

getParentStores

public java.util.ArrayList getParentStores()
Gets the parentStores
Returns:
Returns a ArrayList

setParentStores

public void setParentStores(java.util.ArrayList parentStores)
Sets the parentStores
Parameters:
parentStores - The parentStores to set

changeUser

public void changeUser(java.lang.Long newValue)
Reserved for IBM internal use. Changes the user and information associated with user

getCachePage

public final boolean getCachePage()
Reserved for IBM internal use. Gets the cache page value. Returns true if page has to be cached. False otherwise. This method is for internal use only.
Returns:
boolean - the cache page value

setCachePage

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

getEncoding

public java.lang.String getEncoding()
Returns the character encoding.
Specified by:
getEncoding in interface CommandContext
Returns:
character encoding.

setEncoding

public void setEncoding(java.lang.String encoding)
Sets the character encoding.
Specified by:
setEncoding in interface CommandContext
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:
Specified by:
getTransactionCache in interface CommandContext
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.
Specified by:
setTransactionCache in interface CommandContext
Returns:
the previous cache of custom properties.