| org.opencms.file.collectors.I_CmsResourceCollector
All known Subclasses: org.opencms.file.collectors.A_CmsResourceCollector,
| I_CmsResourceCollector | | public interface I_CmsResourceCollector extends Comparable(Code) | | A collector that generates list of
org.opencms.file.CmsResource objects from the VFS.
author:
Alexander Kandzior
version:
$Revision: 1.12 $
since:
6.0.0 |
| getCollectorNames | | List getCollectorNames()(Code) | | Returns a list of all collector names (Strings) this collector implementation supports.
a list of all collector names this collector implementation supports |
| getCreateLink | | String getCreateLink(CmsObject cms, String collectorName, String param) throws CmsException, CmsDataAccessException(Code) | | 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
Parameters:
collectorName - the name of the collector to use
Parameters:
param - an optional collector parameter the link to execute after a "new" button was clicked
throws:
CmsException - if something goes wrong
throws:
CmsDataAccessException - if the parameter attribute of the corresponding collector tag is invalid
See Also: I_CmsResourceCollector.getCreateParam(CmsObject,String,String) |
| getCreateParam | | String getCreateParam(CmsObject cms, String collectorName, String param) throws CmsDataAccessException(Code) | | Returns the parameter that must be passed to the
I_CmsResourceCollector.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
Parameters:
collectorName - the name of the collector to use
Parameters:
param - an optional collector parameter from the current page context the parameter that will be passed to the I_CmsResourceCollector.getCreateLink(CmsObject,String,String) method, or null
throws:
CmsDataAccessException - if the parameter attribute of the corresponding collector tag is invalid
See Also: I_CmsResourceCollector.getCreateLink(CmsObject,String,String) |
| getDefaultCollectorName | | String getDefaultCollectorName()(Code) | | Returns the default collector name to use for collecting resources.
the default collector name |
| getDefaultCollectorParam | | String getDefaultCollectorParam()(Code) | | Returns the default collector parameter to use for collecting resources.
the default collector parameter |
| getOrder | | int getOrder()(Code) | | 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 |
| setDefaultCollectorName | | void setDefaultCollectorName(String collectorName)(Code) | | Sets the default collector name to use for collecting resources.
Parameters:
collectorName - the default collector name |
| setDefaultCollectorParam | | void setDefaultCollectorParam(String param)(Code) | | Sets the default collector parameter to use for collecting resources.
Parameters:
param - the default collector parameter |
|
|