Package com.adobe.fd.assembler.client

Class AssemblerResult

  • All Implemented Interfaces:
    java.io.Serializable
    public class AssemblerResult
extends java.lang.Object
implements java.io.Serializable
    An AssemblerResult object is a container for the results of a DDX job. It includes result documents as well as the Throwable exceptions that occurred for each DDX block that failed. It also contains audit lists that are useful for iterating through the result documents or Throwable exceptions.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      AssemblerResult()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​Document> getDocuments()
      Retrieves the successful documents from the DDX job.
      java.util.List<java.lang.String> getFailedBlockNames()
      A list of the names of the failed blocks.
      Document getJobLog()
      Retrieves the job log that was generated during execution of the DDX.
      int getLastBatesNumber()
      Returns the numeric portion from the last page stamped with a bates number.
      java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getMultipleResultsBlocks()
      Retrieves a map of the result block name to a list of the document names resulting from that result block.
      int getNumRequestedBlocks()
      Retrieves the number of result blocks in the DDX.
      java.util.List<java.lang.String> getSuccessfulBlockNames()
      Retrieves the names of the blocks that were successful.
      java.util.List<java.lang.String> getSuccessfulDocumentNames()
      Retrieves the names of the documents that were successful.
      java.util.Map<java.lang.String,​OperationException> getThrowables()
      Retrieves a map of the throwable exceptions that were generated during execution of the DDX.
      void setDocuments​(java.util.Map<java.lang.String,​Document> documents)
      Sets the successful documents from the DDX job.
      void setFailedBlockNames​(java.util.List<java.lang.String> failedBlockNames)
      Sets the names of the failed blocks.
      void setJobLog​(Document jobLog)
      Sets the job log that was generated during execution of the DDX.
      void setLastBatesNumber​(int lastBatesNumber)
      Sets the numeric portion from the last page stamped with a bates number.
      void setMultipleResultsBlocks​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> multipleResultsBlocks)
      Sets a map of the result block name to the document names resulting from that result block.
      void setNumRequestedBlocks​(int numRequestedBlocks)
      Sets the number of result blocks in the DDX.
      void setSuccessfulBlockNames​(java.util.List<java.lang.String> successfulBlockNames)
      Sets the names of the blocks that were successful.
      void setSuccessfulDocumentNames​(java.util.List<java.lang.String> successfulDocumentNames)
      Sets the names of the documents that were successful.
      void setThrowables​(java.util.Map<java.lang.String,​OperationException> throwables)
      Sets a map of the throwable exceptions that were generated during execution of the DDX.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AssemblerResult

        public AssemblerResult()

    • Method Detail

      • getDocuments

        public java.util.Map<java.lang.String,​Document> getDocuments()
        Retrieves the successful documents from the DDX job.

        To see this method used in a code example, see the Programmatically Assembling PDF Documents quick start in the SDK Help.

        Returns:
        A Map containing the successful documents. The key is a logical name for the document and the value is the document itself. The name may not be assumed to be suitable to use as a name for the output destination.

      • setDocuments

        public void setDocuments​(java.util.Map<java.lang.String,​Document> documents)
        Sets the successful documents from the DDX job.
        Parameters:
        documents - The successful documents from the DDX job.

      • getFailedBlockNames

        public java.util.List<java.lang.String> getFailedBlockNames()
        A list of the names of the failed blocks. This is a list of the keys in the throwable exceptions map.
        Returns:
        A List containing the names of the failed blocks.

      • setFailedBlockNames

        public void setFailedBlockNames​(java.util.List<java.lang.String> failedBlockNames)
        Sets the names of the failed blocks.
        Parameters:
        failedBlockNames - The names of the failed blocks.

      • getJobLog

        public Document getJobLog()
        Retrieves the job log that was generated during execution of the DDX.
        Returns:
        A Document containing the job log that was generated during execution of the DDX.

      • setJobLog

        public void setJobLog​(Document jobLog)
        Sets the job log that was generated during execution of the DDX.
        Parameters:
        jobLog - A Document containing the job log that was generated during execution of the DDX.

      • getNumRequestedBlocks

        public int getNumRequestedBlocks()
        Retrieves the number of result blocks in the DDX.
        Returns:
        The number of result blocks in the DDX.

      • setNumRequestedBlocks

        public void setNumRequestedBlocks​(int numRequestedBlocks)
        Sets the number of result blocks in the DDX.
        Parameters:
        numRequestedBlocks - The number of result blocks in the DDX.

      • getMultipleResultsBlocks

        public java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getMultipleResultsBlocks()
        Retrieves a map of the result block name to a list of the document names resulting from that result block. This is particularly useful for blocks that can result in multiple output documents such as PDFsFromBookmarks and FileAttachments result blocks.
        Returns:
        A Map of the result block name to the document names resulting from that result block.

      • setMultipleResultsBlocks

        public void setMultipleResultsBlocks​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> multipleResultsBlocks)
        Sets a map of the result block name to the document names resulting from that result block. This is particularly useful for blocks that can result in multiple output documents such as PDFsFromBookmarks and FileAttachments result blocks.
        Parameters:
        multipleResultsBlocks - A Map of the result block name to a list of the document names resulting from that result block.

      • getSuccessfulBlockNames

        public java.util.List<java.lang.String> getSuccessfulBlockNames()
        Retrieves the names of the blocks that were successful.
        Returns:
        A List containing the names of the blocks that were successful.

      • setSuccessfulBlockNames

        public void setSuccessfulBlockNames​(java.util.List<java.lang.String> successfulBlockNames)
        Sets the names of the blocks that were successful.
        Parameters:
        successfulBlockNames - A List containing the names of the blocks that were successful.

      • getSuccessfulDocumentNames

        public java.util.List<java.lang.String> getSuccessfulDocumentNames()
        Retrieves the names of the documents that were successful. This collection has all of the keys in the documents map.
        Returns:
        A List containing the names of the documents that were successful.

      • setSuccessfulDocumentNames

        public void setSuccessfulDocumentNames​(java.util.List<java.lang.String> successfulDocumentNames)
        Sets the names of the documents that were successful. This collection has all of the keys in the documents map.
        Parameters:
        successfulDocumentNames - A List containing the names of the documents that were successful.

      • getThrowables

        public java.util.Map<java.lang.String,​OperationException> getThrowables()
        Retrieves a map of the throwable exceptions that were generated during execution of the DDX.
        Returns:
        A Map containing the throwable exceptions that were generated during execution of the DDX.

      • setThrowables

        public void setThrowables​(java.util.Map<java.lang.String,​OperationException> throwables)
        Sets a map of the throwable exceptions that were generated during execution of the DDX.
        Parameters:
        throwables - A Map containing the throwable exceptions that were generated during execution of the DDX.

      • getLastBatesNumber

        public int getLastBatesNumber()
        Returns the numeric portion from the last page stamped with a bates number.
        Returns:
        the numeric portion from the last page stamped with a bates number. Returns -1 if there are no bates bumbers.

      • setLastBatesNumber

        public void setLastBatesNumber​(int lastBatesNumber)
        Sets the numeric portion from the last page stamped with a bates number.
        Parameters:
        lastBatesNumber - The numeric portion from the last page stamped with a bates number.