Class LiveDataMacroParameters


  • public class LiveDataMacroParameters
    extends Object
    Parameters for LiveDataMacro.
    Since:
    12.10
    Version:
    $Id: 86a0083ce68661152b37668ea39b92a5fcc89ee4 $
    • Constructor Detail

      • LiveDataMacroParameters

        public LiveDataMacroParameters()
    • Method Detail

      • getId

        public String getId()
        Returns:
        the live data instance id
      • setId

        public void setId​(String id)
        Sets the live data instance id.
        Parameters:
        id - the live data instance id
      • getProperties

        public String getProperties()
        Returns:
        the comma-separated list of properties to fetch and display
      • setProperties

        public void setProperties​(String properties)
        Sets the comma-separated list of properties to fetch and display.
        Parameters:
        properties - the comma-separated list of properties to fetch and display
      • getSource

        public String getSource()
        Returns:
        the live data source component implementation hint
      • setSource

        public void setSource​(String source)
        Sets the live data source component implementation hint.
        Parameters:
        source - the live data source component implementation hint
      • getSourceParameters

        public String getSourceParameters()
        Returns:
        the live data source parameters, as an URL query string
      • setSourceParameters

        public void setSourceParameters​(String sourceParameters)
        Sets the live data source parameters.
        Parameters:
        sourceParameters - the live data source parameters, specified as an URL query string
      • getSort

        public String getSort()
        Returns:
        the properties to sort on the live data initially
      • setSort

        public void setSort​(String sort)
        Sets the properties to sort on the live data initially. The value is a comma-separated list of property names, where each property name can optionally be suffixed with the sort order using :asc or :desc.
        Parameters:
        sort - the properties to sort on the live data initially
      • getFilters

        public String getFilters()
        Returns:
        the initial filters to apply on the live data
      • setFilters

        public void setFilters​(String filters)
        Sets the initial filters to apply on the live data, specified as an URL query string.
        Parameters:
        filters - the initial filters to apply on the live data
      • getLimit

        public Integer getLimit()
        Returns:
        the maximum number of live data entries to show on a page
      • setLimit

        public void setLimit​(Integer limit)
        Sets the maximum number of live data entries to show on a page.
        Parameters:
        limit - the maximum number of live data entries to show on a page
      • getOffset

        public Long getOffset()
        Returns:
        the index of the first live data entry to show
      • setOffset

        public void setOffset​(Long offset)
        Sets the index of the first live data entry to show.
        Parameters:
        offset - the index of the first live data entry to show
      • getLayouts

        public String getLayouts()
        Returns:
        a comma-separated list of layout identifiers, indicating the layouts the user can choose from to display the live data
      • setLayouts

        public void setLayouts​(String layouts)
        Sets the layouts that the user can choose from to display the live data. The first layout in the list will be loaded initially.
        Parameters:
        layouts - a comma-separated list of layout identifiers
      • getShowPageSizeDropdown

        public Boolean getShowPageSizeDropdown()
        Returns:
        whether to show or not the page size drop down that allows the user to change the number of entries displayed per page
      • setShowPageSizeDropdown

        public void setShowPageSizeDropdown​(Boolean showPageSizeDropdown)
        Sets whether to show or not the page size drop down that allows the user to change the number of entries displayed per page.
        Parameters:
        showPageSizeDropdown - true to show the page size drop down, false otherwise; leave null to inherit from the default configuration
      • getPageSizes

        public String getPageSizes()
        Returns:
        the values to display in the page size drop down
      • setPageSizes

        public void setPageSizes​(String pageSizes)
        Sets the values to display in the page size drop down.
        Parameters:
        pageSizes - a comma-separated list of page sizes to display in the page size drop down