Package com.xwiki.macros.confluence.detailssummary.macro

Class DetailsSummaryMacroParameters

java.lang.Object
com.xwiki.macros.confluence.detailssummary.macro.DetailsSummaryMacroParameters
public class DetailsSummaryMacroParameters extends Object
Parameter bean class for the DetailsSummaryMacro. This class holds all the parameters that can be configured for the macro.
Since:
1.29.0
Version:
$Id$

  • Constructor Details

    • DetailsSummaryMacroParameters

      public DetailsSummaryMacroParameters()

  • Method Details

    • getId

      public String getId()
      Returns:
      the unique identifier for the macro instance.

    • setId

      public void setId(String id)
      Parameters:
      id - the id to set

    • getHeadings

      public String getHeadings()
      Returns:
      the headings to display in the macro output.

    • setHeadings

      public void setHeadings(String headings)
      Parameters:
      headings - the headings to set

    • getCql

      public String getCql()
      Returns:
      the Confluence Query Language (CQL) query string used to filter content.

    • setCql

      public void setCql(String cql)
      Parameters:
      cql - the Confluence Query Language (CQL) query string used to filter content.

    • getLabel

      public String getLabel()
      Returns:
      the label to filter pages or content by.

    • setLabel

      public void setLabel(String label)
      Parameters:
      label - the label to filter pages or content by.

    • getFirstcolumn

      public String getFirstcolumn()
      Returns:
      the name of the first column to display in the output.

    • setFirstcolumn

      public void setFirstcolumn(String firstcolumn)
      Parameters:
      firstcolumn - the name of the first column to display in the output.

    • showLastModified

      public boolean showLastModified()
      Returns:
      true if last modified date should be shown, false otherwise

    • setShowLastModified

      public void setShowLastModified(boolean showLastModified)
      Parameters:
      showLastModified - true to show last modified date, false otherwise

    • showPageLabels

      public boolean showPageLabels()
      Returns:
      true if page labels should be shown, false otherwise

    • setShowPageLabels

      public void setShowPageLabels(boolean showPageLabels)
      Parameters:
      showPageLabels - true to show page labels, false otherwise

    • showCreator

      public boolean showCreator()
      Returns:
      true if creator should be shown, false otherwise

    • setShowCreator

      public void setShowCreator(boolean showCreator)
      Parameters:
      showCreator - true to show creator, false otherwise

    • getOperator

      public String getOperator()
      Returns:
      the operator used in filtering (e.g., AND, OR).

    • setOperator

      public void setOperator(String operator)
      Parameters:
      operator - the operator to set

    • getMax

      public int getMax()
      Returns:
      the max number of results

    • setMax

      public void setMax(int max)
      Parameters:
      max - the max number of results

    • getSort

      public String getSort()
      Returns:
      the sort field

    • setSort

      public void setSort(String sort)
      Parameters:
      sort - the sort field to set

    • getReverse

      public boolean getReverse()
      Returns:
      true if reverse sort, false otherwise

    • setReverse

      public void setReverse(boolean reverseSort)
      Parameters:
      reverseSort - true to reverse sort, false otherwise