com.seeyon.ctp.portal.section
接口 BaseSection

所有已知实现类：

BannerSection, com.seeyon.ctp.portal.section.BaseSectionImpl

public interface BaseSection

Title: 栏目接口

Description: 本类为栏目接口,栏目开发请继承BaseSectionImpl

Copyright: Copyright (c) 2012

Company: seeyon.com

从以下版本开始：

CTP2.0

方法摘要

java.lang.String	doGetBaseName(java.lang.String entityId, java.lang.String ordinal, java.lang.String spaceType, java.lang.String ownerId) 获取栏目原始名称
java.lang.String	doGetName(java.lang.String entityId, java.lang.String ordinal, java.lang.String spaceType, java.lang.String ownerId, java.lang.String spaceId) 这个方法是供Ajax Service调用的
java.lang.Integer	doGetTotal(java.lang.String entityId, java.lang.String ordinal, java.lang.String spaceType, java.lang.String ownerId) 这个方法是供Ajax Service调用的 获取总数据条数
java.lang.String	doGetTotalUnit(java.lang.String entityId, java.lang.String ordinal, java.lang.String spaceType, java.lang.String ownerId) 获取总数据条数的单位，如：条、个...
java.util.Map<java.lang.String,java.lang.Object>	doProjection(java.lang.String entityId, java.lang.String ordinal, java.lang.String spaceType, java.lang.String ownerId, java.lang.String x, java.lang.String y, java.lang.String width, java.lang.String panelId, java.lang.String[] paramKeys, java.lang.String[] paramValues) 这个方法是供Ajax Service调用的 2011.2.17 增加panelId 标示页签id 增加传递参数
java.lang.String	getBaseName(java.util.Map<java.lang.String,java.lang.String> preference) 获取栏目的默认名称
int	getDelay()
java.lang.String	getHTML(java.lang.String entityId, java.lang.String ordinal, java.lang.String spaceType, java.lang.String ownerId, java.lang.Long spaceId)
java.lang.String	getIcon() 栏目图标，统一放在 /apps_res/v3xmain/images/section下
java.lang.String	getId() 栏目的唯一标示，同时也是Spring Bean定义的Id, 如： ***-manager.xml <bean id="pendingSection" class="com.seeyon.v3x.main.section.PendingSection"> <property name="id" ref="pendingSection" /> </bean> 特别提示：该值作为栏目的标示将会写到数据库中去，故： 1、不要随意变化 2、要唯一 3、必须由数字、字母、下划线构成
java.lang.String	getName(java.util.Map<java.lang.String,java.lang.String> preference) 栏目名称的国际化key，资源文件在/apps_res/v3xmain/js/i18n
java.util.List<com.seeyon.ctp.portal.section.SectionProperty>	getProperties()
java.lang.String	getResourceBundle()
java.lang.String	getSectionCategory()
java.lang.String[]	getSectionTypes()
java.lang.Integer	getSortId() 获取栏目排序号
java.lang.String[]	getSpaceTypes()
java.lang.Integer	getTotal(java.util.Map<java.lang.String,java.lang.String> preference) 总数，如果不需要显示总数，就返回null
java.lang.String	getTotalUnit(java.util.Map<java.lang.String,java.lang.String> preference) 取得数量的单位，比如：个、项、条，默认“项”，注意国际化
boolean	hasParam() 是否有参数配置 见section.xml.
boolean	isAllowedNarrow()
boolean	isAllowUsed() 是否允许添加-使用该栏目，默认允许，如果需要特别控制，需要重载该方法，当前登录信息从CurrentUser中取
boolean	isAllowUsed(java.lang.Long singleBoardId) 是否允许添加该栏目，默认允许，如果需要特别控制，需要重载该方法，当前登录信息从CurrentUser中取 如果不允许，将不出现在备选栏目中；但如果是管理员推送的栏目，可以访问
boolean	isAllowUsed(java.lang.String spaceType) 是否允许添加该栏目，默认允许，如果需要特别控制，需要重载该方法，当前登录信息从CurrentUser中取 如果不允许，将不出现在备选栏目中；但如果是管理员推送的栏目，可以访问
boolean	isAllowUserUsed(java.lang.String singleBoardId) 是否允许用户访问该栏目，默认允许，如果需要特别控制，需要重载该方法，当前登录信息从CurrentUser中取 如果不允许，将不出现在备选栏目中；即使是管理员推送的栏目，也不可以访问 重写isAllowUserUsed（String singleBoardId）方法后不需要重写isAllowUsed()方法;
boolean	isFilterOut()
boolean	isReadOnly(java.lang.String spaceType, java.lang.String ownerId) 对于空间的权限，是否只读。
boolean	isRegistrer()
com.seeyon.ctp.portal.section.templete.BaseSectionTemplete	projection(java.util.Map<java.lang.String,java.lang.String> preference) 在这里发射数据
void	setProperties(java.util.List<com.seeyon.ctp.portal.section.SectionProperty> properties)
void	setResourceBundle(java.lang.String resourceBundle) 国际化资源
void	setSectionCategory(java.lang.String sectionCategory)

方法详细信息

getId

java.lang.String getId()

栏目的唯一标示，同时也是Spring Bean定义的Id, 如：

 
 ***-manager.xml
   
 <bean id="pendingSection" class="com.seeyon.v3x.main.section.PendingSection">
   <property name="id" ref="pendingSection" />
 </bean>
 
 
 特别提示：该值作为栏目的标示将会写到数据库中去，故：
 1、不要随意变化
 2、要唯一
 3、必须由数字、字母、下划线构成
 

返回：

直接返回一个有字符+数字组成的字符串，如：pendingSection

getName

java.lang.String getName(java.util.Map<java.lang.String,java.lang.String> preference)

