LiveDataMeta (XWiki Platform - Live Data

java.lang.Object
- org.xwiki.livedata.LiveDataMeta

```
@Unstable
public class LiveDataMeta
extends Object
```
Describes the configuration used to display the live data.

Since:

12.10

Version:

$Id: b213d468d0256088816be7ab21714fd92c66bce4 $

Constructor Summary

Constructors
Constructor and Description

LiveDataMeta()

Constructors
Constructor and Description
`LiveDataMeta()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Collection<LiveDataActionDescriptor>`	`getActions()`
`String`	`getDefaultDisplayer()`
`String`	`getDefaultFilter()`
`String`	`getDefaultLayout()`
`Collection<LiveDataPropertyDescriptor.DisplayerDescriptor>`	`getDisplayers()`
`LiveDataEntryDescriptor`	`getEntryDescriptor()`
`Collection<LiveDataPropertyDescriptor.FilterDescriptor>`	`getFilters()`
`Collection<LiveDataLayoutDescriptor>`	`getLayouts()`
`LiveDataPaginationConfiguration`	`getPagination()`
`Collection<LiveDataPropertyDescriptor>`	`getPropertyDescriptors()`
`Collection<LiveDataPropertyDescriptor>`	`getPropertyTypes()`
`LiveDataSelectionConfiguration`	`getSelection()`
`void`	`initialize()` Prevent `null` values where it's possible.
`void`	`setActions(Collection<LiveDataActionDescriptor> actions)` Sets the supported actions.
`void`	`setDefaultDisplayer(String defaultDisplayer)` Set the default displayer used to display live data properties.
`void`	`setDefaultFilter(String defaultFilter)` Set the default filter widget to use when filtering live data properties.
`void`	`setDefaultLayout(String defaultLayout)` Set the default layout used to display the live data.
`void`	`setDisplayers(Collection<LiveDataPropertyDescriptor.DisplayerDescriptor> displayers)` Sets the list of known property displayers.
`void`	`setEntryDescriptor(LiveDataEntryDescriptor entryDescriptor)` Sets the descriptor of the live data entries.
`void`	`setFilters(Collection<LiveDataPropertyDescriptor.FilterDescriptor> filters)` Sets the list of known filter widgets.
`void`	`setLayouts(Collection<LiveDataLayoutDescriptor> layouts)` Sets the list of supported layouts.
`void`	`setPagination(LiveDataPaginationConfiguration pagination)` Sets the pagination configuration.
`void`	`setPropertyDescriptors(Collection<LiveDataPropertyDescriptor> propertyDescriptors)` Sets the list of known properties.
`void`	`setPropertyTypes(Collection<LiveDataPropertyDescriptor> propertyTypes)` Sets the list of known property types.
`void`	`setSelection(LiveDataSelectionConfiguration selection)` Sets the live data entry selection.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LiveDataMeta
```
public LiveDataMeta()
```
- Method Detail
  - getDefaultLayout
```
public String getDefaultLayout()
```
    Returns:
    
    the default layout used to display the live data
  - setDefaultLayout
```
public void setDefaultLayout(String defaultLayout)
```
    Set the default layout used to display the live data.
    
    Parameters:
    
    defaultLayout - the new default layout
  - getDefaultFilter
```
public String getDefaultFilter()
```
    Returns:
    
    the default filter widget used to filter the live data properties
  - setDefaultFilter
```
public void setDefaultFilter(String defaultFilter)
```
    Set the default filter widget to use when filtering live data properties.
    
    Parameters:
    
    defaultFilter - the identifier of the new default filter
  - getDefaultDisplayer
```
public String getDefaultDisplayer()
```
    Returns:
    
    the default displayer used to display live data properties
  - setDefaultDisplayer
```
public void setDefaultDisplayer(String defaultDisplayer)
```
    Set the default displayer used to display live data properties.
    
    Parameters:
    
    defaultDisplayer - the identifier of the new default displayer
  - getLayouts
```
public Collection<LiveDataLayoutDescriptor> getLayouts()
```
    Returns:
    
    the list of supported layouts
  - setLayouts
```
public void setLayouts(Collection<LiveDataLayoutDescriptor> layouts)
```
    Sets the list of supported layouts.
    
    Parameters:
    
    layouts - the new list of supported layouts
  - getPropertyDescriptors
```
public Collection<LiveDataPropertyDescriptor> getPropertyDescriptors()
```
    Returns:
    
    the list of known properties
  - setPropertyDescriptors
```
public void setPropertyDescriptors(Collection<LiveDataPropertyDescriptor> propertyDescriptors)
```
    Sets the list of known properties.
    
    Parameters:
    
    propertyDescriptors - the new list of known properties
  - getPropertyTypes
```
public Collection<LiveDataPropertyDescriptor> getPropertyTypes()
```
    Returns:
    
    the list of known property types
  - setPropertyTypes
```
public void setPropertyTypes(Collection<LiveDataPropertyDescriptor> propertyTypes)
```
    Sets the list of known property types.
    
    Parameters:
    
    propertyTypes - the new list of known property types
  - getFilters
```
public Collection<LiveDataPropertyDescriptor.FilterDescriptor> getFilters()
```
    Returns:
    
    the list of known filter widgets
  - setFilters
```
public void setFilters(Collection<LiveDataPropertyDescriptor.FilterDescriptor> filters)
```
    Sets the list of known filter widgets.
    
    Parameters:
    
    filters - the new list of known filter widgets
  - getDisplayers
```
public Collection<LiveDataPropertyDescriptor.DisplayerDescriptor> getDisplayers()
```
    Returns:
    
    the list of known property displayers
  - setDisplayers
```
public void setDisplayers(Collection<LiveDataPropertyDescriptor.DisplayerDescriptor> displayers)
```
    Sets the list of known property displayers.
    
    Parameters:
    
    displayers - the new list of known property displayers
  - getPagination
```
public LiveDataPaginationConfiguration getPagination()
```
    Returns:
    
    the pagination configuration
  - setPagination
```
public void setPagination(LiveDataPaginationConfiguration pagination)
```
    Sets the pagination configuration.
    
    Parameters:
    
    pagination - the new pagination configuration
  - getEntryDescriptor
```
public LiveDataEntryDescriptor getEntryDescriptor()
```
    Returns:
    
    the descriptor of the live data entries
  - setEntryDescriptor
```
public void setEntryDescriptor(LiveDataEntryDescriptor entryDescriptor)
```
    Sets the descriptor of the live data entries.
    
    Parameters:
    
    entryDescriptor - the new entry descriptor
  - getActions
```
public Collection<LiveDataActionDescriptor> getActions()
```
    Returns:
    
    the descriptors of supported live data actions
    
    Since:
    
    12.10.1, 13.0
  - setActions
```
public void setActions(Collection<LiveDataActionDescriptor> actions)
```
    Sets the supported actions.
    
    Parameters:
    
    actions - the descriptors for the supported actions
    
    Since:
    
    12.10.1, 13.0
  - getSelection
```
public LiveDataSelectionConfiguration getSelection()
```
    Returns:
    
    the live data entry selection
    
    Since:
    
    12.10.1, 13.0
  - setSelection
```
public void setSelection(LiveDataSelectionConfiguration selection)
```
    Sets the live data entry selection.
    
    Parameters:
    
    selection - the new live data entry selection
    
    Since:
    
    12.10.1, 13.0
  - initialize
```
public void initialize()
```
    Prevent null values where it's possible.

Class LiveDataMeta

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LiveDataMeta

Method Detail

getDefaultLayout

setDefaultLayout

getDefaultFilter

setDefaultFilter

getDefaultDisplayer

setDefaultDisplayer

getLayouts

setLayouts

getPropertyDescriptors

setPropertyDescriptors

getPropertyTypes

setPropertyTypes

getFilters

setFilters

getDisplayers

setDisplayers

getPagination

setPagination

getEntryDescriptor

setEntryDescriptor

getActions

setActions

getSelection

setSelection

initialize