java.lang.Object
- org.opencms.file.CmsPropertyDefinition

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<CmsPropertyDefinition>
```
public class CmsPropertyDefinition
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Comparable<CmsPropertyDefinition>
```
Defines a property name, so that CmsProperty instances can be created with that name.

Since:

6.0.0

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class CmsPropertyDefinition.CmsPropertyType
Enumeration class for property types.

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`NAME_CONSTRAINTS`	The name constraints when generating new properties.
`static java.lang.String`	`PROPERTY_ACTIV`	Property for the active method in the administration view.
`static java.lang.String`	`PROPERTY_AVAILABLE_LOCALES`	Property for the allowed set of locales.
`static java.lang.String`	`PROPERTY_BODY_CLASS`	Property to control the Java class for body.
`static java.lang.String`	`PROPERTY_CACHE`	The name of the VFS property that controls the caching.
`static java.lang.String`	`PROPERTY_CATEGORY_REPOSITORY`	The property to read an additional category folder from.
`static java.lang.String`	`PROPERTY_CONTAINER_INFO`	Property to define the function detail container for a template.
`static java.lang.String`	`PROPERTY_CONTENT_CONVERSION`	Property for the content conversion.
`static java.lang.String`	`PROPERTY_CONTENT_ENCODING`	Property for the content encoding.
`static java.lang.String`	`PROPERTY_COPYRIGHT`	Property for the content encoding.
`static java.lang.String`	`PROPERTY_DEFAULT_FILE`	Property for the default file in folders.
`static java.lang.String`	`PROPERTY_DELETE_EXPIRED`	Property for the days a resource has to be expired to be deleted by the `CmsDeleteExpiredResourcesJob`.
`static java.lang.String`	`PROPERTY_DESCRIPTION`	Property for the description.
`static java.lang.String`	`PROPERTY_DESCRIPTION_HTML`	Property for the description in HTML format.
`static java.lang.String`	`PROPERTY_DISPLAY_ORDER`	Property to set the display order of a content in lists.
`static java.lang.String`	`PROPERTY_ELEMENT_MODEL`	The name of the property which controls whether an element will be used as a copy model by the container page editor.
`static java.lang.String`	`PROPERTY_ELEMENT_REPLACEMENTS`	May contain a path to an element replacement configuration, for use in the 'copy page' dialog.
`static java.lang.String`	`PROPERTY_ENABLE_NOTIFICATION`	Property for the resource title.
`static java.lang.String`	`PROPERTY_EXPORT`	Property for the static export.
`static java.lang.String`	`PROPERTY_EXPORT_TYPE`	Property used to record the resource type for resources whose type is unknown at import time, so they can be exported with that type later.
`static java.lang.String`	`PROPERTY_EXPORTNAME`	Property for the resource export name, during export this name is used instead of the resource name.
`static java.lang.String`	`PROPERTY_EXPORTSUFFIX`	Property for JSP additional suffix during static export, default is "html".
`static java.lang.String`	`PROPERTY_FOLDERS_AVAILABLE`	Property to control the folders where template or default bodies should be available.
`static java.lang.String`	`PROPERTY_GALLERIES_FOLDER`	Property stating where to create new gallery folders.
`static java.lang.String`	`PROPERTY_GOOGLE_API_KEY`	Property containing the maps API key.
`static java.lang.String`	`PROPERTY_GOOGLE_API_KEY_WORKPLACE`	Property containing the maps API key.
`static java.lang.String`	`PROPERTY_HISTORY_REMOVE_DELETED`	Property to control whether historic versions should be removed when deleted resources are published.
`static java.lang.String`	`PROPERTY_IMAGE_FOCAL_POINT`	Name of the property in which the focal point is stored.
`static java.lang.String`	`PROPERTY_IMAGE_SIZE`	Property constant for `"image.size"`.
`static java.lang.String`	`PROPERTY_INSTANCEDATE_COPYFIELD`	The property for defining the date (as Solr field) that should be used for sorting in lists.
`static java.lang.String`	`PROPERTY_KEYWORDS`	Property for the keywords.
`static java.lang.String`	`PROPERTY_LINKS_FORCEABSOLUTE_ENABLED`	Property to enable __forceAbsoluteLinks request parameter for a resource.
`static java.lang.String`	`PROPERTY_LOCALE`	Property for the current locale.
`static java.lang.String`	`PROPERTY_LOCALE_INDEPENDENT_DETAILS`	Property to mark detail pages to have locale independent detail only containers.
`static java.lang.String`	`PROPERTY_LOCALE_NOTRANSLATION`	Property for the 'do not translate' marking in the sitemap editor.
`static java.lang.String`	`PROPERTY_LOGIN_FORM`	Property for the login form.
`static java.lang.String`	`PROPERTY_NAVIMAGE`	Property constant for `"NavImage"`.
`static java.lang.String`	`PROPERTY_NAVINFO`	Property constant for `"NavInfo"`.
`static java.lang.String`	`PROPERTY_NAVPOS`	Property for the navigation position.
`static java.lang.String`	`PROPERTY_NAVTEXT`	Property for the navigation text.
`static java.lang.String`	`PROPERTY_NOTIFICATION_INTERVAL`	Property for the resource title.
`static java.lang.String`	`PROPERTY_RELATIVEROOT`	Property for the relative root link substitution.
`static java.lang.String`	`PROPERTY_RESTYPES_AVAILABLE`	Property name that defines the available resource types for the "new" dialog.
`static java.lang.String`	`PROPERTY_SEARCH_CATEGORY`	Property to sort search results in categories.
`static java.lang.String`	`PROPERTY_SEARCH_EXCLUDE`	Property to exclude individual resources from search index generation.
`static java.lang.String`	`PROPERTY_SEARCH_EXCLUDE_ONLINE`	Property to exclude individual resources from search results online (Solr only).
`static java.lang.String`	`PROPERTY_SEARCH_PRIORITY`	Property to boost certain search results.
`static java.lang.String`	`PROPERTY_SECONDARY_LOCALES`	Property for secondary locales for use in the locale compare view in the sitemap editor.
`static java.lang.String`	`PROPERTY_SECURE`	Property for the secure transmission of resources.
`static java.lang.String`	`PROPERTY_STYLESHEET`	Property for the stylesheet of files.
`static java.lang.String`	`PROPERTY_TEMPLATE`	Property to control the template.
`static java.lang.String`	`PROPERTY_TEMPLATE_COMPATILIBITY`	Property to customize for which templates elements should be displayed in the gallery when using the CmsTransformerTemplateProvider.
`static java.lang.String`	`PROPERTY_TEMPLATE_DISPLAY_TYPES`	Property for specifying a list of container types used to match formatters in the display formatter selection widget.
`static java.lang.String`	`PROPERTY_TEMPLATE_ELEMENTS`	Property to control the template elements.
`static java.lang.String`	`PROPERTY_TEMPLATE_IMAGE`	Property for the template image.
`static java.lang.String`	`PROPERTY_TEMPLATE_PROVIDER`	Property to configure the value which should be used instead of the template path when selecting the template in the GUI.
`static java.lang.String`	`PROPERTY_TITLE`	Property for the resource title.
`static java.lang.String`	`PROPERTY_UDR_CONFIG`	Property for user data request configuration.
`static java.lang.String`	`PROPERTY_UDR_DEFAULTOU`	Property used to configure default organizational unit.
`static java.lang.String`	`PROPERTY_URLNAME_REPLACE`	Name of the property used to control whether mapped URL names should replace previous URL names.
`static java.lang.String`	`PROPERTY_VISIBLE`	Property for the visible method in the administration view.
`static java.lang.String`	`PROPERTY_XMLSITEMAP_CHANGEFREQ`	Property for the XML sitemap change frequency.
`static java.lang.String`	`PROPERTY_XMLSITEMAP_PRIORITY`	Property for the XML sitemap priority.
`static int`	`PROPERYDEFINITION_RESOURCE`	The property definition type for resources.
`static CmsPropertyDefinition.CmsPropertyType`	`TYPE_LINK`	Property value is treated as a link or list of links.
`static CmsPropertyDefinition.CmsPropertyType`	`TYPE_NORMAL`	Property value is not a link.

