BaseServletContext

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

FlashServletContext

All Known Implementing Classes:

AccountBillingAddEdit.Context, AccountContactAddEdit.Context, AccountCreditCardAddEdit.Context, AccountCreditCardSelect.Context, AccountLogonAddEdit.Context, AccountLogonViewId.Context, AccountPasswordEdit.Context, AccountProfile.Context, AccountServlet.Context, AccountShippingAddEdit.Context, AccountShippingSelect.Context, AdmAccountSelect.Context, AdmBackendControlEdit.Context, AdmCategoryAddEdit.Context, AdmCategoryProductAdd.Context, AdmCategoryProductList.Context, AdmCategorySelect.Context, AdmCategorySubcatAdd.Context, AdmCategorySubcatList.Context, AdmCategorySubcatSeq.Context, AdmCountryAddEdit.Context, AdmCountrySelect.Context, AdmHome.Context, AdmImportData.Context, AdmLeadtimeAddEdit.Context, AdmLeadtimeSelect.Context, AdmManufacturerAddEdit.Context, AdmManufacturerSelect.Context, AdmPasswordEdit.Context, AdmPendingProductBatchSelect.Context, AdmPendingProductEditBasic.Context, AdmPendingProductEditDescriptions.Context, AdmPendingProductEditImages.Context, AdmPendingProductEditSelected.Context, AdmPendingProductFind.Context, AdmPendingProductList.Context, AdmPendingProductProfile.Context, AdmProductAttributeAddEdit.Context, AdmProductAttributeDescrAddEdit.Context, AdmProductAttributeDescrSelect.Context, AdmProductAttributeList.Context, AdmProductCategoryAdd.Context, AdmProductCategoryList.Context, AdmProductDescriptionEdit.Context, AdmProductEdit.Context, AdmProductImageEdit.Context, AdmProductImportBatchAddEdit.Context, AdmProductImportBatchInfo.Context, AdmProductImportBatchSelect.Context, AdmProductImportCandidateList.Context, AdmProductProfile.Context, AdmProductSearchIndexBuild.Context, AdmProductSelect.Context, AdmProductServlet.Context, AdmPropertiesEdit.Context, AdmPurge.Context, AdmPurgeAccounts.Context, AdmPurgeCarts.Context, AdmPurgeCategories.Context, AdmPurgeCreditCards.Context, AdmPurgeFavorites.Context, AdmPurgeOrderAudits.Context, AdmPurgeRestockNotifications.Context, AdmPurgeSearchLogs.Context, AdmPurgeSiteActivities.Context, AdmQueryDatabase.Context, AdmSalesRepAddEdit.Context, AdmSalesRepCustomerAdd.Context, AdmSalesRepCustomerList.Context, AdmSalesRepSelect.Context, AdmSalesRepUserAddEdit.Context, AdmSalesRepUserSelect.Context, AdmSecurityProfileAddEdit.Context, AdmSecurityProfileSelect.Context, AdmSendMassEmail.Context, AdmShipperAddEdit.Context, AdmShipperSelect.Context, AdmSpecialAddEdit.Context, AdmSpecialProductAdd.Context, AdmSpecialProductList.Context, AdmSpecialSelect.Context, AdmStateAddEdit.Context, AdmStateSelect.Context, AdmStoreTypeEdit.Context, AdmSynchronizeData.Context, AdmTestSiteEmails.Context, AdmUnitMeasureAddEdit.Context, AdmUnitMeasureSelect.Context, AdmUserCatalogExport.Context, AdmUserFavoritesCopy.Context, AdmVerifyEmailAddresses.Context, AdmVerifyProductFiles.Context, AdmVerifySiteImages.Context, AdmViewDatabaseInfo.Context, AdmViewFileSystemInfo.Context, AdmViewPoolStatus.Context, AdmViewScheduledTasks.Context, AdmViewServerInfo.Context, AdmWordFixAddEdit.Context, AdmWordFixSelect.Context, BaseServlet.Context, CartLineEdit.Context, CheckOut.Context, ClientRequest.Context, ConfirmOrder.Context, DemoIndustryEdit.Context, FavoriteAddEdit.Context, FavoriteItems.Context, FlashServlet.Context, Home.Context, InvoiceHistory.Context, Logoff.Context, Logon.Context, LogonAssistance.Context, LogonFirst.Context, LogonShippingSelect.Context, LogonUser.Context, MainPagingServlet.Context, MainServlet.Context, OrderDetails.Context, OrderRequestAPI.Context, OrderSummary.Context, OrderToExcel.Context, ProductCompare.Context, ProductDetails.Context, ProductLookup.Context, Products.Context, ProductSearch.Context, ProductSearchResults.Context, ProductSpecial.Context, ProductWarehouseDetail.Context, PunchOut.Context, QuickOrder.Context, ReorderRejects.Context, ReviewCart.Context, SatAccess.Context, SatActivity.Context, SatLocations.Context, SatTrends.Context, ScriptRequest.Context, SfiAccountSelect.Context, SfiShippingSelect.Context, SfiUserSelect.Context, ShipmentDetails.Context, StaticPage.Context, ThreadServletContext, UserHelp.Context
```
public interface BaseServletContext
extends java.io.Serializable
```
Defines the publicly accessible servlet context methods which are common to all servlet processing.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`delAttr(java.lang.String key)` A shortcut convenience method that removes an attribute value from the current session.
`java.lang.Object`	`getAttr(java.lang.String key)` A shortcut convenience method that returns an attribute value from the current session.
`java.math.BigDecimal`	`getAttrBigDecimal(java.lang.String key)` A shortcut convenience method that returns an attribute value from the current session as a `BigDecimal`.
`boolean`	`getAttrBoolean(java.lang.String key)` A shortcut convenience method that returns an attribute value from the current session as a `boolean`.
`double`	`getAttrDouble(java.lang.String key)` A shortcut convenience method that returns an attribute value from the current session as a `double`.
`int`	`getAttrInteger(java.lang.String key)` A shortcut convenience method that returns an attribute value from the current session as an `int`.
`long`	`getAttrLong(java.lang.String key)` A shortcut convenience method that returns an attribute value from the current session as a `long`.
`java.lang.String`	`getAttrString(java.lang.String key)` A shortcut convenience method that returns an attribute value from the current session as a `String`.
`java.lang.String`	`getParam(java.lang.String name)` A shortcut convenience method that returns a parameter value from the current request.
`java.math.BigDecimal`	`getParamBigDecimal(java.lang.String name)` A shortcut convenience method that returns a parameter value from the current request as a `BigDecimal`.
`java.util.Date`	`getParamDate(java.lang.String name)` A shortcut convenience method that returns a parameter value from the current request as a `java.util.Date`.
`double`	`getParamDouble(java.lang.String name)` A shortcut convenience method that returns a parameter value from the current request as a `double`.
`int`	`getParamInteger(java.lang.String name)` A shortcut convenience method that returns a parameter value from the current request as an `int`.
`long`	`getParamLong(java.lang.String name)` A shortcut convenience method that returns a parameter value from the current request as a `long`.
`java.lang.String[]`	`getParams(java.lang.String name)` A shortcut convenience method that returns an array of parameter values from the current request.
`java.lang.String`	`getParamString(java.lang.String name)` A shortcut convenience method that returns a parameter value from the current request as a `String`.
`javax.servlet.http.HttpServletRequest`	`getRequest()` Returns the current servlet HTTP request.
`javax.servlet.http.HttpServletResponse`	`getResponse()` Returns the current servlet HTTP response.
`javax.servlet.http.HttpSession`	`getSession()` Returns the current servlet session.
`boolean`	`isPost()` Answers if a form has been posted by checking the current HTTP request's method for "POST".
`void`	`setAttr(java.lang.String key, java.lang.Object value)` A shortcut convenience method that sets an attribute value in the current session.

