|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.livecycle.assembler.client.AssemblerResult
public class AssemblerResult
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.
To see an object of this type used in a code example, see the Assembling a PDF document using the Java API quick start in Programming with LiveCycle ES3.
Constructor Summary | |
---|---|
AssemblerResult()
|
Method Summary | |
---|---|
Map |
getDocuments()
Retrieves the successful documents from the DDX job. |
List |
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 |
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 |
getSuccessfulBlockNames()
Retrieves the names of the blocks that were successful. |
List |
getSuccessfulDocumentNames()
Retrieves the names of the documents that were successful. |
Map |
getThrowables()
Retrieves a map of the throwable exceptions that were generated during execution of the DDX. |
void |
setDocuments(Map documents)
Sets the successful documents from the DDX job. |
void |
setFailedBlockNames(List 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 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 successfulBlockNames)
Sets the names of the blocks that were successful. |
void |
setSuccessfulDocumentNames(List successfulDocumentNames)
Sets the names of the documents that were successful. |
void |
setThrowables(Map 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 |
---|
public AssemblerResult()
Method Detail |
---|
public Map getDocuments()
To see this method used in a code example, see the Assembling a PDF document using the Java APIs quick start in Programming with LiveCycle ES3.
java.util.Map
containing the successful documents. The key
is a logical name for the document (defined in the DDX document) and the value is the document itself.
Each value element in the map is a code.adobe.idp.Document
instance.public void setDocuments(Map documents)
documents
- The successful documents from the DDX job.public List getFailedBlockNames()
List
containing the names of the failed blocks.public void setFailedBlockNames(List failedBlockNames)
failedBlockNames
- The names of the failed blocks.public Document getJobLog()
Document
containing the job log that was generated during execution of the DDX.public void setJobLog(Document jobLog)
jobLog
- A Document
containing the job log that was generated during execution of
the DDX.public int getNumRequestedBlocks()
public void setNumRequestedBlocks(int numRequestedBlocks)
numRequestedBlocks
- The number of result blocks in the DDX.public Map getMultipleResultsBlocks()
PDFsFromBookmarks
and FileAttachments
result blocks.
Map
of the result block name to the document names resulting
from that result block.public void setMultipleResultsBlocks(Map multipleResultsBlocks)
PDFsFromBookmarks
and FileAttachments
result blocks.
multipleResultsBlocks
- A Map
of the result block name to a list
of the document names resulting from that result block.public List getSuccessfulBlockNames()
List
containing the names of the blocks that were successful.public void setSuccessfulBlockNames(List successfulBlockNames)
successfulBlockNames
- A List
containing the names of the blocks that were successful.public List getSuccessfulDocumentNames()
List
containing the names of the documents that were successful.public void setSuccessfulDocumentNames(List successfulDocumentNames)
successfulDocumentNames
- A List
containing the names of the documents that were successful.public Map getThrowables()
Map
containing the throwable exceptions that were generated during execution of the DDX.public void setThrowables(Map throwables)
throwables
- A Map
containing the throwable exceptions that were generated during
execution of the DDX.public int getLastBatesNumber()
public void setLastBatesNumber(int lastBatesNumber)
lastBatesNumber
- The numeric portion from the last page stamped with a bates number.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |