Packagecom.adobe.livecycle.assembler.client
Classpublic class AssemblerResult
InheritanceAssemblerResult Inheritance Object

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.


Public Methods
 MethodDefined By
  
AssemblerResult()
AssemblerResult
  
Map getDocuments()
Retrieves the successful documents from the DDX job.
AssemblerResult
  
List getFailedBlockNames()
A list of the names of the failed blocks.
AssemblerResult
  
Document getJobLog()
Retrieves the job log that was generated during execution of the DDX.
AssemblerResult
  
int getLastBatesNumber()
Returns the numeric portion from the last page stamped with a bates number.
AssemblerResult
  
Map getMultipleResultsBlocks()
Retrieves a map of the result block name to a list of the document names resulting from that result block.
AssemblerResult
  
int getNumRequestedBlocks()
Retrieves the number of result blocks in the DDX.
AssemblerResult
  
List getSuccessfulBlockNames()
Retrieves the names of the blocks that were successful.
AssemblerResult
  
List getSuccessfulDocumentNames()
Retrieves the names of the documents that were successful.
AssemblerResult
  
Map getThrowables()
Retrieves a map of the throwable exceptions that were generated during execution of the DDX.
AssemblerResult
  
void setDocuments(Map documents)
Sets the successful documents from the DDX job.
AssemblerResult
  
void setFailedBlockNames(List failedBlockNames)
Sets the names of the failed blocks.
AssemblerResult
  
void setJobLog(Document jobLog)
Sets the job log that was generated during execution of the DDX.
AssemblerResult
  
void setLastBatesNumber(int lastBatesNumber)
Sets the numeric portion from the last page stamped with a bates number.
AssemblerResult
  
void setMultipleResultsBlocks(Map multipleResultsBlocks)
Sets a map of the result block name to the document names resulting from that result block.
AssemblerResult
  
void setNumRequestedBlocks(int numRequestedBlocks)
Sets the number of result blocks in the DDX.
AssemblerResult
  
void setSuccessfulBlockNames(List successfulBlockNames)
Sets the names of the blocks that were successful.
AssemblerResult
  
void setSuccessfulDocumentNames(List successfulDocumentNames)
Sets the names of the documents that were successful.
AssemblerResult
  
void setThrowables(Map throwables)
Sets a map of the throwable exceptions that were generated during execution of the DDX.
AssemblerResult
Constructor Detail
AssemblerResult()
public AssemblerResult()

Method Detail
getDocuments()
public Map 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.
getFailedBlockNames() 
public List 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.
getJobLog() 
public Document getJobLog()

Retrieves the job log that was generated during execution of the DDX.

Returns
A com.adobe.idp.Document containing the job log that was 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.
getMultipleResultsBlocks() 
public Map 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.
getNumRequestedBlocks() 
public int getNumRequestedBlocks()

Retrieves the number of result blocks in the DDX.

Returns
The number of result blocks in the DDX.
getSuccessfulBlockNames() 
public List getSuccessfulBlockNames()

Retrieves the names of the blocks that were successful.

Returns
A List containing the names of the blocks that were successful.
getSuccessfulDocumentNames() 
public List 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.
getThrowables() 
public Map 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.
setDocuments() 
public void setDocuments(Map documents)

Sets the successful documents from the DDX job.

Parameters

documents — The successful documents from the DDX job.

setFailedBlockNames() 
public void setFailedBlockNames(List failedBlockNames)

Sets the names of the failed blocks.

Parameters

failedBlockNames — The names of the failed blocks.

setJobLog() 
public void setJobLog(Document jobLog)

Sets the job log that was generated during execution of the DDX.

Parameters

jobLog — A com.adobe.idp.Document containing the job log that was generated during execution of the DDX.

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.

setMultipleResultsBlocks() 
public void setMultipleResultsBlocks(Map 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.

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.

setSuccessfulBlockNames() 
public void setSuccessfulBlockNames(List successfulBlockNames)

Sets the names of the blocks that were successful.

Parameters

successfulBlockNames — A List containing the names of the blocks that were successful.

setSuccessfulDocumentNames() 
public void setSuccessfulDocumentNames(List 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.

setThrowables() 
public void setThrowables(Map 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.




© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Wed Oct 1 2008, 10:46 PM -04:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/javadoc/com/adobe/livecycle/assembler/client/AssemblerResult.html