java.lang.Object
- org.opencms.ui.apps.lists.CmsListManager.ListConfigurationBean

Enclosing class:: CmsListManager

public static class CmsListManager.ListConfigurationBean
extends java.lang.Object

The list configuration data.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`CmsListManager.ListConfigurationBean.ListCategoryFolderRestrictionBean`	Wrapper for a combined category and folder restriction.
`static class`	`CmsListManager.ListConfigurationBean.ListGeoFilterBean`	Bean representing a Geo filter.

Constructor Summary

Constructors
Constructor Description

ListConfigurationBean()
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addCategoryFolderFilter(CmsListManager.ListConfigurationBean.ListCategoryFolderRestrictionBean listCategoryFolderRestrictionBean)`	Add a combined category-folder restriction.
`java.util.Map<java.lang.String,java.lang.String>`	`getAdditionalParameters()`	Returns the additional content parameters.
`java.util.List<CmsUUID>`	`getBlacklist()`	Returns the black list.
`java.util.List<java.lang.String>`	`getCategories()`	Returns the categories.
`java.util.List<CmsListManager.ListConfigurationBean.ListCategoryFolderRestrictionBean>`	`getCategoryFolderRestrictions()`	Returns the combined category-folder restrictions.
`CmsListManager.CategoryMode`	`getCategoryMode()`	Gets the category mode.
`I_CmsListDateRestriction`	`getDateRestriction()`	Gets the date restriction.
`java.util.List<java.lang.String>`	`getDisplayTypes()`	Returns the display types.
`java.lang.String`	`getFilterQuery()`	Gets the filter query.
`java.util.List<java.lang.String>`	`getFolders()`	Returns the folders.
`CmsListManager.ListConfigurationBean.ListGeoFilterBean`	`getGeoFilter()`	Returns the Geo filter.
`java.lang.Integer`	`getMaximallyReturnedResults()`	Returns the number of results to return maximally, or `null` if not explicitly specified.
`java.util.Map<java.lang.String,java.lang.String>`	`getParameters()`	Returns the parameter map.
`java.lang.String`	`getParameterValue(java.lang.String key)`	Returns the parameter by name.
`java.lang.String`	`getSortOrder()`	Gets the sort order.
`java.util.List<java.lang.String>`	`getTypes()`	Returns the search types.
`boolean`	`isShowExpired()`	Returns the 'show expired' setting.
`void`	`setAdditionalParameters(java.util.Map<java.lang.String,java.lang.String> additionalParameters)`	Sets the additional content parameters.
`void`	`setBlacklist(java.util.List<CmsUUID> blacklist)`	Sets the blacklist.
`void`	`setCategories(java.util.List<java.lang.String> categories)`	Sets the categories.
`void`	`setCategoryMode(CmsListManager.CategoryMode categoryMode)`	Sets the category mode.
`void`	`setDateRestriction(I_CmsListDateRestriction restriction)`	Sets the date restrictions.
`void`	`setDisplayTypes(java.util.List<java.lang.String> displayTypes)`	Sets the display types.
`void`	`setFolders(java.util.List<java.lang.String> folders)`	Sets the folders.
`void`	`setGeoFilter(CmsListManager.ListConfigurationBean.ListGeoFilterBean geoFilter)`	Sets the Geo filter.
`void`	`setParameterValue(java.lang.String name, java.lang.String value)`	Sets the parameter by name.

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

- Constructor Detail
  - ListConfigurationBean
```
public ListConfigurationBean()
```
    Constructor.
- Method Detail
  - addCategoryFolderFilter
```
public void addCategoryFolderFilter(CmsListManager.ListConfigurationBean.ListCategoryFolderRestrictionBean listCategoryFolderRestrictionBean)
```
    Add a combined category-folder restriction.
    
    Parameters:
    
    listCategoryFolderRestrictionBean - the category-folder restriction to add.
  - getAdditionalParameters
```
public java.util.Map<java.lang.String,java.lang.String> getAdditionalParameters()
```
    Returns the additional content parameters.
    
    Returns:
    
    the additional content parameters
  - getBlacklist
```
public java.util.List<CmsUUID> getBlacklist()
```
    Returns the black list.
    
    Returns:
    
    the black list
  - getCategories
```
public java.util.List<java.lang.String> getCategories()
```
    Returns the categories.
    
    Returns:
    
    the categories
  - getCategoryFolderRestrictions
```
public java.util.List<CmsListManager.ListConfigurationBean.ListCategoryFolderRestrictionBean> getCategoryFolderRestrictions()
```
    Returns the combined category-folder restrictions.
    
    Returns:
    
    the combined category-folder restrictions
  - getCategoryMode
```
public CmsListManager.CategoryMode getCategoryMode()
```
    Gets the category mode.
    
    Returns:
    
    the category mode
  - getDateRestriction
```
public I_CmsListDateRestriction getDateRestriction()
```
    Gets the date restriction.
    
    Returns:
    
    the date restriction
  - getDisplayTypes
```
public java.util.List<java.lang.String> getDisplayTypes()
```
    Returns the display types.
    
    Returns:
    
    the display types
  - getFilterQuery
```
public java.lang.String getFilterQuery()
```
    Gets the filter query.
    
    Returns:
    
    the filter query
  - getFolders
```
public java.util.List<java.lang.String> getFolders()
```
    Returns the folders.
    
    Returns:
    
    the folders
  - getGeoFilter
```
public CmsListManager.ListConfigurationBean.ListGeoFilterBean getGeoFilter()
```
    Returns the Geo filter.
    
    Returns:
    
    the Geo filter
  - getMaximallyReturnedResults
```
public java.lang.Integer getMaximallyReturnedResults()
```
    Returns the number of results to return maximally, or null if not explicitly specified.
    
    Returns:
    
    the number of results to return maximally, or null if not explicitly specified.
  - getParameters
```
public java.util.Map<java.lang.String,java.lang.String> getParameters()
```
    Returns the parameter map.
    
    Returns:
    
    the parameters
  - getParameterValue
```
public java.lang.String getParameterValue(java.lang.String key)
```
    Returns the parameter by name.
    
    Parameters:
    
    key - the parameter name
    
    Returns:
    
    the parameter value
  - getSortOrder
```
public java.lang.String getSortOrder()
```
    Gets the sort order.
    
    Returns:
    
    the sort order
  - getTypes
```
public java.util.List<java.lang.String> getTypes()
```
    Returns the search types.
    
    Returns:
    
    the search types
  - isShowExpired
```
public boolean isShowExpired()
```
    Returns the 'show expired' setting.
    
    Returns:
    
    the 'show expired' setting
  - setAdditionalParameters
```
public void setAdditionalParameters(java.util.Map<java.lang.String,java.lang.String> additionalParameters)
```
    Sets the additional content parameters.
    
    Parameters:
    
    additionalParameters - the additional content parameters to set
  - setBlacklist
```
public void setBlacklist(java.util.List<CmsUUID> blacklist)
```
    Sets the blacklist.
    
    Parameters:
    
    blacklist - the blacklist
  - setCategories
```
public void setCategories(java.util.List<java.lang.String> categories)
```
    Sets the categories.
    
    Parameters:
    
    categories - the categories
  - setCategoryMode
```
public void setCategoryMode(CmsListManager.CategoryMode categoryMode)
```
    Sets the category mode.
    
    Parameters:
    
    categoryMode - the category mode to set
  - setDateRestriction
```
public void setDateRestriction(I_CmsListDateRestriction restriction)
```
    Sets the date restrictions.
    
    Parameters:
    
    restriction - the date restrictions
  - setDisplayTypes
```
public void setDisplayTypes(java.util.List<java.lang.String> displayTypes)
```
    Sets the display types.
    
    Parameters:
    
    displayTypes - the display types
  - setFolders
```
public void setFolders(java.util.List<java.lang.String> folders)
```
    Sets the folders.
    
    Parameters:
    
    folders - the folders
  - setGeoFilter
```
public void setGeoFilter(CmsListManager.ListConfigurationBean.ListGeoFilterBean geoFilter)
```
    Sets the Geo filter.
    
    Parameters:
    
    geoFilter - the Geo filter
  - setParameterValue
```
public void setParameterValue(java.lang.String name,
                              java.lang.String value)
```
    Sets the parameter by name.
    
    Parameters:
    
    name - the parameter name
    
    value - the parameter value

Class CmsListManager.ListConfigurationBean

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ListConfigurationBean

Method Detail

addCategoryFolderFilter

getAdditionalParameters

getBlacklist

getCategories

getCategoryFolderRestrictions

getCategoryMode

getDateRestriction

getDisplayTypes

getFilterQuery

getFolders

getGeoFilter

getMaximallyReturnedResults

getParameters

getParameterValue

getSortOrder

getTypes

isShowExpired

setAdditionalParameters

setBlacklist

setCategories

setCategoryMode

setDateRestriction

setDisplayTypes

setFolders

setGeoFilter

setParameterValue