AssemblerResult (AEM Forms API)

java.lang.Object
- com.adobe.fd.assembler.client.AssemblerResult

All Implemented Interfaces:

Serializable
```
public class AssemblerResult
extends Object
implements 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 and Description

AssemblerResult()

Constructors
Constructor and Description
`AssemblerResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,Document>`	`getDocuments()` Retrieves the successful documents from the DDX job.
`List<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.
`Map<String,List<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.
`List<String>`	`getSuccessfulBlockNames()` Retrieves the names of the blocks that were successful.
`List<String>`	`getSuccessfulDocumentNames()` Retrieves the names of the documents that were successful.
`Map<String,OperationException>`	`getThrowables()` Retrieves a map of the throwable exceptions that were generated during execution of the DDX.
`void`	`setDocuments(Map<String,Document> documents)` Sets the successful documents from the DDX job.
`void`	`setFailedBlockNames(List<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(Map<String,List<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(List<String> successfulBlockNames)` Sets the names of the blocks that were successful.
`void`	`setSuccessfulDocumentNames(List<String> successfulDocumentNames)` Sets the names of the documents that were successful.
`void`	`setThrowables(Map<String,OperationException> throwables)` Sets a map of the throwable exceptions that were generated during execution of the DDX.

- Constructor Detail
  - AssemblerResult
```
public AssemblerResult()
```
- Method Detail
  - getDocuments
```
public Map<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(Map<String,Document> documents)
```
    Sets the successful documents from the DDX job.
    
    Parameters:
    
    documents - The successful documents from the DDX job.
  - getFailedBlockNames
```
public List<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(List<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 Map<String,List<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(Map<String,List<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 List<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(List<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 List<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(List<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 Map<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(Map<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.

Class AssemblerResult

Constructor Summary

Method Summary

Constructor Detail

AssemblerResult

Method Detail

getDocuments

setDocuments

getFailedBlockNames

setFailedBlockNames

getJobLog

setJobLog

getNumRequestedBlocks

setNumRequestedBlocks

getMultipleResultsBlocks

setMultipleResultsBlocks

getSuccessfulBlockNames

setSuccessfulBlockNames

getSuccessfulDocumentNames

setSuccessfulDocumentNames

getThrowables

setThrowables

getLastBatesNumber

setLastBatesNumber