org.opencms.workplace.list

接口 I_CmsListResourceCollector

所有超级接口:

java.lang.Comparable<I_CmsResourceCollector>, I_CmsResourceCollector

所有已知实现类:

A_CmsListResourceCollector, CmsContentCheckCollector, CmsDeleteBrokenRelationsCollector, CmsInternalLinkValidationFilesCollector, CmsListResourceLinkRelationCollector, CmsLockedResourcesCollector, CmsNewResourceXmlContentModelCollector, CmsProjectFilesCollector, CmsPublishBrokenRelationsCollector, CmsSearchResourcesCollector, CmsShowOrgUnitResourcesCollector, CmsSourceSearchCollector

public interface I_CmsListResourceCollector
extends I_CmsResourceCollector

Collector to provide CmsResource objects for a explorer List.

从以下版本开始:

6.1.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	PARAM_FILTER Parameter name constant.
static java.lang.String	PARAM_ORDER Parameter name constant.
static java.lang.String	PARAM_PAGE Parameter name constant.
static java.lang.String	PARAM_RESOURCES Resources parameter name constant.
static java.lang.String	PARAM_SORTBY Parameter name constant.
static java.lang.String	SEP_KEYVAL Key-Value delimiter constant.
static java.lang.String	SEP_PARAM Parameter delimiter constant.

方法概要

方法

限定符和类型	方法和说明
java.util.List<CmsListItem>	getListItems(java.lang.String parameter) Returns a list of list items from a list of resources.
CmsResource	getResource(CmsObject cms, CmsListItem item) Returns the resource for the given item.
java.util.List<CmsResource>	getResources(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params) Returns all, unsorted and unfiltered, resources.
A_CmsListExplorerDialog	getWp() Returns the workplace object.
void	setPage(int page) Sets the current display page.

从接口继承的方法 org.opencms.file.collectors.I_CmsResourceCollector

getCollectorNames, getCreateLink, getCreateLink, getCreateParam, getCreateParam, getCreateTypeId, getDefaultCollectorName, getDefaultCollectorParam, getOrder, getResults, getResults, setDefaultCollectorName, setDefaultCollectorParam, setOrder

从接口继承的方法 java.lang.Comparable

compareTo

字段详细资料

PARAM_FILTER

static final java.lang.String PARAM_FILTER

Parameter name constant.

另请参阅:

常量字段值

PARAM_ORDER

static final java.lang.String PARAM_ORDER

Parameter name constant.

另请参阅:

常量字段值

PARAM_PAGE

static final java.lang.String PARAM_PAGE

Parameter name constant.

另请参阅:

常量字段值

PARAM_RESOURCES

static final java.lang.String PARAM_RESOURCES

Resources parameter name constant.

另请参阅:

常量字段值

PARAM_SORTBY

static final java.lang.String PARAM_SORTBY

Parameter name constant.

另请参阅:

常量字段值

SEP_KEYVAL

static final java.lang.String SEP_KEYVAL

Key-Value delimiter constant.

另请参阅:

常量字段值

SEP_PARAM

static final java.lang.String SEP_PARAM

Parameter delimiter constant.

另请参阅:

常量字段值

方法详细资料

getListItems

java.util.List<CmsListItem> getListItems(java.lang.String parameter)
                                         throws CmsException

Returns a list of list items from a list of resources.

参数:

parameter - the collector parameter or null for default.

返回:

a list of CmsListItem objects

抛出:

CmsException - if something goes wrong

getResource

CmsResource getResource(CmsObject cms,
                      CmsListItem item)

Returns the resource for the given item.

参数:

cms - the cms object

item - the item

返回:

the resource

getResources

java.util.List<CmsResource> getResources(CmsObject cms,
                                       java.util.Map<java.lang.String,java.lang.String> params)
                                         throws CmsException

Returns all, unsorted and unfiltered, resources.

Be sure to cache the resources.

参数:

cms - the cms object

params - the parameter map

返回:

a list of CmsResource objects

抛出:

CmsException - if something goes wrong

getWp

A_CmsListExplorerDialog getWp()

Returns the workplace object.

返回:

the workplace object

setPage

void setPage(int page)

Sets the current display page.

参数:

page - the new display page