Constructor Summary

Constructors
Constructor	Description
`CmsPropertyDefinition(CmsUUID id, java.lang.String name)`	Creates a new property definition object with the type `TYPE_NORMAL`.
`CmsPropertyDefinition(CmsUUID id, java.lang.String name, CmsPropertyDefinition.CmsPropertyType propertyType)`	Creates a new property definition object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static void`	`checkPropertyName(java.lang.String name)`	Checks if the provided property name is a valid property name, that is contains only valid characters.
`java.lang.Object`	`clone()`	Returns a clone of this Objects instance.
`int`	`compareTo(CmsPropertyDefinition obj)`
`boolean`	`equals(java.lang.Object obj)`
`CmsUUID`	`getId()`	Returns the id of this property definition.
`java.lang.String`	`getName()`	Returns the name of this property definition.
`static CmsPropertyDefinition`	`getNullPropertyDefinition()`	Returns the null property definition.
`CmsPropertyDefinition.CmsPropertyType`	`getType()`	Returns the the type of this property definition.
`int`	`hashCode()`
`void`	`setType(CmsPropertyDefinition.CmsPropertyType type)`	Sets the type for this property definition.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NAME_CONSTRAINTS
```
public static final java.lang.String NAME_CONSTRAINTS
```
    The name constraints when generating new properties.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ACTIV
```
public static final java.lang.String PROPERTY_ACTIV
```
    Property for the active method in the administration view.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_AVAILABLE_LOCALES
```
public static final java.lang.String PROPERTY_AVAILABLE_LOCALES
```
    Property for the allowed set of locales.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_BODY_CLASS
```
public static final java.lang.String PROPERTY_BODY_CLASS
```
    Property to control the Java class for body.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_CACHE
```
public static final java.lang.String PROPERTY_CACHE
```
    The name of the VFS property that controls the caching.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_CATEGORY_REPOSITORY
```
public static final java.lang.String PROPERTY_CATEGORY_REPOSITORY
```
    The property to read an additional category folder from.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_CONTAINER_INFO
```
public static final java.lang.String PROPERTY_CONTAINER_INFO
```
    Property to define the function detail container for a template.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_CONTENT_CONVERSION
```
public static final java.lang.String PROPERTY_CONTENT_CONVERSION
```
    Property for the content conversion.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_CONTENT_ENCODING
```
public static final java.lang.String PROPERTY_CONTENT_ENCODING
```
    Property for the content encoding.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_COPYRIGHT
```
public static final java.lang.String PROPERTY_COPYRIGHT
```
    Property for the content encoding.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_DEFAULT_FILE
```
public static final java.lang.String PROPERTY_DEFAULT_FILE
```
    Property for the default file in folders.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_DELETE_EXPIRED
```
public static final java.lang.String PROPERTY_DELETE_EXPIRED
```
    Property for the days a resource has to be expired to be deleted by the CmsDeleteExpiredResourcesJob.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_DESCRIPTION
```
public static final java.lang.String PROPERTY_DESCRIPTION
```
    Property for the description.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_DESCRIPTION_HTML
```
public static final java.lang.String PROPERTY_DESCRIPTION_HTML
```
    Property for the description in HTML format.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_DISPLAY_ORDER
```
public static final java.lang.String PROPERTY_DISPLAY_ORDER
```
    Property to set the display order of a content in lists.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ELEMENT_MODEL
```
public static final java.lang.String PROPERTY_ELEMENT_MODEL
```
    The name of the property which controls whether an element will be used as a copy model by the container page editor.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ELEMENT_REPLACEMENTS
```
public static final java.lang.String PROPERTY_ELEMENT_REPLACEMENTS
```
    May contain a path to an element replacement configuration, for use in the 'copy page' dialog.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ENABLE_NOTIFICATION
```
public static final java.lang.String PROPERTY_ENABLE_NOTIFICATION
```
    Property for the resource title.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_EXPORT
```
public static final java.lang.String PROPERTY_EXPORT
```
    Property for the static export.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_EXPORT_TYPE
```
public static final java.lang.String PROPERTY_EXPORT_TYPE
```
    Property used to record the resource type for resources whose type is unknown at import time, so they can be exported with that type later.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_EXPORTNAME
```
public static final java.lang.String PROPERTY_EXPORTNAME
```
    Property for the resource export name, during export this name is used instead of the resource name.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_EXPORTSUFFIX
```
public static final java.lang.String PROPERTY_EXPORTSUFFIX
```
    Property for JSP additional suffix during static export, default is "html".
    
    See Also:
    
    Constant Field Values
  - PROPERTY_FOLDERS_AVAILABLE
```
public static final java.lang.String PROPERTY_FOLDERS_AVAILABLE
```
    Property to control the folders where template or default bodies should be available.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_GALLERIES_FOLDER
```
public static final java.lang.String PROPERTY_GALLERIES_FOLDER
```
    Property stating where to create new gallery folders.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_GOOGLE_API_KEY
```
public static final java.lang.String PROPERTY_GOOGLE_API_KEY
```
    Property containing the maps API key.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_GOOGLE_API_KEY_WORKPLACE
```
public static final java.lang.String PROPERTY_GOOGLE_API_KEY_WORKPLACE
```
    Property containing the maps API key.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_HISTORY_REMOVE_DELETED
```
public static final java.lang.String PROPERTY_HISTORY_REMOVE_DELETED
```
    Property to control whether historic versions should be removed when deleted resources are published.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_IMAGE_FOCAL_POINT
```
public static final java.lang.String PROPERTY_IMAGE_FOCAL_POINT
```
    Name of the property in which the focal point is stored.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_IMAGE_SIZE
```
public static final java.lang.String PROPERTY_IMAGE_SIZE
```
    Property constant for "image.size".
    
    See Also:
    
    Constant Field Values
  - PROPERTY_INSTANCEDATE_COPYFIELD
```
public static final java.lang.String PROPERTY_INSTANCEDATE_COPYFIELD
```
    The property for defining the date (as Solr field) that should be used for sorting in lists.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_KEYWORDS
```
public static final java.lang.String PROPERTY_KEYWORDS
```
    Property for the keywords.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_LINKS_FORCEABSOLUTE_ENABLED
```
public static final java.lang.String PROPERTY_LINKS_FORCEABSOLUTE_ENABLED
```
    Property to enable __forceAbsoluteLinks request parameter for a resource.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_LOCALE
```
public static final java.lang.String PROPERTY_LOCALE
```
    Property for the current locale.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_LOCALE_INDEPENDENT_DETAILS
```
public static final java.lang.String PROPERTY_LOCALE_INDEPENDENT_DETAILS
```
    Property to mark detail pages to have locale independent detail only containers.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_LOCALE_NOTRANSLATION
```
public static final java.lang.String PROPERTY_LOCALE_NOTRANSLATION
```
    Property for the 'do not translate' marking in the sitemap editor.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_LOGIN_FORM
```
public static final java.lang.String PROPERTY_LOGIN_FORM
```
    Property for the login form.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_NAVIMAGE
```
public static final java.lang.String PROPERTY_NAVIMAGE
```
    Property constant for "NavImage".
    
    See Also:
    
    Constant Field Values
  - PROPERTY_NAVINFO
```
public static final java.lang.String PROPERTY_NAVINFO
```
    Property constant for "NavInfo".
    
    See Also:
    
    Constant Field Values
  - PROPERTY_NAVPOS
```
public static final java.lang.String PROPERTY_NAVPOS
```
    Property for the navigation position.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_NAVTEXT
```
public static final java.lang.String PROPERTY_NAVTEXT
```
    Property for the navigation text.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_NOTIFICATION_INTERVAL
```
public static final java.lang.String PROPERTY_NOTIFICATION_INTERVAL
```
    Property for the resource title.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_RELATIVEROOT
```
public static final java.lang.String PROPERTY_RELATIVEROOT
```
    Property for the relative root link substitution.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_RESTYPES_AVAILABLE
```
public static final java.lang.String PROPERTY_RESTYPES_AVAILABLE
```
    Property name that defines the available resource types for the "new" dialog.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_SEARCH_CATEGORY
```
public static final java.lang.String PROPERTY_SEARCH_CATEGORY
```
    Property to sort search results in categories.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_SEARCH_EXCLUDE
```
public static final java.lang.String PROPERTY_SEARCH_EXCLUDE
```
    Property to exclude individual resources from search index generation.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_SEARCH_PRIORITY
```
public static final java.lang.String PROPERTY_SEARCH_PRIORITY
```
    Property to boost certain search results.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_SEARCH_EXCLUDE_ONLINE
```
public static final java.lang.String PROPERTY_SEARCH_EXCLUDE_ONLINE
```
    Property to exclude individual resources from search results online (Solr only).
    
    See Also:
    
    Constant Field Values
  - PROPERTY_SECONDARY_LOCALES
```
public static final java.lang.String PROPERTY_SECONDARY_LOCALES
```
    Property for secondary locales for use in the locale compare view in the sitemap editor.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_SECURE
```
public static final java.lang.String PROPERTY_SECURE
```
    Property for the secure transmission of resources.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_STYLESHEET
```
public static final java.lang.String PROPERTY_STYLESHEET
```
    Property for the stylesheet of files.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_TEMPLATE
```
public static final java.lang.String PROPERTY_TEMPLATE
```
    Property to control the template.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_TEMPLATE_COMPATILIBITY
```
public static final java.lang.String PROPERTY_TEMPLATE_COMPATILIBITY
```
    Property to customize for which templates elements should be displayed in the gallery when using the CmsTransformerTemplateProvider.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_TEMPLATE_DISPLAY_TYPES
```
public static final java.lang.String PROPERTY_TEMPLATE_DISPLAY_TYPES
```
    Property for specifying a list of container types used to match formatters in the display formatter selection widget.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_TEMPLATE_ELEMENTS
```
public static final java.lang.String PROPERTY_TEMPLATE_ELEMENTS
```
    Property to control the template elements.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_TEMPLATE_IMAGE
```
public static final java.lang.String PROPERTY_TEMPLATE_IMAGE
```
    Property for the template image.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_TEMPLATE_PROVIDER
```
public static final java.lang.String PROPERTY_TEMPLATE_PROVIDER
```
    Property to configure the value which should be used instead of the template path when selecting the template in the GUI. Please note that this does not have to actually be a template provider configuration string, this is just the most common use case.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_TITLE
```
public static final java.lang.String PROPERTY_TITLE
```
    Property for the resource title.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_UDR_CONFIG
```
public static final java.lang.String PROPERTY_UDR_CONFIG
```
    Property for user data request configuration.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_UDR_DEFAULTOU
```
public static final java.lang.String PROPERTY_UDR_DEFAULTOU
```
    Property used to configure default organizational unit.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_URLNAME_REPLACE
```
public static final java.lang.String PROPERTY_URLNAME_REPLACE
```
    Name of the property used to control whether mapped URL names should replace previous URL names.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_VISIBLE
```
public static final java.lang.String PROPERTY_VISIBLE
```
    Property for the visible method in the administration view.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_XMLSITEMAP_CHANGEFREQ
```
public static final java.lang.String PROPERTY_XMLSITEMAP_CHANGEFREQ
```
    Property for the XML sitemap change frequency.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_XMLSITEMAP_PRIORITY
```
public static final java.lang.String PROPERTY_XMLSITEMAP_PRIORITY
```
    Property for the XML sitemap priority.
    
    See Also:
    
    Constant Field Values
  - PROPERYDEFINITION_RESOURCE
```
public static final int PROPERYDEFINITION_RESOURCE
```
    The property definition type for resources.
    
    See Also:
    
    Constant Field Values
  - TYPE_LINK
```
public static final CmsPropertyDefinition.CmsPropertyType TYPE_LINK
```
    Property value is treated as a link or list of links.
  - TYPE_NORMAL
```
public static final CmsPropertyDefinition.CmsPropertyType TYPE_NORMAL
```
    Property value is not a link.
- Constructor Detail
  - CmsPropertyDefinition
```
public CmsPropertyDefinition(CmsUUID id,
                             java.lang.String name)
