|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface I_CmsResourceCollector
A collector that generates list of CmsResource
objects from the VFS.
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 |
---|
java.util.List getCollectorNames()
java.lang.String getCreateLink(CmsObject cms) throws CmsException, CmsDataAccessException
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
CmsException
- if something goes wrong
CmsDataAccessException
- if the param attrib of the corresponding collector tag is invalidgetCreateParam(CmsObject, String, String)
java.lang.String getCreateLink(CmsObject cms, java.lang.String collectorName, java.lang.String param) throws CmsException, CmsDataAccessException
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 CmsObjectcollectorName
- the name of the collector to useparam
- an optional collector parameter
CmsException
- if something goes wrong
CmsDataAccessException
- if the param attrib of the corresponding collector tag is invalidgetCreateParam(CmsObject, String, String)
java.lang.String getCreateParam(CmsObject cms) throws CmsDataAccessException
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
getCreateLink(CmsObject, String, String)
method, or null
CmsDataAccessException
- if the param attrib of the corresponding collector tag is invalidgetCreateLink(CmsObject, String, String)
java.lang.String getCreateParam(CmsObject cms, java.lang.String collectorName, java.lang.String param) throws CmsDataAccessException
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 CmsObjectcollectorName
- the name of the collector to useparam
- an optional collector parameter from the current page context
getCreateLink(CmsObject, String, String)
method, or null
CmsDataAccessException
- if the param attrib of the corresponding collector tag is invalidgetCreateLink(CmsObject, String, String)
java.lang.String getDefaultCollectorName()
java.lang.String getDefaultCollectorParam()
int getOrder()
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 classs.
java.util.List getResults(CmsObject cms) throws CmsDataAccessException, CmsException
CmsResource
Objects that are
gathered in the VFS using the default collector name and parameter.
cms
- the current CmsObject
CmsException
- if something goes wrong
CmsDataAccessException
- if the param attrib of the corresponding collector tag is invalidjava.util.List getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param) throws CmsDataAccessException, CmsException
CmsResource
Objects that are
gathered in the VFS using the named collector.
cms
- the current CmsObjectcollectorName
- the name of the collector to useparam
- an optional collector parameter
CmsException
- if something goes wrong
CmsDataAccessException
- if the param attrib of the corresponding collector tag is invalidvoid setDefaultCollectorName(java.lang.String collectorName)
collectorName
- the default collector namevoid setDefaultCollectorParam(java.lang.String param)
param
- the default collector parametervoid setOrder(int order)
order
- the order weight to setgetOrder()
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |