Index

Object PCRE.PCRESaffronJob

Method Index

o Close()
Job close call to the server..
o concatenate(PCREJob)
Concatenates the output files opened in PCREJob.
o getOutputFileNames()
This method will return an array of output file names which can be used as the outputFileName parameter of a call to getOutputAsStream.
o OutputConcatToSaffronHtml(String, PCRESaffronHtmlOptions)
Concatenate multiple job outputs to a single Html document using Saffron.
o OutputConcatToSaffronPDF(String, PCRESaffronPDFOptions)
Concatenate multiple job outputs to a single PDF document using Saffron.
o OutputConcatToSaffronRTF(String, PCRESaffronRTFOptions)
Concatenate multiple job outputs to a single RTF document using Saffron.
o OutputConcatToSaffronSVG(String, PCRESaffronSVGOptions)
Concatenate multiple job outputs to a single SVG document using Saffron.
o setRetrieveOutputAsStream(boolean)
This method informs the report server to retrieve the output as a java input stream.
o setRetrieveOutputToClientDisk(boolean)
This method informs the report server to retrieve the output files and write them to the client disk.
o setStoreOutputInRepository(boolean)
This method prepares the report server to store the output in the repostory.
o Start()
Issue a PEStartPrintJob call for the job.
o storeOutputInRepository(String, RepositorySecurityOptions, RepositoryExpirationOptions, boolean)
This method will store the output files in the repository.

Method Detail

o concatenate
void concatenate(PCREJob job)
          Concatenates the output files opened in PCREJob. Maximum of 10 jobs can be concatenated on a single run.
o OutputConcatToSaffronPDF
void OutputConcatToSaffronPDF(String pdfFileName,
                              PCRESaffronPDFOptions options)
          Concatenate multiple job outputs to a single PDF document using Saffron.
Parameters:
pdfFileName - The name of the file to export to.
options - The PCRESaffronPDFOptions to use when outputing.
o OutputConcatToSaffronRTF
void OutputConcatToSaffronRTF(String rtfFileName,
                              PCRESaffronRTFOptions options)
          Concatenate multiple job outputs to a single RTF document using Saffron.
Parameters:
rtfFileName - The name of the file to export to.
options - The PCRESaffronRTFOptions to use when outputing.
o OutputConcatToSaffronHtml
void OutputConcatToSaffronHtml(String htmlFileName,
                               PCRESaffronHtmlOptions options)
          Concatenate multiple job outputs to a single Html document using Saffron.
Parameters:
htmlFileName - The name of the file to export to.
options - The PCRESaffronHtmlOptions to use when outputing.
o OutputConcatToSaffronSVG
void OutputConcatToSaffronSVG(String svgFileName,
                              PCRESaffronSVGOptions options)
          Concatenate multiple job outputs to a single SVG document using Saffron.
Parameters:
svgFileName - The name of the file to export to.
options - The PCRESaffronSVGOptions to use when outputing.
o Start
void Start()
          Issue a PEStartPrintJob call for the job.
o Close
void Close()
          Job close call to the server.. closes all jobs that were concatenated using Start
o getOutputFileNames
String[] getOutputFileNames()
          This method will return an array of output file names which can be used as the outputFileName parameter of a call to getOutputAsStream.
o setRetrieveOutputToClientDisk
void setRetrieveOutputToClientDisk(boolean value)
          This method informs the report server to retrieve the output files and write them to the client disk. This method must be called before any of the Output or Export methods. The files are actually retrieved during the Start method call.
o setRetrieveOutputAsStream
void setRetrieveOutputAsStream(boolean value)
          This method informs the report server to retrieve the output as a java input stream. This method must be called before any of the Output or Export methods. The input stream can be obtained after the Start method completes by calling the getOutputAsStream method.
o setStoreOutputInRepository
void setStoreOutputInRepository(boolean value)
          This method prepares the report server to store the output in the repostory.
Parameters:
value - If set to true, the report server will prepare to store output in the repository, else it will not and if asked will throw an exception.
o storeOutputInRepository
void storeOutputInRepository(String repositoryFolder,
                             RepositorySecurityOptions securityOptions,
                             RepositoryExpirationOptions expirationOptions,
                             boolean overwrite)
          This method will store the output files in the repository. This method must be called after the start method in order for the output to exist.
Parameters:
repositoryFolder - the repository folder where all of the output files should be placed.
securityInfo - the security attributes of the output in the repository
expirationOptions - the expiration attributes of the output in the repository
overwrite - if set to true will overwrite any output in the specified repository folder. If set to false, a DuplicateObjectException will be thrown if output of the same name already exists in the specified repository folder. 
Index