org.opencms.file.collectors

接口 I_CmsResourceCollector

所有超级接口:

java.lang.Comparable<I_CmsResourceCollector>

所有已知子接口:

I_CmsListResourceCollector

所有已知实现类:

A_CmsListResourceCollector, A_CmsResourceCollector, CmsCategoryResourceCollector, CmsChangedResourceCollector, CmsContentCheckCollector, CmsDateResourceCollector, CmsDefaultResourceCollector, CmsDeleteBrokenRelationsCollector, CmsInternalLinkValidationFilesCollector, CmsListResourceLinkRelationCollector, CmsLockedResourcesCollector, CmsNewResourceXmlContentModelCollector, CmsPriorityResourceCollector, CmsProjectFilesCollector, CmsPublishBrokenRelationsCollector, CmsSearchResourcesCollector, CmsShowOrgUnitResourcesCollector, CmsSolrCollector, CmsSourceSearchCollector, CmsSubscriptionCollector, CmsTimeFrameCategoryCollector

public interface I_CmsResourceCollector
extends java.lang.Comparable<I_CmsResourceCollector>

A collector that generates list of CmsResource objects from the VFS.

从以下版本开始:

6.0.0

方法概要

方法

限定符和类型	方法和说明
java.util.List<java.lang.String>	getCollectorNames() Returns a list of all collector names (Strings) this collector implementation supports.
java.lang.String	getCreateLink(CmsObject cms) Returns the link that must be executed when a user clicks on the direct edit "new" button on a list created by the default collector.
java.lang.String	getCreateLink(CmsObject cms, java.lang.String collectorName, java.lang.String param) Returns the link that must be executed when a user clicks on the direct edit "new" button on a list created by the named collector.
java.lang.String	getCreateParam(CmsObject cms) Returns the default parameter that must be passed to the getCreateLink(CmsObject, String, String) method.
java.lang.String	getCreateParam(CmsObject cms, java.lang.String collectorName, java.lang.String param) Returns the parameter that must be passed to the getCreateLink(CmsObject, String, String) method.
int	getCreateTypeId(CmsObject cms, java.lang.String collectorName, java.lang.String param) Returns the id of the resource type for new collector items.
java.lang.String	getDefaultCollectorName() Returns the default collector name to use for collecting resources.
java.lang.String	getDefaultCollectorParam() Returns the default collector parameter to use for collecting resources.
int	getOrder() Returns the "order weight" of this collector.
java.util.List<CmsResource>	getResults(CmsObject cms) Returns a list of CmsResource Objects that are gathered in the VFS using the default collector name and parameter.
java.util.List<CmsResource>	getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param) Returns a list of CmsResource Objects that are gathered in the VFS using the named collector.
void	setDefaultCollectorName(java.lang.String collectorName) Sets the default collector name to use for collecting resources.
void	setDefaultCollectorParam(java.lang.String param) Sets the default collector parameter to use for collecting resources.
void	setOrder(int order) Sets the "order weight" of this collector.

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

compareTo

方法详细资料

getCollectorNames

java.util.List<java.lang.String> getCollectorNames()

Returns a list of all collector names (Strings) this collector implementation supports.

返回:

a list of all collector names this collector implementation supports

getCreateLink

java.lang.String getCreateLink(CmsObject cms)
                               throws CmsException,
                                      CmsDataAccessException

Returns the link that must be executed when a user clicks on the direct edit "new" button on a list created by the default collector.

If this method returns null, it indicated that the selected collector implementation does not support a "create link", and so no "new" button will should shown on lists generated with this collector.

参数:

cms - the current CmsObject

返回:

the link to execute after a "new" button was clicked

抛出:

CmsException - if something goes wrong

CmsDataAccessException - if the parameter attribute of the corresponding collector tag is invalid

另请参阅:

getCreateParam(CmsObject, String, String)

getCreateLink

java.lang.String getCreateLink(CmsObject cms,
                             java.lang.String collectorName,
                             java.lang.String param)
                               throws CmsException,
                                      CmsDataAccessException

Returns the link that must be executed when a user clicks on the direct edit "new" button on a list created by the named collector.

If this method returns null, it indicated that the selected collector implementation does not support a "create link", and so no "new" button will should shown on lists generated with this collector.

