JadeReportWriterReport Methods
The methods defined in the JadeReportWriterReport class are summarized in the following table.
| Method | Description |
|---|---|
| getDefaultOutputDestination | Returns an integer value containing JadeReportWriterReport class constants representing the default output destination |
| getDefaultProfile | Returns a string value containing the name of the default profile |
| getDelimitedFileOptions | Obtains the current values to be used when running the report for extraction to a delimited file |
| getExtraParameterDetails | Obtains whether a value is mandatory and the user prompt value of the specified parameter |
| getFolder | Returns a string containing the path to the folder in which the report is saved |
| getHtmlOptions | Obtains the current values to be used when running the report for extraction to an HTML file |
| getOutputFileTitle | Returns a string value containing the full title of the default output file |
| getPageOptions | Obtains the current report attributes relating to paper size values used when running the report |
| getParameterDetails | Obtains the parameter type, length and scale factor, current value, is used, and ignore status |
| getParameters | Obtains the names and types of all individual parameters |
| getParametersForProfile | Populates the string arrays specified in the names and types parameters with the parameter names and types that are used in the profile specified in the profileName parameter. |
| getProfileDescription | Returns the description of the specified profile |
| getProfiles | Returns an array of profile names defined in the report |
| getQueryOptions | Returns the concurrency and resource limits that are to be applied at the query phase of the report run |
| getReportDescription | Returns the report description (entered in the Description text box on the Report Properties dialog) |
| getReportingViewName | Returns the name of the reporting view for the report |
| getRootCollections | Returns the alias and path of each report root collection or join, or both root collections and joins |
| getTextOptions | Obtains the number of lines on pages when running the report for extraction to a text file |
| getUseClientFileSystem | Returns true if the presentation client file system is used or it returns false if the application server file system is used |
| getXmlOptions | Obtains the current values to be used when running the report for extraction to an XML file |
| run | Runs the current report, using the parameter values specified in the appropriate set methods |
| runWithStatus | Runs the current report using the parameter values specified in the appropriate set methods, displays and refreshes a progress dialog, and returns the status of the report after it has been run, indicating the success of the report run and the page count of a report output to a printer or the record count of a report extracted to file |
| setDelimitedFileOptions | Sets the values to be used when running the report for extraction to a delimited file |
| setEndingNotification | Passes an object that is to be notified when the report finishes |
| setHtmlOptions | Sets the values to be used when running the report for extraction to an HTML file |
| setLocaleDateOptions | Sets date formats to be used when running the report |
| setLocaleNumericOptions | Sets number and currency formats to be used when running the report |
| setLocaleTimeOptions | Sets time formats to be used when running the report |
| setOutputDestination | Sets the destination of the report output |
| setOutputFileTitle | Sets the title of the output file that is created when the report runs |
| setPageOptions | Sets the |
| setParameter | Sets the name and type of a parameter to be used when running the report |
| setParameterIgnoreInSelection | Specifies whether a parameter is to be ignored when selecting parameters for the current run of the report |
| setPreviewOptions | Sets the |
| setProfile | Sets the report profile name to use when running the report |
| setQueryOptions | Sets specified limits on the execution of a query when running the report |
| setStartEndMethods | Sets the names of the application initialize method that is called before the report is run and the finalize method that is called after the report has completed |
| setTextOptions | Sets the number of lines on pages when running the report for extraction to a text file |
| setUseClientFileSystem | Specifies whether the presentation client file system is used (true) or the application server file system is used (false) |
| setXmlOptions | Sets the values used when running the report for extraction to an XML file |
