Package org.opencms.jsp.search.config.parser.simplesearch

Class CmsConfigurationBean

java.lang.Object

org.opencms.jsp.search.config.parser.simplesearch.CmsConfigurationBean

public class CmsConfigurationBean
extends Object

The list configuration data.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CmsConfigurationBean.CombinationMode	Enum representing how filter queries should be combined in a search.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	N_TITLE	Parameter field key.
static final String	PARAM_FILTER_MULTI_DAY	Parameter field key.
static final String	PARAM_FILTER_QUERY	Parameter field key.
static final String	PARAM_MAX_RESULTS	Parameter field key.
static final String	PARAM_SHOW_EXPIRED	Parameter field key.
static final String	PARAM_SORT_ORDER	Parameter field key.
static final String	PARAM_TITLE	Parameter field key.

Constructor Summary

Constructors

Constructor	Description
CmsConfigurationBean()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addCategoryFolderFilter(CmsCategoryFolderRestrictionBean listCategoryFolderRestrictionBean)	Add a combined category-folder restriction.
Map<String,String>	getAdditionalParameters()	Returns the additional content parameters.
List<CmsUUID>	getBlacklist()	Returns the black list.
List<String>	getCategories()	Returns the categories.
List<CmsCategoryFolderRestrictionBean>	getCategoryFolderRestrictions()	Returns the combined category-folder restrictions.
CmsConfigurationBean.CombinationMode	getCategoryMode()	Gets the category mode.
I_CmsDateRestriction	getDateRestriction()	Gets the date restriction.
List<String>	getDisplayTypes()	Returns the display types.
String	getFilterQuery()	Gets the filter query.
List<String>	getFolders()	Returns the folders.
CmsGeoFilterBean	getGeoFilter()	Returns the Geo filter.
Integer	getMaximallyReturnedResults()	Returns the number of results to return maximally, or null if not explicitly specified.
Map<String,String>	getParameters()	Returns the parameter map.
String	getParameterValue(String key)	Returns the parameter by name.
CmsRestrictionsBean	getPreconfiguredRestrictions()	Returns the preconfigured restrictions.
static String	getResourceTypeForDisplayType(String displayType)	Extracts the resource type name from a display type string.
String	getSortOrder()	Gets the sort order.
List<String>	getTypes()	Returns the search types.
boolean	hasPreconfiguredRestrictions()	Returns a flag, indicating if there are preconfigured restrictions.
boolean	hasTypeSpecificRestriction(String type)	Returns a flag, indicating if there are preconfigured restrictions for the provided type.
boolean	isShowExpired()	Returns the 'show expired' setting.
void	setAdditionalParameters(Map<String,String> additionalParameters)	Sets the additional content parameters.
void	setBlacklist(List<CmsUUID> blacklist)	Sets the blacklist.
void	setCategories(List<String> categories)	Sets the categories.
void	setCategoryMode(CmsConfigurationBean.CombinationMode categoryMode)	Sets the category mode.
void	setDateRestriction(I_CmsDateRestriction restriction)	Sets the date restrictions.
void	setDisplayTypes(List<String> displayTypes)	Sets the display types.
void	setFolders(List<String> folders)	Sets the folders.
void	setGeoFilter(CmsGeoFilterBean geoFilter)	Sets the Geo filter.
void	setParameterValue(String name, String value)	Sets the parameter by name.
void	setPreconfiguredRestrictions(CmsRestrictionsBean restrictionBean)	Set the preconfigured restrictions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

N_TITLE

public static final String N_TITLE

Parameter field key.

See Also:

• Constant Field Values

PARAM_TITLE

public static final String PARAM_TITLE

Parameter field key.

See Also:

• Constant Field Values

PARAM_FILTER_MULTI_DAY

public static final String PARAM_FILTER_MULTI_DAY

Parameter field key.

See Also:

• Constant Field Values

PARAM_FILTER_QUERY

public static final String PARAM_FILTER_QUERY

Parameter field key.

See Also:

• Constant Field Values

PARAM_SORT_ORDER

public static final String PARAM_SORT_ORDER

Parameter field key.

See Also:

• Constant Field Values

PARAM_SHOW_EXPIRED

public static final String PARAM_SHOW_EXPIRED

Parameter field key.

See Also:

• Constant Field Values

PARAM_MAX_RESULTS

public static final String PARAM_MAX_RESULTS

Parameter field key.

See Also:

• Constant Field Values

Constructor Details

CmsConfigurationBean

public CmsConfigurationBean()

Constructor.

