gboat2.base.core.web
类 BaseActionSupport

java.lang.Object
  com.opensymphony.xwork2.ActionSupport
      gboat2.base.core.web.BaseActionSupport

所有已实现的接口：

com.opensymphony.xwork2.Action, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.Preparable, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, com.opensymphony.xwork2.ValidationAware, IBaseActionSupport, Serializable, org.apache.struts2.interceptor.ServletRequestAware, org.apache.struts2.interceptor.ServletResponseAware, org.apache.struts2.osgi.interceptor.BundleContextAware, org.apache.struts2.osgi.interceptor.ServiceAware, org.apache.struts2.util.ServletContextAware

直接已知子类：

ApproveflowAction, AttachAction, AttachConfigAction, AuthorityAction, AutocompleterAction, BlankAction, BusinessLogAction, ExampleAction, ForwardAction, GIndexAction, GrepAction, GroupAction, GroupRoleAction, LogConfigAction, LoginAction, MetadataAction, OrganDefineAction, ParameterAction, PreferenceAction, ProfileAction, PropertyAction, ReportConfigAction, ResourceAction, RoleAction, ServiceflowAction, ShortcutAction, SystemConfigAction, SystemLogAction, UploadAction, UserAction, VersionMgrAction, WebServiceConfigAction, WebServiceConfigParamAction, WidgetAction, WidgetAuthorityConfigAction

public abstract class BaseActionSupport
extends com.opensymphony.xwork2.ActionSupport
implements IBaseActionSupport, org.apache.struts2.osgi.interceptor.ServiceAware

作者：

lysming 2011-12-6

另请参见：

序列化表格

字段摘要

protected com.opensymphony.xwork2.inject.Container	container
protected org.osgi.framework.BundleContext	context
static String	CURRENT_BUNDLE_RES_LOCATION
protected boolean	devMode 是否开启了 Struts 调试模式
protected boolean	flatResultLayout
protected String	go 需要跳转到的目标页面
static String	MIN_SUFFIX
protected Object	model
protected String	nameSeparator
protected org.apache.struts2.osgi.OsgiHost	osgiHost
protected Page<?>	page
javax.servlet.http.HttpServletRequest	request
javax.servlet.http.HttpServletResponse	response
protected static long	serialVersionUID
protected String	SID
protected String	sortDirection 排序方向（ASC 或 DESC）
protected String	sortField 排序字段

从类 com.opensymphony.xwork2.ActionSupport 继承的字段

LOG

从接口 com.opensymphony.xwork2.Action 继承的字段

ERROR, INPUT, LOGIN, NONE, SUCCESS

构造方法摘要

BaseActionSupport()

方法摘要

