org.opencms.file.collectors
Interface I_CmsResourceCollector

All Superinterfaces:
java.lang.Comparable
All Known Subinterfaces:
I_CmsListResourceCollector
All Known Implementing Classes:
A_CmsListResourceCollector, A_CmsResourceCollector, CmsCategoryResourceCollector, CmsDateResourceCollector, CmsDefaultResourceCollector, CmsDeleteBrokenRelationsCollector, CmsListResourceLinkRelationCollector, CmsLockedResourcesCollector, CmsNewResourceXmlContentModelCollector, CmsPriorityResourceCollector, CmsPublishBrokenRelationsCollector, CmsSearchResourcesCollector, CmsTimeFrameCategoryCollector

public interface I_CmsResourceCollector
extends java.lang.Comparable

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

Since:
6.0.0
Version:
$Revision: 1.14 $
Author:
Alexander Kandzior

Method Summary
 java.util.List 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.
 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 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 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.
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getCollectorNames

java.util.List getCollectorNames()
Returns a list of all collector names (Strings) this collector implementation supports.

Returns:
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.

Parameters:
cms - the current CmsObject
Returns:
the link to execute after a "new" button was clicked
Throws:
CmsException - if something goes wrong
CmsDataAccessException - if the parameter attribute of the corresponding collector tag is invalid
See Also:
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.

Parameters:
cms - the current CmsObject
collectorName - the name of the collector to use
param - an optional collector parameter
Returns:
the link to execute after a "new" button was clicked
Throws:
CmsException - if something goes wrong
CmsDataAccessException - if the parameter attribute of the corresponding collector tag is invalid
See Also:
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.

Parameters:
cms - the current CmsObject
Returns:
the parameter that will be passed to the getCreateLink(CmsObject, String, String) method, or null
Throws:
CmsDataAccessException - if the param attrib of the corresponding collector tag is invalid
See Also:
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.

Parameters:
cms - the current CmsObject
collectorName - the name of the collector to use
param - an optional collector parameter from the current page context
Returns:
the parameter that will be passed to the getCreateLink(CmsObject, String, String) method, or null
Throws:
CmsDataAccessException - if the parameter attribute of the corresponding collector tag is invalid
See Also:
getCreateLink(CmsObject, String, String)

getDefaultCollectorName

java.lang.String getDefaultCollectorName()
Returns the default collector name to use for collecting resources.

Returns:
the default collector name

getDefaultCollectorParam

java.lang.String getDefaultCollectorParam()
Returns the default collector parameter to use for collecting resources.

Returns:
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.

Returns:
the "order weight" of this collector

getResults

java.util.List 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.

Parameters:
cms - the current CmsObject
Returns:
a list of CmsXmlContent objects
Throws:
CmsException - if something goes wrong
CmsDataAccessException - if the parameter attribute of the corresponding collector tag is invalid

getResults

java.util.List 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.

Parameters:
cms - the current CmsObject
collectorName - the name of the collector to use
param - an optional collector parameter
Returns:
a list of CmsXmlContent objects
Throws:
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.

Parameters:
collectorName - the default collector name

setDefaultCollectorParam

void setDefaultCollectorParam(java.lang.String param)
Sets the default collector parameter to use for collecting resources.

Parameters:
param - the default collector parameter

setOrder

void setOrder(int order)
Sets the "order weight" of this collector.

Parameters:
order - the order weight to set
See Also:
getOrder()