Package org.opencms.workplace.list

Interface I_CmsListResourceCollector

All Superinterfaces:

java.lang.Comparable<org.opencms.file.collectors.I_CmsResourceCollector>, org.opencms.file.collectors.I_CmsCollectorPublishListProvider, org.opencms.file.collectors.I_CmsResourceCollector

All Known Implementing Classes:

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

public interface I_CmsListResourceCollector
extends org.opencms.file.collectors.I_CmsResourceCollector

Collector to provide CmsResource objects for a explorer List.

Since:

6.1.0

Field Summary

Fields

Modifier and Type	Field	Description
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.

Fields inherited from interface org.opencms.file.collectors.I_CmsResourceCollector

DEFAULT_LIMIT

Method Summary

Modifier and Type	Method	Description
java.util.List<CmsListItem>	getListItems(java.lang.String parameter)	Returns a list of list items from a list of resources.
org.opencms.file.CmsResource	getResource(org.opencms.file.CmsObject cms, CmsListItem item)	Returns the resource for the given item.
java.util.List<org.opencms.file.CmsResource>	getResources(org.opencms.file.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.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.opencms.file.collectors.I_CmsCollectorPublishListProvider

getPublishResources

Methods inherited from interface org.opencms.file.collectors.I_CmsResourceCollector

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

Field Detail

PARAM_FILTER

static final java.lang.String PARAM_FILTER

Parameter name constant.

See Also:

Constant Field Values

PARAM_ORDER

static final java.lang.String PARAM_ORDER

Parameter name constant.

See Also:

Constant Field Values

PARAM_PAGE

static final java.lang.String PARAM_PAGE

Parameter name constant.

See Also:

Constant Field Values

PARAM_RESOURCES

static final java.lang.String PARAM_RESOURCES

Resources parameter name constant.

See Also:

Constant Field Values

PARAM_SORTBY

static final java.lang.String PARAM_SORTBY

Parameter name constant.

See Also:

Constant Field Values

SEP_KEYVAL

static final java.lang.String SEP_KEYVAL

Key-Value delimiter constant.

See Also:

Constant Field Values

SEP_PARAM

static final java.lang.String SEP_PARAM

Parameter delimiter constant.

See Also:

Constant Field Values

Method Detail

getListItems

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

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

Parameters:

parameter - the collector parameter or null for default.

Returns:

a list of CmsListItem objects

Throws:

org.opencms.main.CmsException - if something goes wrong

getResource

org.opencms.file.CmsResource getResource(org.opencms.file.CmsObject cms,
                                         CmsListItem item)

Returns the resource for the given item.

Parameters:

cms - the cms object

item - the item

Returns:

the resource

getResources

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

Returns all, unsorted and unfiltered, resources.

Be sure to cache the resources.

Parameters:

cms - the cms object

params - the parameter map

Returns:

a list of CmsResource objects

Throws:

org.opencms.main.CmsException - if something goes wrong

getWp

A_CmsListExplorerDialog getWp()

Returns the workplace object.

Returns:

the workplace object

setPage

void setPage(int page)

Sets the current display page.

Parameters:

page - the new display page