参数:

cms - the current CmsObject

collectorName - the name of the collector to use

param - an optional collector parameter

返回:

the link to execute after a "new" button was clicked

抛出:

CmsException - if something goes wrong

CmsDataAccessException - if the parameter attribute of the corresponding collector tag is invalid

另请参阅:

getCreateParam(CmsObject, String, String)

getCreateParam

java.lang.String getCreateParam(CmsObject cms)
                                throws CmsDataAccessException

Returns the default parameter that must be passed to the getCreateLink(CmsObject, String, String) method.

If this method returns null, it indicates that the selected collector implementation does not support a "create link", and so no "new" button will should shown on lists generated with this collector.

参数:

cms - the current CmsObject

返回:

the parameter that will be passed to the getCreateLink(CmsObject, String, String) method, or null

抛出:

CmsDataAccessException - if the param attrib of the corresponding collector tag is invalid

另请参阅:

getCreateLink(CmsObject, String, String)

getCreateParam

java.lang.String getCreateParam(CmsObject cms,
                              java.lang.String collectorName,
                              java.lang.String param)
                                throws CmsDataAccessException

Returns the parameter that must be passed to the getCreateLink(CmsObject, String, String) method.

If this method returns null, it indicates that the selected collector implementation does not support a "create link", and so no "new" button will should shown on lists generated with this collector.

参数:

cms - the current CmsObject

collectorName - the name of the collector to use

param - an optional collector parameter from the current page context

返回:

the parameter that will be passed to the getCreateLink(CmsObject, String, String) method, or null

抛出:

CmsDataAccessException - if the parameter attribute of the corresponding collector tag is invalid

另请参阅:

getCreateLink(CmsObject, String, String)

getCreateTypeId

int getCreateTypeId(CmsObject cms,
                  java.lang.String collectorName,
                  java.lang.String param)
                    throws CmsException

Returns the id of the resource type for new collector items.

Returns -1 if creation of new items is not supported.

参数:

cms - the current CmsObject

collectorName - the name of the collector to use

param - an optional collector parameter

返回:

the resource type id

抛出:

CmsException - if something goes wrong

getDefaultCollectorName

java.lang.String getDefaultCollectorName()

Returns the default collector name to use for collecting resources.

返回:

the default collector name

getDefaultCollectorParam

java.lang.String getDefaultCollectorParam()

Returns the default collector parameter to use for collecting resources.

返回:

the default collector parameter

getOrder

int getOrder()

Returns the "order weight" of this collector.

The "order weight" is important because two collector classes may provide a collector with the same name. If this is the case, the collector implementation with the higher order number "overrules" the lower order number class.

返回:

the "order weight" of this collector

getResults

java.util.List<CmsResource> getResults(CmsObject cms)
                                       throws CmsDataAccessException,
                                              CmsException

Returns a list of CmsResource Objects that are gathered in the VFS using the default collector name and parameter.

参数:

cms - the current CmsObject

返回:

a list of CmsXmlContent objects

抛出:

CmsException - if something goes wrong

CmsDataAccessException - if the parameter attribute of the corresponding collector tag is invalid

getResults

java.util.List<CmsResource> getResults(CmsObject cms,
                                     java.lang.String collectorName,
                                     java.lang.String param)
                                       throws CmsDataAccessException,
                                              CmsException

Returns a list of CmsResource Objects that are gathered in the VFS using the named collector.

参数:

cms - the current CmsObject

collectorName - the name of the collector to use

param - an optional collector parameter

返回:

a list of CmsXmlContent objects

抛出:

CmsException - if something goes wrong

CmsDataAccessException - if the parameter attribute of the corresponding collector tag is invalid

setDefaultCollectorName

void setDefaultCollectorName(java.lang.String collectorName)

Sets the default collector name to use for collecting resources.

参数:

collectorName - the default collector name

setDefaultCollectorParam

void setDefaultCollectorParam(java.lang.String param)

Sets the default collector parameter to use for collecting resources.

参数:

param - the default collector parameter

setOrder

void setOrder(int order)

Sets the "order weight" of this collector.

参数:

order - the order weight to set

另请参阅:

getOrder()