- Method Detail
  - delAttr
```
void delAttr(java.lang.String key)
```
    A shortcut convenience method that removes an attribute value from the current session.
    
    Parameters:
    
    key - (String) The key for the attribute value to remove.
  - getAttr
```
java.lang.Object getAttr(java.lang.String key)
```
    A shortcut convenience method that returns an attribute value from the current session.
    
    Parameters:
    
    key - (String) The key for the desired attribute value.
    
    Returns:
    
    Object - The value associated with the given key. Returns null if a value for the key does not exist.
  - getAttrBigDecimal
```
java.math.BigDecimal getAttrBigDecimal(java.lang.String key)
```
    A shortcut convenience method that returns an attribute value from the current session as a BigDecimal.
    
    Parameters:
    
    key - (String) The key for the desired attribute value.
    
    Returns:
    
    BigDecimal - The value associated with the given key. Returns null if a value for the key does not exist or if the key's value could not be converted to a BigDecimal.
  - getAttrBoolean
```
boolean getAttrBoolean(java.lang.String key)
```
    A shortcut convenience method that returns an attribute value from the current session as a boolean.
    
    Parameters:
    
    key - (String) The key for the desired attribute value.
    
    Returns:
    
    boolean - The value associated with the given key. Returns false if a value for the key does not exist or if the key's value could not be converted to a boolean.
  - getAttrDouble
```
double getAttrDouble(java.lang.String key)
```
    A shortcut convenience method that returns an attribute value from the current session as a double.
    
    Parameters:
    
    key - (String) The key for the desired attribute value.
    
    Returns:
    
    double - The value associated with the given key. Returns zero if a value for the key does not exist or if the key's value could not be converted to a double.
  - getAttrInteger
```
int getAttrInteger(java.lang.String key)
```
    A shortcut convenience method that returns an attribute value from the current session as an int.
    
    Parameters:
    
    key - (String) The key for the desired attribute value.
    
    Returns:
    
    int - The value associated with the given key. Returns zero if a value for the key does not exist or if the key's value could not be converted to an integer.
  - getAttrLong