```
    Creates a new property definition object with the type TYPE_NORMAL.
    
    Parameters:
    
    id - the id of the property definition
    
    name - the name of the property definition
  - CmsPropertyDefinition
```
public CmsPropertyDefinition(CmsUUID id,
                             java.lang.String name,
                             CmsPropertyDefinition.CmsPropertyType propertyType)
```
    Creates a new property definition object.
    
    Parameters:
    
    id - the id of the property definition
    
    name - the name of the property definition
    
    propertyType - the type of the property
- Method Detail
  - checkPropertyName
```
public static void checkPropertyName(java.lang.String name)
                              throws CmsIllegalArgumentException
```
    Checks if the provided property name is a valid property name, that is contains only valid characters.
    A property name can only be composed of digits, standard ASCII letters and the symbols defined in NAME_CONSTRAINTS.
    
    Parameters:
    
    name - the property name to check
    
    Throws:
    
    CmsIllegalArgumentException - if the given property name is not valid
  - getNullPropertyDefinition
```
public static CmsPropertyDefinition getNullPropertyDefinition()
```
    Returns the null property definition.
    
    Returns:
    
    the null property definition
  - clone
```
public java.lang.Object clone()
```
    Returns a clone of this Objects instance.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    a clone of this instance
  - compareTo
```
public int compareTo(CmsPropertyDefinition obj)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<CmsPropertyDefinition>
    
    See Also:
    
    Comparable.compareTo(java.lang.Object)
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - getId
```
public CmsUUID getId()
```
    Returns the id of this property definition.
    
    Returns:
    
    id the id of this Propertydefinition
  - getName
