Index

Object HARMONI.HarmoniSaffronJob

Close()

Job close call to the server..

concatenate(HarmoniJob)

Concatenates the output files opened in HarmoniJob.

getOutputFileNames()

This method will return an array of output file names which can be used as the outputFileName parameter of a call to getOutputAsStream.

OutputConcatTo(String, FormatOptions)

Concatenate multiple job outputs to a single document using Saffron.

OutputConcatToSaffronHtml(String, HTMLFormatOptions)

Concatenate multiple job outputs to a single Html document using Saffron. Deprecated

OutputConcatToSaffronPDF(String, PDFFormatOptions)

Concatenate multiple job outputs to a single PDF document using Saffron. Deprecated

OutputConcatToSaffronRTF(String, RTFFormatOptions)

Concatenate multiple job outputs to a single RTF document using Saffron. Deprecated

OutputConcatToSaffronSVG(String, SVGFormatOptions)

Concatenate multiple job outputs to a single SVG document using Saffron. Deprecated

setRetrieveOutputAsStream(boolean)

This method informs the report server to retrieve the output as a java input stream.

setRetrieveOutputToClientDisk(boolean)

This method informs the report server to retrieve the output files and write them to the client disk.

setStoreOutputInRepository(boolean)

This method prepares the report server to store the output in the repostory.

Start()

Issue a PEStartPrintJob call for the job.

storeOutputInRepository(String, RepositorySecurityOptions, RepositoryExpirationOptions, boolean)

This method will store the output files in the repository.

void concatenate(HarmoniJob job)

          Concatenates the output files opened in HarmoniJob. Maximum of 10 jobs can be concatenated on a single run.

void OutputConcatTo(String outputFileName,
                    FormatOptions fmtOptions)

          Concatenate multiple job outputs to a single document using Saffron.

Parameters:

outputFileName -

formatOptions - The options the specify the format to output to

void OutputConcatToSaffronPDF(String pdfFileName,
                              PDFFormatOptions options)

Note: OutputConcatToSaffronPDF() is deprecated.As of Harmoni 1.0, replaced by OutputTo(DestinationOptions, FormatOptions)

          Concatenate multiple job outputs to a single PDF document using Saffron.

Parameters:

pdfFileName - The name of the file to export to.

options - The HarmoniSaffronPDFOptions to use when outputing.

void OutputConcatToSaffronRTF(String rtfFileName,
                              RTFFormatOptions options)

Note: OutputConcatToSaffronRTF() is deprecated.As of Harmoni 1.0, replaced by OutputTo(DestinationOptions, FormatOptions)

          Concatenate multiple job outputs to a single RTF document using Saffron.

Parameters:

rtfFileName - The name of the file to export to.

options - The HarmoniSaffronRTFOptions to use when outputing.

void OutputConcatToSaffronHtml(String htmlFileName,
                               HTMLFormatOptions options)

Note: OutputConcatToSaffronHtml() is deprecated.As of Harmoni 1.0, replaced by OutputTo(DestinationOptions, FormatOptions)

          Concatenate multiple job outputs to a single Html document using Saffron.

Parameters:

htmlFileName - The name of the file to export to.

options - The HarmoniSaffronHtmlOptions to use when outputing.

void OutputConcatToSaffronSVG(String svgFileName,
                              SVGFormatOptions options)

Note: OutputConcatToSaffronSVG() is deprecated.As of Harmoni 1.0, replaced by OutputTo(DestinationOptions, FormatOptions)

          Concatenate multiple job outputs to a single SVG document using Saffron.

Parameters:

svgFileName - The name of the file to export to.

options - The HarmoniSaffronSVGOptions to use when outputing.

void Start()

          Issue a PEStartPrintJob call for the job.

void Close()

          Job close call to the server.. closes all jobs that were concatenated using Start

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.

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.

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.

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.

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