Package com.arbortext.e3c

Interface E3ServerCompositionRequest

public interface E3ServerCompositionRequest
Describes the request for a composition operation to be performed by the E3 server composition application.

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

First, it is passed to the client composition extension's preProcess and postProcess methods.

Second, it is passed in the JAR file transmitted from the client to the E3 server.

Third, it is passed to the extension that is called by the Arbortext E3 server composition application to handle type-specific compostion.

  • Method Details

    • addOption

      void addOption(String name, String value)
      Adds a new set option to our list
      Parameters:
      name - parameter name
      value - parameter value

    • addParameter

      void addParameter(E3ServerCompositionParameter p)
      Adds a new parameter to our list
      Parameters:
      p - parameter to add

    • getDoc

      String getDoc()
      document entry name accessor
      Returns:
      docuemnt entry name

    • getOptionNames

      Iterator<String> getOptionNames()
      Returns an iterator over the set of names in our option list.
      Returns:
      Iterator over String objects.

    • getOption

      String getOption(String name)
      Returns the value of an option
      Parameters:
      name - name of option
      Returns:
      String option value or NULL.

    • containsParameter

      boolean containsParameter(String name)
      Indicates whether we contain the specified parameter
      Parameters:
      name - parameter
      Returns:
      true or false

    • getComposerPath

      String getComposerPath()
      Returns the absolute path to the composer (.ccf file) that should be used to control this operation.
      Returns:
      Absolute path to .ccf file

    • getParameter

      E3ServerCompositionParameter getParameter(String name)
      Returns a parameter descriptor
      Parameters:
      name - parameter name to search for
      Returns:
      CompositionParameter or null

    • getParameters

      Iterator getParameters()
      Returns all parameters
      Returns:
      Iterator for navigating a Set of Map.entry objects

    • getPath

      String getPath()
      composer path accessor
      Returns:
      composer path

    • serialize

      void serialize(Writer w)
      Writes our content to an XML document
      Parameters:
      w - what to write to

    • setDoc

      void setDoc(String newEntry)
      Sets the name of the entry in the JAR file containing the document to be composed.
      Parameters:
      newEntry - entry name

    • setPath

      void setPath(String newPath)
      Sets the absolute path to the composer (.ccf) file on the E3 server
      Parameters:
      newPath - path to composer

    • toString

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