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

Enum MessageTemplate.Type

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<MessageTemplate.Type>
    Enclosing interface:
    MessageTemplate
    public static enum MessageTemplate.Type
extends java.lang.Enum<MessageTemplate.Type>
    This enumeration describes the type of a MessageTemplate.
    Since:
    12.37

    • 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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Long getId()  
      static MessageTemplate.Type valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static MessageTemplate.Type[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • 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 Detail

      • values

        public static MessageTemplate.Type[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (MessageTemplate.Type c : MessageTemplate.Type.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static MessageTemplate.Type valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getId

        public java.lang.Long getId()
        Returns:
        the id of this Type.
        Since:
        12.37