Package com.arbortext.e3c

Interface E3ServerCompositionResult

public interface E3ServerCompositionResult
Describes the result of a composition operation under the E3 server composisition application.

This object appears in two contexts that are visible to customizers of the E3 composition application.

First, its content is set by a E3 Composition Application Extension after the extension performs some composition operation.

Second, its content is passed to the client machine in the JAR file that is returned as part of the response to a composition request sent to the E3 Composition Application.

  • Method Details

    • getErrorFileEntry

      String getErrorFileEntry()
      Accessor for the error file entry.
      Returns:
      JAR file entry name of the file containing an error message explaining why the E3 composition operation failed.

    • getOutputDirPrefix

      String getOutputDirPrefix()
      Accessoor for output directory prefix
      Returns:
      String that prefixes the JAR file entries corresponding to every file in the composition output directory.

      This directory might contain (e.g.) the graphics files referenced via relative paths from the composition output file (HTML composition) or (e.g.) the entire output of the composition process (web composition), etc.

    • getOutputFileEntry

      String getOutputFileEntry()
      Accessor for output file entry
      Returns:
      JAR file entry name of file containing output of the composition operation, or null if this operation doesn't return a single file.

    • getSuccess

      boolean getSuccess()
      Accessor for 'success' flag
      Returns:
      True if operation succeeded on E3 server, false otherwise.

    • serialize

      void serialize(Writer w)
      Encodes our content as an XML document

    • setErrorFileEntry

      void setErrorFileEntry(String newValue)
      Stores a new error file entry value.
      Parameters:
      newValue - value to store

    • setOutputDirPrefix

      void setOutputDirPrefix(String newValue)
      Stores a new output directory prefix value.
      Parameters:
      newValue - value to store

    • setOutputFileEntry

      void setOutputFileEntry(String newValue)
      Stores a new output file entry value.
      Parameters:
      newValue - value to store

    • setSuccess

      void setSuccess(boolean newValue)
      Stores a new 'success' flag
      Parameters:
      newValue - value to set

    • toString

      String toString()
      Translates our content into a string
      Overrides:
      toString in class Object
      Returns:
      String containing our XML-encoded content