栏目名称的国际化key，资源文件在/apps_res/v3xmain/js/i18n

参数：

preference - Portlet实例的配置参数

返回：

getBaseName

java.lang.String getBaseName(java.util.Map<java.lang.String,java.lang.String> preference)

获取栏目的默认名称

参数：

preference -

返回：

getTotal

java.lang.Integer getTotal(java.util.Map<java.lang.String,java.lang.String> preference)

总数，如果不需要显示总数，就返回null

参数：

preference - Portlet实例的配置参数

返回：

getTotalUnit

java.lang.String getTotalUnit(java.util.Map<java.lang.String,java.lang.String> preference)

取得数量的单位，比如：个、项、条，默认“项”，注意国际化

参数：

preference -

返回：

getIcon

java.lang.String getIcon()

栏目图标，统一放在 /apps_res/v3xmain/images/section下

返回：

如 /apps_res/v3xmain/images/section/pending.col.gif

projection

com.seeyon.ctp.portal.section.templete.BaseSectionTemplete projection(java.util.Map<java.lang.String,java.lang.String> preference)

在这里发射数据

参数：

preference - Portlet实例的配置参数

返回：

getHTML

java.lang.String getHTML(java.lang.String entityId,
                         java.lang.String ordinal,
                         java.lang.String spaceType,
                         java.lang.String ownerId,
                         java.lang.Long spaceId)

isAllowUsed

boolean isAllowUsed()

是否允许添加-使用该栏目，默认允许，如果需要特别控制，需要重载该方法，当前登录信息从CurrentUser中取

返回：

isAllowUsed

boolean isAllowUsed(java.lang.Long singleBoardId)

是否允许添加该栏目，默认允许，如果需要特别控制，需要重载该方法，当前登录信息从CurrentUser中取 如果不允许，将不出现在备选栏目中；但如果是管理员推送的栏目，可以访问

返回：

isAllowUsed

boolean isAllowUsed(java.lang.String spaceType)

是否允许添加该栏目，默认允许，如果需要特别控制，需要重载该方法，当前登录信息从CurrentUser中取 如果不允许，将不出现在备选栏目中；但如果是管理员推送的栏目，可以访问

返回：

isAllowUserUsed

boolean isAllowUserUsed(java.lang.String singleBoardId)

是否允许用户访问该栏目，默认允许，如果需要特别控制，需要重载该方法，当前登录信息从CurrentUser中取 如果不允许，将不出现在备选栏目中；即使是管理员推送的栏目，也不可以访问 重写isAllowUserUsed（String singleBoardId）方法后不需要重写isAllowUsed()方法;

参数：

singleBoardId - 带独立ID的栏目使用该ID获取

返回：

doProjection

java.util.Map<java.lang.String,java.lang.Object> doProjection(java.lang.String entityId,
                                                              java.lang.String ordinal,
                                                              java.lang.String spaceType,
                                                              java.lang.String ownerId,
                                                              java.lang.String x,
                                                              java.lang.String y,
                                                              java.lang.String width,
                                                              java.lang.String panelId,
                                                              java.lang.String[] paramKeys,
                                                              java.lang.String[] paramValues)

这个方法是供Ajax Service调用的 2011.2.17 增加panelId 标示页签id 增加传递参数

doGetTotal

java.lang.Integer doGetTotal(java.lang.String entityId,
                             java.lang.String ordinal,
                             java.lang.String spaceType,
                             java.lang.String ownerId)

这个方法是供Ajax Service调用的 获取总数据条数

参数：

entityId -

ordinal -

layoutType -

返回：

doGetTotalUnit

java.lang.String doGetTotalUnit(java.lang.String entityId,
                                java.lang.String ordinal,
                                java.lang.String spaceType,
                                java.lang.String ownerId)

获取总数据条数的单位，如：条、个...

参数：

entityId -

ordinal -

spaceType -

ownerId -

返回：

doGetName

java.lang.String doGetName(java.lang.String entityId,
                           java.lang.String ordinal,
                           java.lang.String spaceType,
                           java.lang.String ownerId,
                           java.lang.String spaceId)

这个方法是供Ajax Service调用的

参数：

entityId -

ordinal -

返回：

doGetBaseName

java.lang.String doGetBaseName(java.lang.String entityId,
                               java.lang.String ordinal,
                               java.lang.String spaceType,
                               java.lang.String ownerId)

获取栏目原始名称

参数：

entityId -

ordinal -

spaceType -

ownerId -

返回：

getSpaceTypes

java.lang.String[] getSpaceTypes()

isAllowedNarrow

boolean isAllowedNarrow()

isRegistrer

boolean isRegistrer()

isFilterOut

boolean isFilterOut()

isReadOnly

boolean isReadOnly(java.lang.String spaceType,
                   java.lang.String ownerId)

对于空间的权限，是否只读。

参数：

entityId -

spaceType -

ownerId -

返回：

hasParam

boolean hasParam()

是否有参数配置
见section.xml.

返回：

getDelay

int getDelay()

getProperties

java.util.List<com.seeyon.ctp.portal.section.SectionProperty> getProperties()

setProperties

void setProperties(java.util.List<com.seeyon.ctp.portal.section.SectionProperty> properties)

getResourceBundle

java.lang.String getResourceBundle()

setResourceBundle

void setResourceBundle(java.lang.String resourceBundle)

国际化资源

参数：

resourceBundle - 如：com.seeyon.v3x.resouces.i18n.ApplicationResourceBundle

getSectionTypes

java.lang.String[] getSectionTypes()

getSectionCategory

java.lang.String getSectionCategory()

setSectionCategory

void setSectionCategory(java.lang.String sectionCategory)

getSortId

java.lang.Integer getSortId()

获取栏目排序号