String	ajaxDelete() desktop的Ajax删除处理
void	ajaxListData()
String	ajaxSave() desktop的Ajax保存处理
Object	ajaxSaveReturn(Object model)
String	delete() 删除
protected void	deleteModel()
String	edit() 跳转到编辑页
String	execute() 默认转到列表页
protected void	executeListQuery(Map<String,Object> queryMap)
String	forward() 转发到指定的 JSP 页面， 通过名称为 go 的参数指定需要跳转的路径，在跳转之前会执行 initXxx() 方法（如果 initXxx() 方法存在的话）
Object	get_M() 不符合方法命名规范，暂时这样 用于绑定的简写，使用"_M"等同于"model"
String	get_MdId()
protected org.osgi.framework.Bundle	getActionBundle()
<T> T	getBean(Class<T> interfaceClass) 功能：根据接口获取外部bundle中的服务实现
Object	getBean(String interfaceName) 已过时。
String	getDefaultAjaxDeleteUri()
String	getDefaultAjaxSaveUri()
String	getDefaultDeleteUri() 获得默认的删除请求URI
String	getDefaultEditUri() 获得默认的编辑页面URI
String	getDefaultListUri() 拼装默认的列表页面URI
String	getDefaultSaveUri() 获得默认的保存页面URI
String	getDefaultViewUri() 获得默认的查看页面URI
Class<?>	getDomainClassAnnotationed() 获取注解配置的domain类 优先级顺序： 1、方法是否配置@Domain注解； 2、类是否配置@Domain注解； 3、是否传递参数DomainClass 4、从配置的struts.gboat.domain.basePackage路径中找符合命名规范的PO类
Class<?>	getDomainClassAnnotationedForList() 获取列表使用的注解ListDomain类 如果使用了@ListDomain(方法级或类级)，则使用该注解申明的ListDomain； 如果没有则使用@Domain申明的Domain
protected String	getExtendForView() 获取视图的扩展路径，返回不为空时视图文件名称为“example-edit-extend.md”
protected Map<String,Object>	getListParameterMap()
Object	getMetadata(String metadataType, String invokeMethod) 根据 metadataType 类型选择相应的处理类
Object	getModel() 获取Model对象
Page<?>	getPage()
Map<Object,Object>	getPriCheckParams()
IBaseService	getServiceAnnotationed() 根据@Business定义的服务类查找对应的spring bean
String	getSID()
String	getSortDirection()
String	getSortField()
StringBuffer	getUriPrefix() 获取uri路径的前缀，如ExampleAction的前缀为example，参照convention的约定规则
protected void	initEdit()
protected void	initList(Map<String,Object> params)
protected void	initSave()
protected void	initView()
protected void	invokeInitMethod(String invokeMethodName) 请求 Action 时， 在调用真正被请求的方法之前， 先调用该方法的初始化方法（如果存在的话）， xxx() 方法对应的初始化方法为 initXxx()。
String	list() 列表查询
boolean	operationCheck(Object data, String operationCode) 根据数据检查list中操作是否可见,如果有此方面的需求 请覆盖此方法，todo 方法应该定义为抽象
protected void	postDelete()
protected void	postList(Page<?> pageinfo)
protected void	postSave()
void	prepare()
void	prepareEdit()
void	prepareList()
void	prepareModel()
void	prepareView()
protected void	putDebugInfoIfDevMode() 往 ActionContext 实例中存放一些调试信息
void	registerEnumClassNotInEntry(List<Class<? extends Enum<?>>> enumClass) 注册除包含在实体对象即po，vo中枚举类型 使用场景：如果页面中用到的枚举 但此枚举没有出现在po、vo中，则需要覆盖此方法，把当前枚举注册参数enumClass中
String	save() 保存
protected void	saveModel()
void	set_M(Object _M)
void	set_MdId(String mdId)
protected void	setAutowiredBeans(Field[] fields, org.osgi.framework.Bundle bundle)
protected void	setAutowiredBeans(Field[] fields, Class<?> clazz) 对action扩展，Business的注入处理，
void	setBundleContext(org.osgi.framework.BundleContext context)
void	setContainer(com.opensymphony.xwork2.inject.Container container)
void	setDevMode(String mode)
void	setFlatResultLayout(String flatResultLayout)
void	setGo(String go)
void	setModel(Object model)
void	setNameSeparator(String nameSeparator)
void	setPriCheckParams(Map<Object,Object> priCheckParams)
void	setServices(List services)
void	setServletContext(javax.servlet.ServletContext servletContext)
void	setServletRequest(javax.servlet.http.HttpServletRequest request)
void	setServletResponse(javax.servlet.http.HttpServletResponse response)
void	setSID(String sID)
void	setSortDirection(String sortDirection)
void	setSortField(String sortField)
protected boolean	setValue(Field field, org.osgi.framework.Bundle bundle)
String	view() 查看详细信息

从类 com.opensymphony.xwork2.ActionSupport 继承的方法

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, doDefault, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getFormatted, getLocale, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, pause, setActionErrors, setActionMessages, setFieldErrors, validate

从类 java.lang.Object 继承的方法

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细信息

serialVersionUID

protected static final long serialVersionUID

另请参见：

常量字段值

CURRENT_BUNDLE_RES_LOCATION

public static final String CURRENT_BUNDLE_RES_LOCATION

另请参见：

常量字段值

MIN_SUFFIX

public static final String MIN_SUFFIX

另请参见：

常量字段值

request

public javax.servlet.http.HttpServletRequest request

response

public javax.servlet.http.HttpServletResponse response

context

protected org.osgi.framework.BundleContext context

container

protected com.opensymphony.xwork2.inject.Container container

devMode

protected boolean devMode

是否开启了 Struts 调试模式

flatResultLayout

protected boolean flatResultLayout

nameSeparator

protected String nameSeparator

osgiHost

protected org.apache.struts2.osgi.OsgiHost osgiHost

page

protected Page<?> page

SID

protected String SID

model

protected Object model

sortField

protected String sortField

排序字段

sortDirection

protected String sortDirection

排序方向（ASC 或 DESC）

go

protected String go

需要跳转到的目标页面

构造方法详细信息

BaseActionSupport

public BaseActionSupport()

方法详细信息

setContainer

public void setContainer(com.opensymphony.xwork2.inject.Container container)