```
public java.lang.String getName()
```
    Returns the name of this property definition.
    
    Returns:
    
    name The name of this property definition
  - getType
```
public CmsPropertyDefinition.CmsPropertyType getType()
```
    Returns the the type of this property definition.
    
    Returns:
    
    the type of this property definition
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
    
    See Also:
    
    Object.hashCode()
  - setType
```
public void setType(CmsPropertyDefinition.CmsPropertyType type)
```
    Sets the type for this property definition.
    
    Parameters:
    
    type - the type to set
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    See Also:
    
    Object.toString()

Class CmsPropertyDefinition

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAME_CONSTRAINTS

PROPERTY_ACTIV

PROPERTY_AVAILABLE_LOCALES

PROPERTY_BODY_CLASS

PROPERTY_CACHE

PROPERTY_CATEGORY_REPOSITORY

PROPERTY_CONTAINER_INFO

PROPERTY_CONTENT_CONVERSION

PROPERTY_CONTENT_ENCODING

PROPERTY_COPYRIGHT

PROPERTY_DEFAULT_FILE

PROPERTY_DELETE_EXPIRED

PROPERTY_DESCRIPTION

PROPERTY_DESCRIPTION_HTML

PROPERTY_DISPLAY_ORDER

PROPERTY_ELEMENT_MODEL

