Enum Class TdbRenditionType

java.lang.Object
java.lang.Enum<TdbRenditionType>
com.tietoenator.trip.jxp.data.TdbRenditionType
All Implemented Interfaces:
Serializable, Comparable<TdbRenditionType>, Constable

public enum TdbRenditionType extends Enum<TdbRenditionType>
Allows the calling application to set a rendition type, or processing type, for the STring field (only) that is being retrieved. This enumeration can't be used for other types of fields, or for operations other than retrieval and is typically used to request that a STring field's content be rendered to HTML.
  • 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
    Requests a basic HTML rendition -- this results in a single stream that reflects the basic layout and content of the rendered document, but does not include any embedded graphics or other such objects that may result from the rendition process.
    Default, retrieves the blob unrendered / unaltered
    Requests a rich HTML rendition -- this results in a MIME-encoded stream of data that reflects the basic HTML document as well as any rich objects or graphics that may have been created by the rendition process.
    Export the contents of the field as XML.
  • Method Summary

    Modifier and Type
    Method
    Description
    Retrieve the name (protocol string) that corresponds to the rendition
    Retrieve the rendition type that matches the provided protocol name
    Returns the enum constant of this class with the specified name.
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • DefaultRendition

      public static final TdbRenditionType DefaultRendition
      Default, retrieves the blob unrendered / unaltered
    • BasicHTML

      public static final TdbRenditionType BasicHTML
      Requests a basic HTML rendition -- this results in a single stream that reflects the basic layout and content of the rendered document, but does not include any embedded graphics or other such objects that may result from the rendition process.
    • MimeEncodedHtml

      public static final TdbRenditionType MimeEncodedHtml
      Requests a rich HTML rendition -- this results in a MIME-encoded stream of data that reflects the basic HTML document as well as any rich objects or graphics that may have been created by the rendition process. Mime-encoded HTML can be provided natively to several of the most common browsers, but not (at time of writing) to Safari or to Firefox without a user-installed extension.
    • TripXmlExport

      public static final TdbRenditionType TripXmlExport
      Export the contents of the field as XML.

      The use of this rendition type requires a server-side installation of TRIPxml and is only valid for the TRIPxml database field D_XMLDOC.

  • Method Details

    • values

      public static TdbRenditionType[] 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 TdbRenditionType 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
    • getRenditionType

      public static TdbRenditionType getRenditionType(String name)
      Retrieve the rendition type that matches the provided protocol name
      Parameters:
      name - The name to match
      Returns:
      The rendition
    • getRenditionName

      public String getRenditionName()
      Retrieve the name (protocol string) that corresponds to the rendition
      Returns:
      A name suitable for use with the <FETCH_REQ> protocol