```
long getAttrLong(java.lang.String key)
```
    A shortcut convenience method that returns an attribute value from the current session as a long.
    
    Parameters:
    
    key - (String) The key for the desired attribute value.
    
    Returns:
    
    long - The value associated with the given key. Returns zero if a value for the key does not exist or if the key's value could not be converted to a long.
  - getAttrString
```
java.lang.String getAttrString(java.lang.String key)
```
    A shortcut convenience method that returns an attribute value from the current session as a String.
    
    Parameters:
    
    key - (String) The key for the desired attribute value.
    
    Returns:
    
    String - The value associated with the given key. Returns an empty string if a value for the key does not exist.
  - setAttr
```
void setAttr(java.lang.String key,
             java.lang.Object value)
```
    A shortcut convenience method that sets an attribute value in the current session.
    
    Parameters:
    
    key - (String) The key associated with the value.
    
    value - (Object) The attribute value to set.
  - getParam
```
java.lang.String getParam(java.lang.String name)
```
    A shortcut convenience method that returns a parameter value from the current request.
    
    Parameters:
    
    name - (String) The name of the desired parameter value.
    
    Returns:
    
    String - The value associated with the given parameter name. Returns null if a value for the parameter name does not exist.
  - getParams
```
java.lang.String[] getParams(java.lang.String name)
```
    A shortcut convenience method that returns an array of parameter values from the current request.
    
    Parameters:
    
    name - (String) The name of the desired parameter values.
    
    Returns:
    
    String[] - The values associated with the given parameter name. Returns null if a value for the parameter name does not exist.
  - getParamBigDecimal
```
java.math.BigDecimal getParamBigDecimal(java.lang.String name)
```
    A shortcut convenience method that returns a parameter value from the current request as a BigDecimal.
    
    Parameters:
    
    name - (String) The name of the desired parameter value.
    
    Returns:
    
    BigDecimal - The value associated with the given parameter name. Returns zero if a value for the parameter name does not exist or if the parameter value could not be converted to a BigDecimal.
  - getParamDate
```
java.util.Date getParamDate(java.lang.String name)
```
    A shortcut convenience method that returns a parameter value from the current request as a java.util.Date.
    
    Parameters:
    
    name - (String) The name of the desired parameter value.
    
    Returns:
    
    Date - The value associated with the given parameter name. Returns null if a value for the parameter name does not exist or if the parameter value could not be converted to a date.
  - getParamDouble
```
double getParamDouble(java.lang.String name)
```
    A shortcut convenience method that returns a parameter value from the current request as a double.
    
    Parameters:
    
    name - (String) The name of the desired parameter value.
    
    Returns:
    
    double - The value associated with the given parameter name. Returns zero if a value for the parameter name does not exist or if the parameter value could not be converted to a double.
  - getParamInteger
```
int getParamInteger(java.lang.String name)
```
    A shortcut convenience method that returns a parameter value from the current request as an int.
    
    Parameters:
    
    name - (String) The name of the desired parameter value.
    
    Returns:
    
    int - The value associated with the given parameter name. Returns zero if a value for the parameter name does not exist or if the parameter value could not be converted to an int.
  - getParamLong
```
long getParamLong(java.lang.String name)
```
    A shortcut convenience method that returns a parameter value from the current request as a long.
    
    Parameters:
    
    name - (String) The name of the desired parameter value.
    
    Returns:
    
    long - The value associated with the given parameter name. Returns zero if a value for the parameter name does not exist or if the parameter value could not be converted to a long.
  - getParamString
```
java.lang.String getParamString(java.lang.String name)
```
    A shortcut convenience method that returns a parameter value from the current request as a String.
    
    Parameters:
    
    name - (String) The name of the desired parameter value.
    
    Returns:
    
    String - The value associated with the given parameter name. Returns an empty string if a value for the parameter name does not exist.
  - getRequest
```
javax.servlet.http.HttpServletRequest getRequest()
```
    Returns the current servlet HTTP request.
    
    Returns:
    
    HttpServletRequest - The current servlet HTTP request.
  - getResponse
```
javax.servlet.http.HttpServletResponse getResponse()
```
    Returns the current servlet HTTP response.
    
    Returns:
    
    HttpServletResponse - The current servlet HTTP response.
  - getSession
```
javax.servlet.http.HttpSession getSession()
```
    Returns the current servlet session.
    
    Returns:
    
    HttpSession - The current servlet session.
  - isPost
```
boolean isPost()
```
    Answers if a form has been posted by checking the current HTTP request's method for "POST".
    
    Returns:
    
    boolean - true if a form has been posted, otherwise false.

Interface BaseServletContext

Method Summary

Method Detail

delAttr

getAttr

getAttrBigDecimal

getAttrBoolean

getAttrDouble

getAttrInteger

getAttrLong

getAttrString

setAttr

getParam

getParams

getParamBigDecimal

getParamDate

getParamDouble

getParamInteger

getParamLong

getParamString

getRequest

getResponse

getSession

isPost