Method Details

getResourceTypeForDisplayType

public static String getResourceTypeForDisplayType(String displayType)

Extracts the resource type name from a display type string.

Parameters:

displayType - the display type

Returns:

the resource type name

addCategoryFolderFilter

public void addCategoryFolderFilter(CmsCategoryFolderRestrictionBean listCategoryFolderRestrictionBean)

Add a combined category-folder restriction.

Parameters:

listCategoryFolderRestrictionBean - the category-folder restriction to add.

getAdditionalParameters

public Map<String,String> getAdditionalParameters()

Returns the additional content parameters.

Returns:

the additional content parameters

getBlacklist

public List<CmsUUID> getBlacklist()

Returns the black list.

Returns:

the black list

getCategories

public List<String> getCategories()

Returns the categories.

Returns:

the categories

getCategoryFolderRestrictions

public List<CmsCategoryFolderRestrictionBean> getCategoryFolderRestrictions()

Returns the combined category-folder restrictions.

Returns:

the combined category-folder restrictions

getCategoryMode

public CmsConfigurationBean.CombinationMode getCategoryMode()

Gets the category mode.

Returns:

the category mode

getDateRestriction

public I_CmsDateRestriction getDateRestriction()

Gets the date restriction.

Returns:

the date restriction

getDisplayTypes

public List<String> getDisplayTypes()

Returns the display types.

Returns:

the display types

getFilterQuery

public String getFilterQuery()

Gets the filter query.

Returns:

the filter query

getFolders

public List<String> getFolders()

Returns the folders.

Returns:

the folders

getGeoFilter

public CmsGeoFilterBean getGeoFilter()

Returns the Geo filter.

Returns:

the Geo filter

getMaximallyReturnedResults

public 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 Map<String,String> getParameters()

Returns the parameter map.

Returns:

the parameters

getParameterValue

public String getParameterValue(String key)

Returns the parameter by name.

Parameters:

key - the parameter name

Returns:

the parameter value

getPreconfiguredRestrictions

public CmsRestrictionsBean getPreconfiguredRestrictions()

Returns the preconfigured restrictions.

Returns:

the preconfigured restrictions.

getSortOrder

public String getSortOrder()

Gets the sort order.

Returns:

the sort order

getTypes

public List<String> getTypes()

Returns the search types.

Returns:

the search types

hasPreconfiguredRestrictions

public boolean hasPreconfiguredRestrictions()

Returns a flag, indicating if there are preconfigured restrictions.

Returns:

true iff there are preconfiugred restrictions, false otherwise.

hasTypeSpecificRestriction

public boolean hasTypeSpecificRestriction(String type)

Returns a flag, indicating if there are preconfigured restrictions for the provided type.

Parameters:

type - the type to check the existence of preconfigured restrictions for.

Returns:

true iff there are preconfigured restrictions for the provided type, false otherwise.

isShowExpired

public boolean isShowExpired()

Returns the 'show expired' setting.

Returns:

the 'show expired' setting

setAdditionalParameters

public void setAdditionalParameters(Map<String,String> additionalParameters)

Sets the additional content parameters.

Parameters:

additionalParameters - the additional content parameters to set

setBlacklist

public void setBlacklist(List<CmsUUID> blacklist)

Sets the blacklist.

Parameters:

blacklist - the blacklist

setCategories

public void setCategories(List<String> categories)

Sets the categories.

Parameters:

categories - the categories

setCategoryMode

public void setCategoryMode(CmsConfigurationBean.CombinationMode categoryMode)

Sets the category mode.

Parameters:

categoryMode - the category mode to set

setDateRestriction

public void setDateRestriction(I_CmsDateRestriction restriction)

Sets the date restrictions.

Parameters:

restriction - the date restrictions

setDisplayTypes

public void setDisplayTypes(List<String> displayTypes)

Sets the display types.

Parameters:

displayTypes - the display types

setFolders

public void setFolders(List<String> folders)

Sets the folders.

Parameters:

folders - the folders

setGeoFilter

public void setGeoFilter(CmsGeoFilterBean geoFilter)

Sets the Geo filter.

Parameters:

geoFilter - the Geo filter

setParameterValue

public void setParameterValue(String name,
 String value)

Sets the parameter by name.

Parameters:

name - the parameter name

value - the parameter value

setPreconfiguredRestrictions

public void setPreconfiguredRestrictions(CmsRestrictionsBean restrictionBean)

Set the preconfigured restrictions.

Parameters:

restrictionBean - the restrictions to set.