Package com.novomind.ecom.api.iagent.model

Enum Class MessageTemplate.Type

java.lang.Object

java.lang.Enum<MessageTemplate.Type>

com.novomind.ecom.api.iagent.model.MessageTemplate.Type

All Implemented Interfaces:

Serializable, Comparable<MessageTemplate.Type>, Constable

Enclosing interface:

MessageTemplate

public static enum MessageTemplate.Type
extends Enum<MessageTemplate.Type>

This enumeration describes the type of a MessageTemplate.

Since:

12.37

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
COMPOSITE	Means that the MessageTemplate is a composite template that is used to wrap other regular templates or include templates and provides specific style attributes to display the wrapped templates.
INCLUDE	Means that the MessageTemplate is an include template that can only be included by a regular template or a composite template.
TEMPLATE	Means that the MessageTemplate is a regular template.

Method Summary

Modifier and Type	Method	Description
Long	getId()
static MessageTemplate.Type	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MessageTemplate.Type[]	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

TEMPLATE

public static final MessageTemplate.Type TEMPLATE

Means that the MessageTemplate is a regular template.

Since:

12.37

INCLUDE

public static final MessageTemplate.Type INCLUDE

Means that the MessageTemplate is an include template that can only be included by a regular template or a composite template.

Since:

12.37

COMPOSITE

public static final MessageTemplate.Type COMPOSITE

Means that the MessageTemplate is a composite template that is used to wrap other regular templates or include templates and provides specific style attributes to display the wrapped templates.

Since:

12.37

Method Details

values

public static MessageTemplate.Type[] 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 MessageTemplate.Type 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

getId

public Long getId()

Returns:

the id of this Type.

Since:

12.37