Docmosis API 4.8.0

com.docmosis.document
Class CoordinatedRenderResult

java.lang.Object
  extended by com.docmosis.document.DocumentRenderResultBase
      extended by com.docmosis.document.CoordinatedRenderResult

public class CoordinatedRenderResult
extends com.docmosis.document.DocumentRenderResultBase

The results of a the render of a "coordinated" document (driven by a coordinator template).


Constructor Summary
CoordinatedRenderResult(DocumentRenderResult uncoordinatedResult)
           
CoordinatedRenderResult(long length, int documentPageCount, boolean errorsDetectedInDocument, TemplateIdentifier templateId, boolean isZip, boolean padToEvenPageRequested, boolean padToOddPageRequested, boolean newFileRequested, String newFileName, boolean isSubsequentFormatSave)
           
 
Method Summary
 String getNewFileName()
          Get the specified name (if any) of a new file request.
 boolean isNewFileRequested()
          Determine if the coordinator template has requested a new file at this point in the coordination.
 boolean isPadToEvenPageRequested()
          Determine whether the coordinator template specified that padding to an even page has been requested at this point in the coordination.
 boolean isPadToOddPageRequested()
           
 boolean isSubsequentFormatSave()
          Determine if this is a document from the same render as another document but just a format variant.
 void setNewFileName(String newFileName)
           
 void setNewFileRequested(boolean newFileRequested)
           
 void setPadToEvenPageRequested(boolean padToEvenPageRequested)
           
 void setPadToOddPageRequested(boolean padToOddPageRequested)
           
 void setSubsequentFormatSave(boolean isSubsequentFormatSave)
           
 
Methods inherited from class com.docmosis.document.DocumentRenderResultBase
getDocumentPageCount, getLength, getTemplateId, isErrorsDetectedInDocument, isZip
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CoordinatedRenderResult

public CoordinatedRenderResult(long length,
                               int documentPageCount,
                               boolean errorsDetectedInDocument,
                               TemplateIdentifier templateId,
                               boolean isZip,
                               boolean padToEvenPageRequested,
                               boolean padToOddPageRequested,
                               boolean newFileRequested,
                               String newFileName,
                               boolean isSubsequentFormatSave)

CoordinatedRenderResult

public CoordinatedRenderResult(DocumentRenderResult uncoordinatedResult)
Method Detail

isPadToEvenPageRequested

public boolean isPadToEvenPageRequested()
Determine whether the coordinator template specified that padding to an even page has been requested at this point in the coordination.

Returns:
true if so

setPadToEvenPageRequested

public void setPadToEvenPageRequested(boolean padToEvenPageRequested)

isPadToOddPageRequested

public boolean isPadToOddPageRequested()

setPadToOddPageRequested

public void setPadToOddPageRequested(boolean padToOddPageRequested)

isNewFileRequested

public boolean isNewFileRequested()
Determine if the coordinator template has requested a new file at this point in the coordination. This can be used when joining result documents together to decide whether (for example) a PDF should be ended and another started (ie creating multiple merged pdfs)

Returns:
true if so

setNewFileRequested

public void setNewFileRequested(boolean newFileRequested)

isSubsequentFormatSave

public boolean isSubsequentFormatSave()
Determine if this is a document from the same render as another document but just a format variant. This happens when multiple output formats have been requested (eg docx,pdf) in the same render call. In such a case, only one of the documents will be false and all others (format variants of the document) will return true.

Returns:
true if so

setSubsequentFormatSave

public void setSubsequentFormatSave(boolean isSubsequentFormatSave)

getNewFileName

public String getNewFileName()
Get the specified name (if any) of a new file request.

Returns:
null or a file name to use

setNewFileName

public void setNewFileName(String newFileName)

Docmosis API 4.8.0

Copyright © 2014–2024 Docmosis Pty Ltd. All rights reserved.