Package org.opencms.workplace.list

Interface I_CmsListResourceCollector

All Superinterfaces:
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 final String
    PARAM_FILTER
    Parameter name constant.
    static final String
    PARAM_ORDER
    Parameter name constant.
    static final String
    PARAM_PAGE
    Parameter name constant.
    static final String
    PARAM_RESOURCES
    Resources parameter name constant.
    static final String
    PARAM_SORTBY
    Parameter name constant.
    static final String
    SEP_KEYVAL
    Key-Value delimiter constant.
    static final 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
    List<CmsListItem>
    getListItems(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.
    List<org.opencms.file.CmsResource>
    getResources(org.opencms.file.CmsObject cms, Map<String,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