覆盖：

类 com.opensymphony.xwork2.ActionSupport 中的 setContainer

setDevMode

public void setDevMode(String mode)

setFlatResultLayout

public void setFlatResultLayout(String flatResultLayout)

setNameSeparator

public void setNameSeparator(String nameSeparator)

delete

public String delete()

从接口 IBaseActionSupport 复制的描述

删除

指定者：

接口 IBaseActionSupport 中的 delete

返回：

ajaxDelete

public String ajaxDelete()

desktop的Ajax删除处理

返回：

null

deleteModel

protected final void deleteModel()

postDelete

protected void postDelete()

prepareModel

public void prepareModel()

getDomainClassAnnotationedForList

public final Class<?> getDomainClassAnnotationedForList()

获取列表使用的注解ListDomain类 如果使用了@ListDomain(方法级或类级)，则使用该注解申明的ListDomain； 如果没有则使用@Domain申明的Domain

返回：

返回当前action的po class或者vo class

getDomainClassAnnotationed

public final Class<?> getDomainClassAnnotationed()

获取注解配置的domain类 优先级顺序： 1、方法是否配置@Domain注解； 2、类是否配置@Domain注解； 3、是否传递参数DomainClass 4、从配置的struts.gboat.domain.basePackage路径中找符合命名规范的PO类

返回：

返回当前action的po class

getServiceAnnotationed

public final IBaseService getServiceAnnotationed()

根据@Business定义的服务类查找对应的spring bean

返回：

返回IBaseService

prepareEdit

public final void prepareEdit()
                       throws Exception

抛出：

Exception

initEdit

protected void initEdit()

registerEnumClassNotInEntry

public void registerEnumClassNotInEntry(List<Class<? extends Enum<?>>> enumClass)

注册除包含在实体对象即po，vo中枚举类型 使用场景：如果页面中用到的枚举 但此枚举没有出现在po、vo中，则需要覆盖此方法，把当前枚举注册参数enumClass中

参数：

enumClass -

edit

public String edit()

从接口 IBaseActionSupport 复制的描述

跳转到编辑页

指定者：

接口 IBaseActionSupport 中的 edit

返回：

prepareView

public final void prepareView()
                       throws Exception

抛出：

Exception

initView

protected void initView()

view

public String view()

从接口 IBaseActionSupport 复制的描述

查看详细信息

指定者：

接口 IBaseActionSupport 中的 view

返回：

prepareList

public final void prepareList()

list

public String list()

从接口 IBaseActionSupport 复制的描述

列表查询

指定者：

接口 IBaseActionSupport 中的 list

返回：

ajaxListData

public void ajaxListData()

executeListQuery

protected void executeListQuery(Map<String,Object> queryMap)

getListParameterMap

protected final Map<String,Object> getListParameterMap()

initList

protected void initList(Map<String,Object> params)

postList

protected void postList(Page<?> pageinfo)

save

public String save()

从接口 IBaseActionSupport 复制的描述

保存

指定者：

接口 IBaseActionSupport 中的 save

返回：

ajaxSave

public String ajaxSave()

desktop的Ajax保存处理

返回：

null

ajaxSaveReturn

public Object ajaxSaveReturn(Object model)

saveModel

protected final void saveModel()

initSave

protected void initSave()

postSave

protected void postSave()

prepare

public final void prepare()
                   throws Exception

指定者：

接口 com.opensymphony.xwork2.Preparable 中的 prepare

抛出：

Exception

setAutowiredBeans

protected void setAutowiredBeans(Field[] fields,
                                 Class<?> clazz)
                          throws Exception

对action扩展，Business的注入处理，

抛出：

Exception

setValue

protected boolean setValue(Field field,
                           org.osgi.framework.Bundle bundle)
                    throws Exception

抛出：

Exception

setAutowiredBeans

protected void setAutowiredBeans(Field[] fields,
                                 org.osgi.framework.Bundle bundle)
                          throws Exception

抛出：

Exception

getActionBundle

protected org.osgi.framework.Bundle getActionBundle()

返回：

当前执行的 Action 所在的 Bundle

invokeInitMethod

protected void invokeInitMethod(String invokeMethodName)

请求 Action 时， 在调用真正被请求的方法之前， 先调用该方法的初始化方法（如果存在的话）， xxx() 方法对应的初始化方法为 initXxx()。

注意： 如果子类重写了本类的 edit(), view(), list(), save() 方法，则在请求这四个方法时，对应的 initXxx() 方法不会被执行。

