PropertyDescriptor (XWiki Platform - Live Data

java.lang.Object
- org.xwiki.rest.model.jaxb.LinkCollection
- - org.xwiki.livedata.rest.model.jaxb.PropertyDescriptor

public class PropertyDescriptor
extends LinkCollection

Java class for PropertyDescriptor complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="PropertyDescriptor">
   <complexContent>
     <extension base="{http://www.xwiki.org}LinkCollection">
       <sequence>
         <element name="description" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="icon" type="{http://www.w3.org/2001/XMLSchema}anyType"/>
         <element name="displayer" type="{http://www.w3.org/2001/XMLSchema}anyType"/>
         <element name="filter" type="{http://www.w3.org/2001/XMLSchema}anyType"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="type" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="visible" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="sortable" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="filterable" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="styleName" type="{http://www.w3.org/2001/XMLSchema}string" />
     </extension>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`description`
`protected LiveDataPropertyDescriptor.DisplayerDescriptor`	`displayer`
`protected LiveDataPropertyDescriptor.FilterDescriptor`	`filter`
`protected Boolean`	`filterable`
`protected StringMap`	`icon`
`protected String`	`id`
`protected String`	`name`
`protected Boolean`	`sortable`
`protected String`	`styleName`
`protected String`	`type`
`protected Boolean`	`visible`

Fields inherited from class org.xwiki.rest.model.jaxb.LinkCollection
links

Constructor Summary

Constructors
Constructor and Description

PropertyDescriptor()

Constructors
Constructor and Description
`PropertyDescriptor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDescription()` Gets the value of the description property.
`LiveDataPropertyDescriptor.DisplayerDescriptor`	`getDisplayer()` Gets the value of the displayer property.
`LiveDataPropertyDescriptor.FilterDescriptor`	`getFilter()` Gets the value of the filter property.
`StringMap`	`getIcon()` Gets the value of the icon property.
`String`	`getId()` Gets the value of the id property.
`String`	`getName()` Gets the value of the name property.
`String`	`getStyleName()` Gets the value of the styleName property.
`String`	`getType()` Gets the value of the type property.
`boolean`	`isFilterable()` Gets the value of the filterable property.
`boolean`	`isSortable()` Gets the value of the sortable property.
`boolean`	`isVisible()` Gets the value of the visible property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setDisplayer(LiveDataPropertyDescriptor.DisplayerDescriptor value)` Sets the value of the displayer property.
`void`	`setFilter(LiveDataPropertyDescriptor.FilterDescriptor value)` Sets the value of the filter property.
`void`	`setFilterable(Boolean value)` Sets the value of the filterable property.
`void`	`setIcon(StringMap value)` Sets the value of the icon property.
`void`	`setId(String value)` Sets the value of the id property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setSortable(Boolean value)` Sets the value of the sortable property.
`void`	`setStyleName(String value)` Sets the value of the styleName property.
`void`	`setType(String value)` Sets the value of the type property.
`void`	`setVisible(Boolean value)` Sets the value of the visible property.
`PropertyDescriptor`	`withDescription(String value)`
`PropertyDescriptor`	`withDisplayer(LiveDataPropertyDescriptor.DisplayerDescriptor value)`
`PropertyDescriptor`	`withFilter(LiveDataPropertyDescriptor.FilterDescriptor value)`
`PropertyDescriptor`	`withFilterable(Boolean value)`
`PropertyDescriptor`	`withIcon(StringMap value)`
`PropertyDescriptor`	`withId(String value)`
`PropertyDescriptor`	`withName(String value)`
`PropertyDescriptor`	`withSortable(Boolean value)`
`PropertyDescriptor`	`withStyleName(String value)`
`PropertyDescriptor`	`withType(String value)`
`PropertyDescriptor`	`withVisible(Boolean value)`

Methods inherited from class org.xwiki.rest.model.jaxb.LinkCollection
getLinks, withLinks, withLinks

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

- Field Detail
  - description
```
protected String description
```
  - icon
```
protected StringMap icon
```
  - displayer
```
protected LiveDataPropertyDescriptor.DisplayerDescriptor displayer
```
  - filter
```
protected LiveDataPropertyDescriptor.FilterDescriptor filter
```
  - id
```
protected String id
```
  - name
```
protected String name
```
  - type
```
protected String type
```
  - visible
```
protected Boolean visible
```
  - sortable
```
protected Boolean sortable
```
  - filterable
```
protected Boolean filterable
```
  - styleName
```
protected String styleName
```
- Constructor Detail
  - PropertyDescriptor
```
public PropertyDescriptor()
```
- Method Detail
  - getDescription
```
public String getDescription()
```
    Gets the value of the description property.
    
    Returns:
    
    possible object is String
  - setDescription
```
public void setDescription(String value)
```
    Sets the value of the description property.
    
    Parameters:
    
    value - allowed object is String
  - getIcon
```
public StringMap getIcon()
```
    Gets the value of the icon property.
    
    Returns:
    
    possible object is StringMap
  - setIcon
```
public void setIcon(StringMap value)
```
    Sets the value of the icon property.
    
    Parameters:
    
    value - allowed object is StringMap
  - getDisplayer
```
public LiveDataPropertyDescriptor.DisplayerDescriptor getDisplayer()
```
    Gets the value of the displayer property.
    
    Returns:
    
    possible object is LiveDataPropertyDescriptor.DisplayerDescriptor
  - setDisplayer
```
public void setDisplayer(LiveDataPropertyDescriptor.DisplayerDescriptor value)
```
    Sets the value of the displayer property.
    
    Parameters:
    
    value - allowed object is LiveDataPropertyDescriptor.DisplayerDescriptor
  - getFilter
```
public LiveDataPropertyDescriptor.FilterDescriptor getFilter()
```
    Gets the value of the filter property.
    
    Returns:
    
    possible object is LiveDataPropertyDescriptor.FilterDescriptor
  - setFilter
```
public void setFilter(LiveDataPropertyDescriptor.FilterDescriptor value)
```
    Sets the value of the filter property.
    
    Parameters:
    
    value - allowed object is LiveDataPropertyDescriptor.FilterDescriptor
  - getId
```
public String getId()
```
    Gets the value of the id property.
    
    Returns:
    
    possible object is String
  - setId
```
public void setId(String value)
```
    Sets the value of the id property.
    
    Parameters:
    
    value - allowed object is String
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - getType
```
public String getType()
```
    Gets the value of the type property.
    
    Returns:
    
    possible object is String
  - setType
```
public void setType(String value)
```
    Sets the value of the type property.
    
    Parameters:
    
    value - allowed object is String
  - isVisible
```
public boolean isVisible()
```
    Gets the value of the visible property.
    
    Returns:
    
    possible object is Boolean
  - setVisible
```
public void setVisible(Boolean value)
```
    Sets the value of the visible property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isSortable
```
public boolean isSortable()
```
    Gets the value of the sortable property.
    
    Returns:
    
    possible object is Boolean
  - setSortable
```
public void setSortable(Boolean value)
```
    Sets the value of the sortable property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isFilterable
```
public boolean isFilterable()
```
    Gets the value of the filterable property.
    
    Returns:
    
    possible object is Boolean
  - setFilterable
```
public void setFilterable(Boolean value)
```
    Sets the value of the filterable property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getStyleName
```
public String getStyleName()
```
    Gets the value of the styleName property.
    
    Returns:
    
    possible object is String
  - setStyleName
```
public void setStyleName(String value)
```
    Sets the value of the styleName property.
    
    Parameters:
    
    value - allowed object is String
  - withDescription
```
public PropertyDescriptor withDescription(String value)
```
  - withIcon
```
public PropertyDescriptor withIcon(StringMap value)
```
  - withDisplayer
```
public PropertyDescriptor withDisplayer(LiveDataPropertyDescriptor.DisplayerDescriptor value)
```
  - withFilter
```
public PropertyDescriptor withFilter(LiveDataPropertyDescriptor.FilterDescriptor value)
```
  - withId
```
public PropertyDescriptor withId(String value)
```
  - withName
```
public PropertyDescriptor withName(String value)
```
  - withType
```
public PropertyDescriptor withType(String value)
```
  - withVisible
```
public PropertyDescriptor withVisible(Boolean value)
```
  - withSortable
```
public PropertyDescriptor withSortable(Boolean value)
```
  - withFilterable
```
public PropertyDescriptor withFilterable(Boolean value)
```
  - withStyleName
```
public PropertyDescriptor withStyleName(String value)
```

Class PropertyDescriptor

Field Summary

Fields inherited from class org.xwiki.rest.model.jaxb.LinkCollection

Constructor Summary

Method Summary

Methods inherited from class org.xwiki.rest.model.jaxb.LinkCollection

Methods inherited from class java.lang.Object

Field Detail

description

icon

displayer

filter

id

name

type

visible

sortable

filterable

styleName

Constructor Detail

PropertyDescriptor

Method Detail

getDescription

setDescription

getIcon

setIcon

getDisplayer

setDisplayer

getFilter

setFilter

getId

setId

getName

setName

getType

setType

isVisible

setVisible

isSortable

setSortable

isFilterable

setFilterable

getStyleName

setStyleName

withDescription

withIcon

withDisplayer

withFilter

withId

withName

withType

withVisible

withSortable

withFilterable

withStyleName