Package org.opencms.xml.types

Enum Class I_CmsXmlContentValue.SearchContentType

java.lang.Object

java.lang.Enum<I_CmsXmlContentValue.SearchContentType>

org.opencms.xml.types.I_CmsXmlContentValue.SearchContentType

All Implemented Interfaces:

Serializable, Comparable<I_CmsXmlContentValue.SearchContentType>, Constable

Enclosing interface:

I_CmsXmlContentValue

public static enum I_CmsXmlContentValue.SearchContentType
extends Enum<I_CmsXmlContentValue.SearchContentType>

The available search types for element searchsetting.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTENT	Merge the extracted content of the resource linked by the element into the content field.
FALSE	Do not merge the value of the field into the content field.
TRUE	Merge the value of the field into the content field.
UPDATE	Do not merge the value of the field into the content field, but re-index if the resource linked in this field changed.

Method Summary

Modifier and Type	Method	Description
static boolean	addReIndexRelation(I_CmsXmlContentValue.SearchContentType type)	Returns a flag, indicating if the the re-index relation should be added.
static I_CmsXmlContentValue.SearchContentType	fromString(String type)	Converts the String into a SearchContentType.
static I_CmsXmlContentValue.SearchContentType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static I_CmsXmlContentValue.SearchContentType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FALSE

public static final I_CmsXmlContentValue.SearchContentType FALSE

Do not merge the value of the field into the content field.

TRUE

public static final I_CmsXmlContentValue.SearchContentType TRUE

Merge the value of the field into the content field.

CONTENT

public static final I_CmsXmlContentValue.SearchContentType CONTENT

Merge the extracted content of the resource linked by the element into the content field.

UPDATE

public static final I_CmsXmlContentValue.SearchContentType UPDATE

Do not merge the value of the field into the content field, but re-index if the resource linked in this field changed.

Method Details

values

public static I_CmsXmlContentValue.SearchContentType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static I_CmsXmlContentValue.SearchContentType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

addReIndexRelation

public static boolean addReIndexRelation(I_CmsXmlContentValue.SearchContentType type)

Returns a flag, indicating if the the re-index relation should be added.

Parameters:

type - the search content type

Returns:

true, iff the re-indexing relation should be added.

fromString

public static I_CmsXmlContentValue.SearchContentType fromString(String type)

Converts the String into a SearchContentType. Returns null if conversion is not possible.

Parameters:

type - the search content type as String.

Returns:

the search content type specified by the provided String, or null if the String did not specify any search content type.