BaseAdministratorForm (SoftSlate Commerce API Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.softslate.commerce.administrator.core
Class BaseAdministratorForm

java.lang.Object
  org.apache.struts.action.ActionForm
      com.softslate.commerce.customer.core.BaseForm
          com.softslate.commerce.administrator.core.BaseAdministratorForm

All Implemented Interfaces:: java.io.Serializable

Direct Known Subclasses:: AdministratorAddEditForm, AttributeAddEditForm, BasicTaxAddEditForm, CardInfoCleanUpForm, CategoryAddEditForm, CategorySettingAddEditForm, CountryAddEditForm, CustomerAddEditForm, CustomerAddressAddEditForm, CustomerWishListAddEditForm, DiscountAddEditForm, DiscountRangeAddEditForm, GoogleSitemapsForm, LoginForm, LuceneForm, ManufacturerAddEditForm, MonthlySalesForm, OptionAddEditForm, OrderAddEditForm, OrderDeliveryAddEditForm, OrderDiscountAddEditForm, OrderItemAddEditForm, OrderItemAttributeAddEditForm, PaymentAddEditForm, ProcessPaymentForm, ProductAddEditForm, ProductReviewAddEditForm, ProductSettingAddEditForm, ProductSettingAddEditFormImages, PruneRequestLogForm, RequestLogAddEditForm, RoleAddEditForm, SalesByProductForm, SendEmailsForm, SettingsFormAddress, ShippingForm, ShippingMethodAddEditForm, ShippingRateAddEditForm, ShippingRuleAddEditForm, ShippingRuleRangeAddEditForm, SKUAddEditForm, StateAddEditForm, UserSettingAddEditForm

public class BaseAdministratorForm
extends BaseForm
extends BaseForm

Extends the BaseForm class to provide base functionality for form classes in the administrator. Provides a getter and setter for the current user's Administrator object.

Author:: David Tobey
See Also:: Serialized Form

Field Summary
`private Administrator`	`administrator` The `Administrator` object representing the current administrative user.
`private FormUtils`	`formUtils`
`private static long`	`serialVersionUID`

Fields inherited from class org.apache.struts.action.ActionForm
`multipartRequestHandler, servlet`

Constructor Summary
`BaseAdministratorForm()`

Method Summary
`java.lang.Character`	`containsUnsafeCharacter(java.lang.String string, javax.servlet.http.HttpServletRequest request)`
`Administrator`	`getAdministrator()`
`FormUtils`	`getFormUtils(javax.servlet.http.HttpServletRequest request)`
`void`	`initializeProperties(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)` Initializes all the properties of this `BaseForm` by copying the objects from the request, session, and application scopes.
`void`	`setAdministrator(Administrator administrator)`

Methods inherited from class com.softslate.commerce.customer.core.BaseForm
`formUtils, getBusinessObjectFactory, getErrors, getMapping, getMessage, getMessages, getRequest, getSettings, getUser, setBusinessObjectFactory, setErrors, setMapping, setMessages, setRequest, setSettings, setUser`

Methods inherited from class org.apache.struts.action.ActionForm
`getMultipartRequestHandler, getServlet, getServletWrapper, reset, reset, setMultipartRequestHandler, setServlet, validate, validate`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:: Constant Field Values

administrator

private Administrator administrator

The Administrator object representing the current administrative user.

formUtils

private FormUtils formUtils

Constructor Detail

BaseAdministratorForm

public BaseAdministratorForm()

Method Detail

getAdministrator

public Administrator getAdministrator()

setAdministrator

public void setAdministrator(Administrator administrator)

initializeProperties

public void initializeProperties(org.apache.struts.action.ActionMapping mapping,
                                 javax.servlet.http.HttpServletRequest request)

Description copied from class: BaseForm

Initializes all the properties of this BaseForm by copying the objects from the request, session, and application scopes. Called by action classes and within the validate method of this BaseForm.

Overrides:: initializeProperties in class BaseForm

Parameters:: mapping - The mapping corresponding to the current action of the request.; request - The HttpServletRequest object for this request.

getFormUtils

public FormUtils getFormUtils(javax.servlet.http.HttpServletRequest request)

containsUnsafeCharacter

public java.lang.Character containsUnsafeCharacter(java.lang.String string,
                                                   javax.servlet.http.HttpServletRequest request)