@Unstable public class LiveDataMacroParameters extends Object
LiveDataMacro
.Constructor and Description |
---|
LiveDataMacroParameters() |
Modifier and Type | Method and Description |
---|---|
String |
getFilters() |
String |
getId() |
String |
getLayouts() |
Integer |
getLimit() |
Long |
getOffset() |
String |
getPageSizes() |
String |
getProperties() |
Boolean |
getShowPageSizeDropdown() |
String |
getSort() |
String |
getSource() |
String |
getSourceParameters() |
void |
setFilters(String filters)
Sets the initial filters to apply on the live data, specified as an URL query string.
|
void |
setId(String id)
Sets the live data instance id.
|
void |
setLayouts(String layouts)
Sets the layouts that the user can choose from to display the live data.
|
void |
setLimit(Integer limit)
Sets the maximum number of live data entries to show on a page.
|
void |
setOffset(Long offset)
Sets the index of the first live data entry to show.
|
void |
setPageSizes(String pageSizes)
Sets the values to display in the page size drop down.
|
void |
setProperties(String properties)
Sets the comma-separated list of properties to fetch and display.
|
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.
|
void |
setSort(String sort)
Sets the properties to sort on the live data initially.
|
void |
setSource(String source)
Sets the live data source component implementation hint.
|
void |
setSourceParameters(String sourceParameters)
Sets the live data source parameters.
|
public String getId()
public void setId(String id)
id
- the live data instance idpublic String getProperties()
public void setProperties(String properties)
properties
- the comma-separated list of properties to fetch and displaypublic String getSource()
public void setSource(String source)
source
- the live data source component implementation hintpublic String getSourceParameters()
public void setSourceParameters(String sourceParameters)
sourceParameters
- the live data source parameters, specified as an URL query stringpublic String getSort()
public void setSort(String sort)
:asc
or :desc
.sort
- the properties to sort on the live data initiallypublic String getFilters()
public void setFilters(String filters)
filters
- the initial filters to apply on the live datapublic Integer getLimit()
public void setLimit(Integer limit)
limit
- the maximum number of live data entries to show on a pagepublic Long getOffset()
public void setOffset(Long offset)
offset
- the index of the first live data entry to showpublic String getLayouts()
public void setLayouts(String layouts)
layouts
- a comma-separated list of layout identifierspublic Boolean getShowPageSizeDropdown()
public void setShowPageSizeDropdown(Boolean showPageSizeDropdown)
showPageSizeDropdown
- true
to show the page size drop down, false
otherwise; leave
null
to inherit from the default configurationpublic String getPageSizes()
public void setPageSizes(String pageSizes)
pageSizes
- a comma-separated list of page sizes to display in the page size drop downCopyright © 2004–2021 XWiki. All rights reserved.