Interface PortalLister

  • All Superinterfaces:
    com.adobe.cq.wcm.core.components.models.Component, com.adobe.cq.export.json.ComponentExporter
    All Known Subinterfaces:
    DraftsAndSubmissions, SearchAndLister

    @ConsumerType
    public interface PortalLister
    extends com.adobe.cq.wcm.core.components.models.Component
    Defines the sling model for /apps/core/fd/components/formsportal/portallister component.
    Since:
    com.adobe.cq.forms.core.components.models.formsportal 2.1.0
    • Field Summary

      • Fields inherited from interface com.adobe.cq.wcm.core.components.models.Component

        PN_ID
    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default java.util.Map<java.lang.String,​java.lang.Object> getElements()
      Return search results and data required for pagination.
      default java.lang.String getLayout()
      Returns layout in which sub-views should be rendered
      default java.lang.Integer getLimit()
      Return maximum number of results to be returned by getItemList at a time
      default java.lang.String getTitle()
      Returns title string of component
      • Methods inherited from interface com.adobe.cq.wcm.core.components.models.Component

        getAppliedCssClasses, getData, getExportedType, getId
    • Method Detail

      • getTitle

        default java.lang.String getTitle()
        Returns title string of component
        Returns:
        Search and Lister Title String
        Since:
        com.adobe.cq.forms.core.components.models.formsportal 2.1.0
      • getLayout

        default java.lang.String getLayout()
        Returns layout in which sub-views should be rendered
        Returns:
        String indication layout of listing
        Since:
        com.adobe.cq.forms.core.components.models.formsportal 2.1.0
      • getLimit

        default java.lang.Integer getLimit()
        Return maximum number of results to be returned by getItemList at a time
        Returns:
        String containing numeric value of limit
        Since:
        com.adobe.cq.forms.core.components.models.formsportal 2.1.0
      • getElements

        default java.util.Map<java.lang.String,​java.lang.Object> getElements()
        Return search results and data required for pagination.
        Returns:
        Map of key to object
        Since:
        com.adobe.cq.forms.core.components.models.formsportal 2.1.0