org.ametys.web.site

Class SiteParameter<T>

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

org.ametys.runtime.model.ElementDefinition<T>

org.ametys.runtime.model.CategorizedElementDefinitionProxy<T>

org.ametys.web.site.SiteParameter<T>

Type Parameters:

T - Type of the element value

All Implemented Interfaces:

Comparable<ModelItem>, ModelItem, Labelable, ModifiableLabelable

public class SiteParameter<T>
extends CategorizedElementDefinitionProxy<T>

Definition of a Site parameter.

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	_siteTypes The list of site types to which this parameter belongs, or null for no restriction.

Fields inherited from interface org.ametys.runtime.model.ModelItem

ITEM_PATH_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
SiteParameter()

Method Summary

Modifier and Type	Method and Description
Set<String>	getSiteTypes() Get the site type restriction, null for no restriction.
boolean	isInSiteType(String siteType) Test if the parameter is to appear in the specified site type.
void	setSiteTypes(Set<String> siteTypes) Set the site type restriction, null for no restriction.
String	toString()

Methods inherited from class org.ametys.runtime.model.CategorizedElementDefinitionProxy

addItemChecker, compareTo, equals, getDefaultValue, getDefinition, getDescription, getDisableConditions, getDisplayCategory, getDisplayGroup, getEnumerator, getItemCheckers, getLabel, getModel, getName, getParent, getPath, getPluginName, getPosition, getType, getValidator, getWidget, getWidgetParameters, hashCode, isGroupSwitch, isMultiple, setDefaultValue, setDescription, setDisableConditions, setDisplayCategory, setDisplayGroup, setEnumerator, setGroupSwitch, setLabel, setModel, setMultiple, setName, setParent, setPluginName, setPosition, setType, setValidator, setWidget, setWidgetParameters, toJSON

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

_siteTypes

protected Set<String> _siteTypes

The list of site types to which this parameter belongs, or null for no restriction.

Constructor Detail

SiteParameter

public SiteParameter()

Method Detail

getSiteTypes

public Set<String> getSiteTypes()

Get the site type restriction, null for no restriction.

Returns:

the site types or null for no restriction.

setSiteTypes

public void setSiteTypes(Set<String> siteTypes)

Set the site type restriction, null for no restriction.

Parameters:

siteTypes - the site types to set.

isInSiteType

public boolean isInSiteType(String siteType)

Test if the parameter is to appear in the specified site type.

Parameters:

siteType - the site type name (i.e. 'default', 'blog'...)

Returns:

true to appear, false otherwise.

toString

public String toString()

Overrides:

toString in class CategorizedElementDefinitionProxy<T>