PROPERTY_ELEMENT_REPLACEMENTS

PROPERTY_ENABLE_NOTIFICATION

PROPERTY_EXPORT

PROPERTY_EXPORT_TYPE

PROPERTY_EXPORTNAME

PROPERTY_EXPORTSUFFIX

PROPERTY_FOLDERS_AVAILABLE

PROPERTY_GALLERIES_FOLDER

PROPERTY_GOOGLE_API_KEY

PROPERTY_GOOGLE_API_KEY_WORKPLACE

PROPERTY_HISTORY_REMOVE_DELETED

PROPERTY_IMAGE_FOCAL_POINT

PROPERTY_IMAGE_SIZE

PROPERTY_INSTANCEDATE_COPYFIELD

PROPERTY_KEYWORDS

PROPERTY_LINKS_FORCEABSOLUTE_ENABLED

PROPERTY_LOCALE

PROPERTY_LOCALE_INDEPENDENT_DETAILS

PROPERTY_LOCALE_NOTRANSLATION

PROPERTY_LOGIN_FORM

PROPERTY_NAVIMAGE

PROPERTY_NAVINFO

PROPERTY_NAVPOS

PROPERTY_NAVTEXT

PROPERTY_NOTIFICATION_INTERVAL

PROPERTY_RELATIVEROOT