参数：

invokeMethodName - 真正要请求的方法的名称

execute

public String execute()
               throws DefaultBusinessNestedException

默认转到列表页

指定者：

接口 com.opensymphony.xwork2.Action 中的 execute

覆盖：

类 com.opensymphony.xwork2.ActionSupport 中的 execute

返回：

返回forward

抛出：

DefaultBusinessNestedException

另请参见：

ActionSupport.execute()

forward

public String forward()

转发到指定的 JSP 页面， 通过名称为 go 的参数指定需要跳转的路径，在跳转之前会执行 initXxx() 方法（如果 initXxx() 方法存在的话）

返回：

getMetadata

public Object getMetadata(String metadataType,
                          String invokeMethod)

根据 metadataType 类型选择相应的处理类

指定者：

接口 IBaseActionSupport 中的 getMetadata

参数：

metadataType - 元数据的类型

invokeMethod - 调用的方法

返回：

operationCheck

public boolean operationCheck(Object data,
                              String operationCode)

根据数据检查list中操作是否可见,如果有此方面的需求 请覆盖此方法，todo 方法应该定义为抽象

参数：

data - 当前行中数据

operationCode - 操作code

返回：

是否展示操作，展示 返回 true ，否则 返回false

setBundleContext

public void setBundleContext(org.osgi.framework.BundleContext context)

指定者：

接口 org.apache.struts2.osgi.interceptor.BundleContextAware 中的 setBundleContext

setServletResponse

public void setServletResponse(javax.servlet.http.HttpServletResponse response)

指定者：

接口 org.apache.struts2.interceptor.ServletResponseAware 中的 setServletResponse

setServletRequest

public void setServletRequest(javax.servlet.http.HttpServletRequest request)

指定者：

接口 org.apache.struts2.interceptor.ServletRequestAware 中的 setServletRequest

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

指定者：

接口 org.apache.struts2.util.ServletContextAware 中的 setServletContext

getExtendForView

protected String getExtendForView()

获取视图的扩展路径，返回不为空时视图文件名称为“example-edit-extend.md”

返回：

getModel

public Object getModel()

获取Model对象

返回：

返回当前model

setModel

public void setModel(Object model)

get_M

public Object get_M()

不符合方法命名规范，暂时这样 用于绑定的简写，使用"_M"等同于"model"

返回：

返回当前model

set_M

public void set_M(Object _M)

getDefaultListUri

public String getDefaultListUri()

拼装默认的列表页面URI

返回：

列表页面URI

getDefaultSaveUri

public String getDefaultSaveUri()

获得默认的保存页面URI

返回：

保存页面URI

getDefaultAjaxSaveUri

public String getDefaultAjaxSaveUri()

getDefaultEditUri

public String getDefaultEditUri()

获得默认的编辑页面URI

返回：

编辑页面URI

getDefaultViewUri

public String getDefaultViewUri()

获得默认的查看页面URI

返回：

查看页面URI

getDefaultDeleteUri

public String getDefaultDeleteUri()

获得默认的删除请求URI

返回：

删除请求URI

getDefaultAjaxDeleteUri

public String getDefaultAjaxDeleteUri()

getUriPrefix

public StringBuffer getUriPrefix()

获取uri路径的前缀，如ExampleAction的前缀为example，参照convention的约定规则

返回：

getBean

public Object getBean(String interfaceName)

已过时。

功能：根据接口获取外部bundle中的服务实现

参数：

interfaceName -

返回：

getBean

public <T> T getBean(Class<T> interfaceClass)

功能：根据接口获取外部bundle中的服务实现

参数：

interfaceName -

返回：

getSID

public String getSID()

setSID

public void setSID(String sID)

getPage

public Page<?> getPage()

getPriCheckParams

public Map<Object,Object> getPriCheckParams()

setPriCheckParams

public void setPriCheckParams(Map<Object,Object> priCheckParams)

putDebugInfoIfDevMode

protected void putDebugInfoIfDevMode()

往 ActionContext 实例中存放一些调试信息

get_MdId

public final String get_MdId()

set_MdId

public final void set_MdId(String mdId)

getSortField

public String getSortField()

setSortField

public void setSortField(String sortField)

getSortDirection

public String getSortDirection()

setSortDirection

public void setSortDirection(String sortDirection)

setGo

public void setGo(String go)

setServices

public void setServices(List services)

指定者：

接口 org.apache.struts2.osgi.interceptor.ServiceAware 中的 setServices