PROPERTY_RESTYPES_AVAILABLE

PROPERTY_SEARCH_CATEGORY

PROPERTY_SEARCH_EXCLUDE

PROPERTY_SEARCH_PRIORITY

PROPERTY_SEARCH_EXCLUDE_ONLINE

PROPERTY_SECONDARY_LOCALES

PROPERTY_SECURE

PROPERTY_STYLESHEET

PROPERTY_TEMPLATE

PROPERTY_TEMPLATE_COMPATILIBITY

PROPERTY_TEMPLATE_DISPLAY_TYPES

PROPERTY_TEMPLATE_ELEMENTS

PROPERTY_TEMPLATE_IMAGE

PROPERTY_TEMPLATE_PROVIDER

PROPERTY_TITLE

PROPERTY_UDR_CONFIG

PROPERTY_UDR_DEFAULTOU

PROPERTY_URLNAME_REPLACE

PROPERTY_VISIBLE

PROPERTY_XMLSITEMAP_CHANGEFREQ

PROPERTY_XMLSITEMAP_PRIORITY

PROPERYDEFINITION_RESOURCE

TYPE_LINK

TYPE_NORMAL

Constructor Detail

CmsPropertyDefinition

CmsPropertyDefinition

Method Detail

checkPropertyName

getNullPropertyDefinition

clone