jet.client.api.gui
Class JRClientGUI

java.lang.Object
  extended by jet.client.api.BaseJRClient
      extended by jet.client.api.JRClient
          extended by jet.client.api.gui.JRClientGUI

public class JRClientGUI
extends JRClient

Class JRClientGUI represents a client of JReport Server. It provides some methods to run reports, view result versions, create/edit schedules, etc.

The report URL parameter of these methods:

   A report URL string is a URL address of a report in a report server,
   for example, http://localhost:8888/jrserver/SampleReports/CustomerAnalysis.cls.
   It includes four parts:
 
        For example,
   JRClientGUI.viewEx(frame, reportURL, "Report - CustomerAnalysis.cls", ht);
 

 The detailed steps to run and view a report: 
 

1. Calls JRClient.getParamValues(...) to get parameters of the report.
2. Calls JRClient.sendCmdRunAndView(...) to get the temporary result filename.
3. Calls JRClient.makeViewTempResultURL(...) to get the URL for viewing the temporary result.
4. Calls JRClientGUI.createViewResultThread(rstURL, title) to create the viewer thread.
5. Calls the method start() of the viewer thread to view the result.
6. Calls the method waitFrameOpen() of the viewer thread to wait for the viewer frame open and get the frame.

 

The methods on connection: public static void changePasswordByDialog(Frame frame, String jrsvrURL)

The methods about new result of a report: public static ViewerThread view(Frame frame, String rptURL, String title) public static ViewerThread view(Frame frame, String rptURL, Hashtable paramValues, String title) public static ViewerThread view(Frame frame, String rptURL, Hashtable paramValues, String title, String dbUser, String dbPassword) public static ViewerThread view(Frame frame, String rptURL, Hashtable paramValues, String title, String wherePortion, String namedWherePortion, String dbUser, String dbPassword) public static ViewerThread view(Frame frame, String rptURL, Hashtable paramValues, String title, String wherePortion, String namedWherePortion, String whereClause, String dbUser, String dbPassword) public static ViewerThread view(Frame frame, String rptURL, Hashtable paramValues, String title, String wherePortion, String namedWherePortion, String whereClause, String dbUser, String dbPassword, String rptLanguage, String rptEncoding) public static ViewerThread view(Frame frame, String rptURL, Hashtable paramValues, String title, String wherePortion, String namedWherePortion, String whereClause, String dbUser, String dbPassword, String jdbcUrl, String jdbcDriver, String rptLanguage, String rptEncoding) public static ViewerThread view(Frame frame, String rptURL, Hashtable paramValues, String title, String wherePortion, String namedWherePortion, String whereClause, String dbUser, String dbPassword, String jdbcUrl, String jdbcDriver, boolean jdbcGetSupportInfo, String rptLanguage, String rptEncoding) public static ViewerThread view(Frame frame, String rptURL, Hashtable paramValues, String title, String wherePortion, String namedWherePortion, String whereClause, String dbUser, String dbPassword, String jdbcUrl, String jdbcDriver, boolean jdbcGetSupportInfo, String rptLanguage, String rptCountry, String rptEncoding) public static ViewerThread view(Frame frame, String rptURL, Hashtable paramValues, String title, String wherePortion, String namedWherePortion, String whereClause, String dbUser, String dbPassword, String jdbcUrl, String jdbcDriver, boolean jdbcGetSupportInfo, String rptLanguage, String rptCountry, String rptEncoding, String rptStyle) public static ViewerThread view(Frame frame, String rptURL, String paramValues, String title, String wherePortion, String namedWherePortion, String whereClause, String dbUser, String dbPassword) public static ViewerThread view(Frame frame, String rptURL, String paramValues, String title, String wherePortion, String namedWherePortion, String whereClause, String dbUser, String dbPassword, String jdbcUrl, String jdbcDriver, String rptLanguage, String rptEncoding) public static ViewerThread view(Frame frame, String rptURL, String paramValues, String title, String wherePortion, String namedWherePortion, String whereClause, String dbUser, String dbPassword, String jdbcUrl, String jdbcDriver, boolean jdbcGetSupportInfo, String rptLanguage, String rptEncoding) public static ViewerThread view(Frame frame, String rptURL, String paramValues, String title, String wherePortion, String namedWherePortion, String whereClause, String dbUser, String dbPassword, String jdbcUrl, String jdbcDriver, boolean jdbcGetSupportInfo, String rptLanguage, String rptEncoding, String rptStyle) public static ViewerThread viewTempResult(String rptUrl, String rst, String title) public static ViewerThread viewResult(String resultURL, String title) public static ViewerThread viewLocalResult(String resultFile, String title) public static ViewerThread createViewResultThread(Frame frame, String rptURL, Hashtable paramValues, String title) public static ViewerThread createViewResultThread(Frame frame, String rptURL, Hashtable paramValues, String title, String dbUser, String dbPassword) public static ViewerThread createViewResultThread(Frame frame, String rptURL, Hashtable paramValues, String title, String wherePortion, String namedWherePortion, String whereClause, String dbUser, String dbPassword, String rptLanguage, String rptEncoding) public static ViewerThread createViewResultThread(Frame frame, String rptURL, Hashtable paramValues, String title, String wherePortion, String namedWherePortion, String whereClause, String dbUser, String dbPassword, String jdbcUrl, String jdbcDriver, String rptLanguage, String rptEncoding) public static ViewerThread createViewResultThread(Frame frame, String rptURL, Hashtable paramValues, String title, String wherePortion, String namedWherePortion, String whereClause, String dbUser, String dbPassword, String jdbcUrl, String jdbcDriver, boolean jdbcGetSupportInfo, String rptLanguage, String rptEncoding) public static ViewerThread createViewResultThread(Frame frame, String rptURL, Hashtable paramValues, String title, String wherePortion, String namedWherePortion, String whereClause, String dbUser, String dbPassword, String jdbcUrl, String jdbcDriver, boolean jdbcGetSupportInfo, String rptLanguage, String rptCountry, String rptEncoding, String rptStyle) public static ViewerThread createViewResultThread(Frame frame, String rptURL, String paramValues, String title, String wherePortion, String namedWherePortion, String whereClause, String dbUser, String dbPassword) public static ViewerThread createViewResultThread(Frame frame, String rptURL, String paramValues, String title, String wherePortion, String namedWherePortion, String whereClause, String dbUser, String dbPassword, String rptLanguage, String rptEncoding) public static ViewerThread createViewResultThread(String rptUrl, String rst, String title) public static ViewerThread createViewResultThread(String result, String title) public static Dialog getVersionListDialog(Frame frame, String rptURL, String title) public static Dialog getVersionListDialog(Frame frame, String rptURL, String title, boolean isModal) public static Dialog getVersionListDialog(Frame frame, String rptURL, Hashtable paramValues, String title, boolean isModal)

The methods on result versions of a report: public static ViewerThread viewResultVersion(String rptUrl, String resultVersion, String title) public static ViewerThread createViewVersionThread(String rptUrl, String versionResult, String title) public static void showVersionParamValues(Frame frame, String jrsvrURL, String versionID, String title) public static Dialog getVersionListDialog(Frame frame, String rptURL, String title) public static Dialog getVersionListDialog(Frame frame, String rptURL, String title, boolean isModal) public static Dialog getVersionListDialog(Frame frame, String rptURL, Hashtable paramValues, String title, boolean isModal)

The methods on scheduled tasks: public static ScheduledDlg getNewScheduledDlg(Frame frame, String jrsvrURL, String title) public static ScheduledDlg getNewScheduledDlgForReport(Frame frame, String rptURL, String title) public static ScheduledDlg getNewScheduledDlgForReport(Frame frame, String rptURL, String title, String dbUser, String dbPassword) public static ScheduledDlg getNewScheduledDlgForReport(Frame frame, String rptURL, String title, String dbUser, String dbPassword, String rptLanguage, String rptEncoding) public static ScheduledDlg getNewScheduledDlgForReport(Frame frame, String rptURL, String title, String dbUser, String dbPassword, String rptLanguage, String rptCountry, String rptEncoding, String rptStyle) public static ScheduledDlg getEditScheduledDlg(Frame frame, String jrsvrURL, Hashtable scheduledTask, String title) public static TaskListHolder getScheduledListPanel(Frame frame, String jrsvrURL) public static TaskListHolder getActiveListPanel(Frame frame, String jrsvrURL) public static TaskListHolder getCompletedListPanel(Frame frame, String jrsvrURL) public static void showScheduledParamValues(Frame frame, String jrsvrURL, String scheduleID, String title)


Field Summary
 
Fields inherited from class jet.client.api.BaseJRClient
vDebug, vError, vOff
 
Method Summary
static void changePasswordByDialog(java.awt.Frame frame, java.lang.String jrsvrURL)
          A dialog box is popped up to change the password of a user.
static void changePasswordByDialog(java.awt.Frame frame, java.lang.String jrsvrURL, boolean isSwing)
          A dialog box is popped up to change the password of a user.
static ViewerThread createViewResultThread(java.awt.Frame frame, java.lang.String rptURL, java.util.Hashtable paramValues, java.lang.String title)
          Deprecated. As for version 6, it is replaced by createViewResultThreadEx(Frame, String, String, Hashtable).
static ViewerThread createViewResultThread(java.awt.Frame frame, java.lang.String rptURL, java.util.Hashtable paramValues, java.lang.String title, java.lang.String dbUser, java.lang.String dbPassword)
          Deprecated. As for version 6, it is replaced by createViewResultThreadEx(Frame, String, String, Hashtable).
static ViewerThread createViewResultThread(java.awt.Frame frame, java.lang.String rptURL, java.util.Hashtable paramValues, java.lang.String title, java.lang.String wherePortion, java.lang.String namedWherePortion, java.lang.String whereClause, java.lang.String dbUser, java.lang.String dbPassword)
          Deprecated. As for version 6, it is replaced by createViewResultThreadEx(Frame, String, String, Hashtable).
static ViewerThread createViewResultThread(java.awt.Frame frame, java.lang.String rptURL, java.util.Hashtable paramValues, java.lang.String title, java.lang.String wherePortion, java.lang.String namedWherePortion, java.lang.String whereClause, java.lang.String dbUser, java.lang.String dbPassword, java.lang.String rptLanguage, java.lang.String rptEncoding)
          Deprecated. As for version 6, it is replaced by createViewResultThreadEx(Frame, String, String, Hashtable).
static ViewerThread createViewResultThread(java.awt.Frame frame, java.lang.String rptURL, java.util.Hashtable paramValues, java.lang.String title, java.lang.String wherePortion, java.lang.String namedWherePortion, java.lang.String whereClause, java.lang.String dbUser, java.lang.String dbPassword, java.lang.String jdbcUrl, java.lang.String jdbcDriver, boolean jdbcGetSupportInfo, java.lang.String rptLanguage, java.lang.String rptEncoding)
          Deprecated. As for version 6, it is replaced by createViewResultThreadEx(Frame, String, String, Hashtable).
static ViewerThread createViewResultThread(java.awt.Frame frame, java.lang.String rptURL, java.util.Hashtable paramValues, java.lang.String title, java.lang.String wherePortion, java.lang.String namedWherePortion, java.lang.String whereClause, java.lang.String dbUser, java.lang.String dbPassword, java.lang.String jdbcUrl, java.lang.String jdbcDriver, boolean jdbcGetSupportInfo, java.lang.String rptLanguage, java.lang.String rptCountry, java.lang.String rptEncoding, java.lang.String rptStyle)
          Deprecated. As for version 6, it is replaced by createViewResultThreadEx(Frame, String, String, Hashtable).
static ViewerThread createViewResultThread(java.awt.Frame frame, java.lang.String rptURL, java.util.Hashtable paramValues, java.lang.String title, java.lang.String wherePortion, java.lang.String namedWherePortion, java.lang.String whereClause, java.lang.String dbUser, java.lang.String dbPassword, java.lang.String jdbcUrl, java.lang.String jdbcDriver, java.lang.String rptLanguage, java.lang.String rptEncoding)
          Deprecated. As for version 6, it is replaced by createViewResultThreadEx(Frame, String, String, Hashtable).
static ViewerThread createViewResultThread(java.awt.Frame frame, java.lang.String rptURL, java.lang.String paramValues, java.lang.String title, java.lang.String wherePortion, java.lang.String namedWherePortion, java.lang.String whereClause, java.lang.String dbUser, java.lang.String dbPassword)
          Deprecated. As for version 6, it is replaced by createViewResultThreadEx(Frame, String, String, Hashtable).
static ViewerThread createViewResultThread(java.awt.Frame frame, java.lang.String rptURL, java.lang.String paramValues, java.lang.String title, java.lang.String wherePortion, java.lang.String namedWherePortion, java.lang.String whereClause, java.lang.String dbUser, java.lang.String dbPassword, java.lang.String rptLanguage, java.lang.String rptEncoding)
          Deprecated. As for version 6, it is replaced by createViewResultThreadEx(Frame, String, String, Hashtable).
static ViewerThread createViewResultThread(java.lang.String result, java.lang.String title)
          Creates a ViewerThread to view a result file in a report server or a local result file.
static ViewerThread createViewResultThread(java.lang.String rptURL, java.lang.String rst, java.lang.String title)
          Creates a ViewerThread to view a temp result of a report.
static ViewerThread createViewResultThread(java.lang.String rptURL, java.lang.String rst, java.lang.String sheet, java.lang.String title)
          Creates a ViewerThread to view a temp result of a report.
static ViewerThread createViewResultThreadEx(java.awt.Frame frame, java.lang.String rptURL, java.lang.String title, java.util.Hashtable viewProps)
          Creates a ViewerThread to view a new result of a report with parameters.
static ViewerThread createViewVersionThread(java.lang.String rptURL, java.lang.String versionResult, java.lang.String title)
          Creates a ViewerThread to view a report result version.
static ViewerThread createViewVersionThread(java.lang.String rptURL, java.lang.String versionResult, java.lang.String title, java.lang.String sheet)
          Creates a ViewerThread to view a report result version.
static TaskListHolder getActiveListPanel(java.awt.Frame frame, java.lang.String jrsvrURL)
          Returns a TaskListHolder to browse the active tasks.
static TaskListHolder getCompletedListPanel(java.awt.Frame frame, java.lang.String jrsvrURL)
          Returns a TaskListHolder to browse the completed tasks.
static ScheduledDlg getEditScheduledDlg(java.awt.Frame frame, java.lang.String jrsvrURL, java.util.Hashtable scheduledTask, java.lang.String title)
          Returns a dialog box to edit a scheduled task.
static ScheduledDlg getNewScheduledDlg(java.awt.Frame frame, java.lang.String jrsvrURL, java.lang.String title)
          Returns a dialog box to create a scheduled task.
static ScheduledDlg getNewScheduledDlgForReport(java.awt.Frame frame, java.lang.String rptURL, java.lang.String title)
          Returns a dialog box to create a scheduled task for a report.
static ScheduledDlg getNewScheduledDlgForReport(java.awt.Frame frame, java.lang.String rptURL, java.lang.String title, java.util.Hashtable prop)
          Returns a dialog box to create a scheduled task for a report.
static ScheduledDlg getNewScheduledDlgForReport(java.awt.Frame frame, java.lang.String rptURL, java.lang.String title, java.lang.String dbUser, java.lang.String dbPassword)
          Returns a dialog box to create a scheduled task for a report.
static ScheduledDlg getNewScheduledDlgForReport(java.awt.Frame frame, java.lang.String rptURL, java.lang.String title, java.lang.String dbUser, java.lang.String dbPassword, java.lang.String rptLanguage, java.lang.String rptEncoding)
          Returns a dialog box to create a scheduled task for a report.
static ScheduledDlg getNewScheduledDlgForReport(java.awt.Frame frame, java.lang.String rptURL, java.lang.String title, java.lang.String dbUser, java.lang.String dbPassword, java.lang.String rptLanguage, java.lang.String rptCountry, java.lang.String rptEncoding, java.lang.String rptStyle)
          Returns a dialog box to create a scheduled task for a report.
static TaskListHolder getScheduledListPanel(java.awt.Frame frame, java.lang.String jrsvrURL)
          Returns a TaskListHolder to browse scheduled tasks.
static java.awt.Dialog getVersionListDialog(java.awt.Frame frame, java.lang.String rptURL, java.util.Hashtable paramValues, java.lang.String title, boolean isModal)
          Deprecated. As of Version 6.0, replaced by getVersionListDialog(Frame, String, Hashtable, String, String, boolean)
static java.awt.Dialog getVersionListDialog(java.awt.Frame frame, java.lang.String rptURL, java.util.Hashtable paramValues, java.lang.String title, java.lang.String catName, boolean isModal)
          Creates a result version list dialog box to view result versions, new result or create new schedules for this report.
static java.awt.Dialog getVersionListDialog(java.awt.Frame frame, java.lang.String rptURL, java.lang.String title)
          Deprecated. As of Version 6.0, replaced by getVersionListDialog(Frame, String, Hashtable, String, String, boolean)
static java.awt.Dialog getVersionListDialog(java.awt.Frame frame, java.lang.String rptURL, java.lang.String title, boolean isModal)
          Deprecated. As of Version 6.0, replaced by getVersionListDialog(Frame, String, Hashtable, String, String, boolean)
static void showActiveParamValues(java.awt.Frame frame, java.lang.String jrsvrURL, java.lang.String paramFile, java.lang.String taskID, java.lang.String title)
          Brings up a dialog box to show the report parameter values of a active task.
static void showActiveParamValues(java.awt.Frame frame, java.lang.String jrsvrURL, java.lang.String paramFile, java.lang.String taskID, java.lang.String title, boolean isSwing)
          Deprecated. As of Version 6.0, replaced by showActiveParamValues(Frame, String, String, String, String)
static void showScheduledParamValues(java.awt.Frame frame, java.lang.String jrsvrURL, java.lang.String scheduleID, java.lang.String title)
          Brings up a dialog box to show the report parameter values of a scheduled task.
static void showVersionParamValues(java.awt.Frame frame, java.lang.String jrsvrURL, java.lang.String title, java.util.Hashtable prop)
          Brings up a dialog box to show the report parameter values of the result version.
static void showVersionParamValues(java.awt.Frame frame, java.lang.String jrsvrURL, java.lang.String versionID, java.lang.String title)
          Deprecated. As of Version 6.0, replaced by showVersionParamValues(Frame, String, String, String, String)
static void showVersionParamValues(java.awt.Frame frame, java.lang.String jrsvrURL, java.lang.String versionID, java.lang.String title, java.lang.String name)
          Brings up a dialog box to show the report parameter values of the result version.
static ViewerThread view(java.awt.Frame frame, java.lang.String rptURL, java.util.Hashtable paramValues, java.lang.String title)
          Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).
static ViewerThread view(java.awt.Frame frame, java.lang.String rptURL, java.util.Hashtable paramValues, java.lang.String title, java.lang.String dbUser, java.lang.String dbPassword)
          Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).
static ViewerThread view(java.awt.Frame frame, java.lang.String rptURL, java.util.Hashtable paramValues, java.lang.String title, java.lang.String wherePortion, java.lang.String namedWherePortion, java.lang.String dbUser, java.lang.String dbPassword)
          Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).
static ViewerThread view(java.awt.Frame frame, java.lang.String rptURL, java.util.Hashtable paramValues, java.lang.String title, java.lang.String wherePortion, java.lang.String namedWherePortion, java.lang.String whereClause, java.lang.String dbUser, java.lang.String dbPassword)
          Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).
static ViewerThread view(java.awt.Frame frame, java.lang.String rptURL, java.util.Hashtable paramValues, java.lang.String title, java.lang.String wherePortion, java.lang.String namedWherePortion, java.lang.String whereClause, java.lang.String dbUser, java.lang.String dbPassword, java.lang.String rptLanguage, java.lang.String rptEncoding)
          Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).
static ViewerThread view(java.awt.Frame frame, java.lang.String rptURL, java.util.Hashtable paramValues, java.lang.String title, java.lang.String wherePortion, java.lang.String namedWherePortion, java.lang.String whereClause, java.lang.String dbUser, java.lang.String dbPassword, java.lang.String jdbcUrl, java.lang.String jdbcDriver, boolean jdbcGetSupportInfo, java.lang.String rptLanguage, java.lang.String rptEncoding)
          Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).
static ViewerThread view(java.awt.Frame frame, java.lang.String rptURL, java.util.Hashtable paramValues, java.lang.String title, java.lang.String wherePortion, java.lang.String namedWherePortion, java.lang.String whereClause, java.lang.String dbUser, java.lang.String dbPassword, java.lang.String jdbcUrl, java.lang.String jdbcDriver, boolean jdbcGetSupportInfo, java.lang.String rptLanguage, java.lang.String rptCountry, java.lang.String rptEncoding)
          Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).
static ViewerThread view(java.awt.Frame frame, java.lang.String rptURL, java.util.Hashtable paramValues, java.lang.String title, java.lang.String wherePortion, java.lang.String namedWherePortion, java.lang.String whereClause, java.lang.String dbUser, java.lang.String dbPassword, java.lang.String jdbcUrl, java.lang.String jdbcDriver, boolean jdbcGetSupportInfo, java.lang.String rptLanguage, java.lang.String rptCountry, java.lang.String rptEncoding, java.lang.String rptStyle)
          Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).
static ViewerThread view(java.awt.Frame frame, java.lang.String rptURL, java.util.Hashtable paramValues, java.lang.String title, java.lang.String wherePortion, java.lang.String namedWherePortion, java.lang.String whereClause, java.lang.String dbUser, java.lang.String dbPassword, java.lang.String jdbcUrl, java.lang.String jdbcDriver, java.lang.String rptLanguage, java.lang.String rptEncoding)
          Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).
static ViewerThread view(java.awt.Frame frame, java.lang.String rptURL, java.lang.String title)
          Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).
static ViewerThread view(java.awt.Frame frame, java.lang.String rptURL, java.lang.String title, java.lang.String dbUser, java.lang.String dbPassword)
          Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).
static ViewerThread view(java.awt.Frame frame, java.lang.String rptURL, java.lang.String paramValues, java.lang.String title, java.lang.String wherePortion, java.lang.String namedWherePortion, java.lang.String whereClause, java.lang.String dbUser, java.lang.String dbPassword)
          Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).
static ViewerThread view(java.awt.Frame frame, java.lang.String rptURL, java.lang.String paramValues, java.lang.String title, java.lang.String wherePortion, java.lang.String namedWherePortion, java.lang.String whereClause, java.lang.String dbUser, java.lang.String dbPassword, java.lang.String jdbcUrl, java.lang.String jdbcDriver, boolean jdbcGetSupportInfo, java.lang.String rptLanguage, java.lang.String rptEncoding)
          Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).
static ViewerThread view(java.awt.Frame frame, java.lang.String rptURL, java.lang.String paramValues, java.lang.String title, java.lang.String wherePortion, java.lang.String namedWherePortion, java.lang.String whereClause, java.lang.String dbUser, java.lang.String dbPassword, java.lang.String jdbcUrl, java.lang.String jdbcDriver, boolean jdbcGetSupportInfo, java.lang.String rptLanguage, java.lang.String rptEncoding, java.lang.String rptStyle)
          Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).
static ViewerThread view(java.awt.Frame frame, java.lang.String rptURL, java.lang.String paramValues, java.lang.String title, java.lang.String wherePortion, java.lang.String namedWherePortion, java.lang.String whereClause, java.lang.String dbUser, java.lang.String dbPassword, java.lang.String jdbcUrl, java.lang.String jdbcDriver, java.lang.String rptLanguage, java.lang.String rptEncoding)
          Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).
static ViewerThread viewEx(java.awt.Frame frame, java.lang.String rptURL, java.lang.String title, java.util.Hashtable viewProps)
          Views a report with parameters.
static ViewerThread viewLocalResult(java.lang.String resultFile, java.lang.String title)
          Views a local result file.
static ViewerThread viewResult(java.lang.String resultURL, java.lang.String title)
          Views a result in a report server.
static ViewerThread viewResultVersion(java.lang.String rptUrl, java.lang.String resultVersion, java.lang.String title)
          Views a report result version.
static ViewerThread viewResultVersion(java.lang.String rptUrl, java.lang.String resultVersion, java.lang.String title, java.lang.String sheet)
          Views a report result version.
static ViewerThread viewTempResult(java.lang.String rptUrl, java.lang.String rst, java.lang.String title)
          Views a report result.
static ViewerThread viewTempResult(java.lang.String rptUrl, java.lang.String rst, java.lang.String sheet, java.lang.String title, long duration)
          Views a report result.
 
Methods inherited from class jet.client.api.JRClient
advancedDeploy, canExportDhtmlResult, changePassword, checkPermission, checkPrivilege, checkValidation, close, connect, createConditionTrigger, currentRptIsBursting, deleteAllCompleted, deleteCatVersion, deleteCompleted, deleteRptVersion, deleteRptVersion, deleteRstDocVersion, deleteRstVersion, deleteScheduled, deleteTempResult, deleteVersion, deploy, disableScheduled, doesCatalogExist, doesReportExist, downloadResultFiles, downloadResultFiles, enableScheduled, exportTasks, exportTempResult, exportTempResult, exportTempResult, exportTempResult, exportTempResult, exportTempResult, exportTempResult, exportTempResult, exportTempResult, exportTempResult, exportTempResult, exportTempResult, exportTempResult, exportTempResult, exportTempResultEx, exportVersionResult, exportVersionResult, exportVersionResult, exportVersionResult, exportVersionResult, exportVersionResult, exportVersionResult, exportVersionResult, exportVersionResult, exportVersionResult, exportVersionResult, exportVersionResult, exportVersionResult, exportVersionResult, exportVersionResultEx, getActionEditPermissions, getActive, getAllCoditionTrggersName, getAllRoles, getAllUsers, getAvailableLanguages, getAvailableLanguages, getAvailableLanguages, getBooleanNames, getBooleanNames, getCatalogOfReport, getCatalogVersions, getCatLCsInfos, getCatReferFilesInfo, getCatRptsInfos, getCompleted, getCompletedPublishRecords, getConnection, getCurrentUser, getEnabledCustomFieldNames, getEnableDisplayPermissions, getExportScripts, getFoldersInputStream, getGlobalNLS, getInheritedPermissions, getJDKVersionOfServer, getKeepAlive, getLatestVersionNumber, getLCReferFilesInfo, getMailConfigInfo, getMaxVersionLimit, getMediaTray, getNodeInfo, getNodeProperties, getNodeReferInfo, getPaperList, getParamDescAndGrpCols, getParamDescAndGrpCols, getParamDescStream, getParamDescStream, getParamDescVct, getParamDescVct, getParamValues, getParamValues, getParamValues, getParamValues, getParamVector, getParamVector, getParamVector, getParamVector, getParamVector, getParseScrips, getPassword, getPermissions, getPrintersOfServer, getProxyHost, getProxyPort, getRealPath, getReferGroups, getReferRoles, getReferUsers, getReports, getReportSheets, getReportSheetsFromRst, getReportVersions, getResourcePathInfo, getResultDocVersions, getResultMaxVersionLimit, getResultMaxVersionLimit, getResultVersions, getResultVersions, getRptReferFilesInfo, getScheduled, getScheduleFiles, getSelectedFolderComment, getServletPath, getSocketTimeout, getSSL, getStyleGroupDisplayNames, getStyleGroupDisplayNames, getSubFileDirInfo, getSubNodesInfo, getSupportedEncodingNames, getTempResultInputStream, getTempResultInputStream, getUser, getVersionProperties, hasPageSecurity, hasPageSecurity, hasPermissionOk, hasResultFiles, ifUsePostAsDefaultMethod, importScriptTask, importTasks, isAdminUser, isCatalogExits, isClusterEnabled, isDashBoardEnabled, isEnableDuration, IsEnableDynamicResource, isNoBurstRpt, isNoLoginDialog, isOnlyContainBurstRpt, isPromptTaskQueueFull, isReportExist, isSplitPDF, isTaskQueueFull, isTempResultReady, isWaitUser, login, login, logout, makeViewTempResultURL, makeViewTempResultURL, makeViewVersionURL, makeViewVersionURL, openConnection, openConnection, openConnection, openConnection, removeResource, runTask, saveResourceProp, saveVersionProperties, sendCmdRunAndView, sendCmdRunAndView, sendCmdRunAndView, sendCmdRunAndView, sendCmdRunAndView, sendCmdRunAndView, sendCmdRunAndView, sendCmdRunAndView, sendCmdRunAndView, sendCmdRunAndView, sendCmdRunAndView, sendCmdRunAndView, sendCmdRunAndView, sendCmdRunAndView, sendCmdRunAndView, sendCmdRunAndView, sendCmdRunAndView, sendCmdRunAndViewEx, setJDBCConnection, setKeepAlive, setLogFile, setMaxVersionLimit, setNoLoginDialog, setPassword, setProxy, setProxyPassword, setProxyUser, setResultMaxVersionLimit, setResultMaxVersionLimit, setShowInfoLevel, setSocketTimeout, setSSL, setUser, stopActive, submitTask, submitTasks, useGetAsDefaultMethod, usePostAsDefaultMethod, waitTempResultReady, waitTempResultReady
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

changePasswordByDialog

public static void changePasswordByDialog(java.awt.Frame frame,
                                          java.lang.String jrsvrURL)
A dialog box is popped up to change the password of a user.

Parameters:
frame - The Frame of the dialog box.
jrsvrURL - The URL string of the JRServlet, for example, http://localhost:8888/jrserver.

changePasswordByDialog

public static void changePasswordByDialog(java.awt.Frame frame,
                                          java.lang.String jrsvrURL,
                                          boolean isSwing)
A dialog box is popped up to change the password of a user.

Parameters:
frame - The Frame of the dialog box.
jrsvrURL - The URL string of the JRServlet, for example, http://localhost:8888/jrserver.

view

public static ViewerThread view(java.awt.Frame frame,
                                java.lang.String rptURL,
                                java.lang.String title)
                         throws ParseParamValuesException,
                                ParamCanceledException,
                                java.net.MalformedURLException,
                                java.io.IOException,
                                JRResponseException
Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).

Views a report with a report URL string.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box would still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
title - The title of the report viewer that will be brought up.
Returns:
a ViewerThread object. A report viewer frame is brought up by the ViewerThread.
Throws:
ParseParamValuesException - if a ParseParamValuesException occurs.
ParamCanceledException - if cancelled in the parameters dialog box.
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.

view

public static ViewerThread view(java.awt.Frame frame,
                                java.lang.String rptURL,
                                java.lang.String title,
                                java.lang.String dbUser,
                                java.lang.String dbPassword)
                         throws ParseParamValuesException,
                                ParamCanceledException,
                                java.net.MalformedURLException,
                                java.io.IOException,
                                JRResponseException
Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).

Views a report with a report URL string.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
title - The title of the report viewer that will be brought up.
dbUser - The database user ID for running the report.
dbPassword - The database password for running the report.
Returns:
a ViewerThread object. A report viewer frame is brought up by the ViewerThread.
Throws:
ParseParamValuesException - if a ParseParamValuesException occurs.
ParamCanceledException - if cancelled in the parameters dialog box.
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.

view

public static ViewerThread view(java.awt.Frame frame,
                                java.lang.String rptURL,
                                java.util.Hashtable paramValues,
                                java.lang.String title)
                         throws ParseParamValuesException,
                                ParamCanceledException,
                                java.net.MalformedURLException,
                                java.io.IOException,
                                JRResponseException
Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).

Views a report with parameters.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - The Hashtable that contains the parameter values of the report. For each item in the Hashtable, the key is jrs.param$ + PARAMETER_NAME, and and the value is the value of the parameter.
title - The title of the report viewer that will be brought up.
Returns:
a ViewerThread object. A report viewer frame is brought up by the ViewerThread.
Throws:
ParseParamValuesException - if a ParseParamValuesException occurs.
ParamCanceledException - if cancelled in the parameters dialog box.
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.

view

public static ViewerThread view(java.awt.Frame frame,
                                java.lang.String rptURL,
                                java.util.Hashtable paramValues,
                                java.lang.String title,
                                java.lang.String dbUser,
                                java.lang.String dbPassword)
                         throws ParseParamValuesException,
                                ParamCanceledException,
                                java.net.MalformedURLException,
                                java.io.IOException,
                                JRResponseException
Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).

Views a report with parameters.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - The Hashtable that contains the parameter values of the report. For each item in the Hashtable, the key is jrs.param$ + PARAMETER_NAME, and and the value is the value of the parameter.
title - The title of the report viewer that will be brought up.
dbUser - The database user ID for running the report.
dbPassword - The database password for running the report.
Returns:
a ViewerThread object. A report viewer frame is brought up by the ViewerThread.
Throws:
ParseParamValuesException - if a ParseParamValuesException occurs.
ParamCanceledException - if cancelled in the parameters dialog box.
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.

view

public static ViewerThread view(java.awt.Frame frame,
                                java.lang.String rptURL,
                                java.util.Hashtable paramValues,
                                java.lang.String title,
                                java.lang.String wherePortion,
                                java.lang.String namedWherePortion,
                                java.lang.String dbUser,
                                java.lang.String dbPassword)
                         throws ParseParamValuesException,
                                ParamCanceledException,
                                java.net.MalformedURLException,
                                java.io.IOException,
                                JRResponseException
Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).

Views a report with parameters.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - The Hashtable that contains the parameter values of the report. For each item in the Hashtable, the key is jrs.param$ + PARAMETER_NAME, and and the value is the value of the parameter.
title - The title of the report viewer that will be brought up.
wherePortion - The WHERE Portion. The null value or empty string means that no WHERE portion is used.
namedWherePortion - The named WHERE Portion. The null value or empty string means that no named WHERE portion is used.
dbUser - The database user ID for running the report.
dbPassword - The database password for running the report.
Returns:
a ViewerThread object. A report viewer frame is brought up by the ViewerThread.
Throws:
ParseParamValuesException - if a ParseParamValuesException occurs.
ParamCanceledException - if cancelled in the parameters dialog box.
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.

view

public static ViewerThread view(java.awt.Frame frame,
                                java.lang.String rptURL,
                                java.util.Hashtable paramValues,
                                java.lang.String title,
                                java.lang.String wherePortion,
                                java.lang.String namedWherePortion,
                                java.lang.String whereClause,
                                java.lang.String dbUser,
                                java.lang.String dbPassword)
                         throws ParseParamValuesException,
                                ParamCanceledException,
                                java.net.MalformedURLException,
                                java.io.IOException,
                                JRResponseException
Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).

Views a report with parameters.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - The Hashtable that contains the parameter values of the report. For each item in the Hashtable, the key is jrs.param$ + PARAMETER_NAME, and the value is the value of the parameter.
title - The title of the report viewer that will be brought up.
wherePortion - The where portion. The null value or empty string means that no WHERE portion is used.
namedWherePortion - The named where portion. The null value or empty string means that no named WHERE portion is used.
whereClause - The where clause. Note: this parameter is not available at present.
dbUser - The database user ID for running the report.
dbPassword - The database password for running the report.
Returns:
a ViewerThread object. A report viewer frame is brought up by the ViewerThread.
Throws:
ParseParamValuesException - if a ParseParamValuesException occurs.
ParamCanceledException - if cancelled in the parameters dialog box.
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.

view

public static ViewerThread view(java.awt.Frame frame,
                                java.lang.String rptURL,
                                java.util.Hashtable paramValues,
                                java.lang.String title,
                                java.lang.String wherePortion,
                                java.lang.String namedWherePortion,
                                java.lang.String whereClause,
                                java.lang.String dbUser,
                                java.lang.String dbPassword,
                                java.lang.String rptLanguage,
                                java.lang.String rptEncoding)
                         throws ParseParamValuesException,
                                ParamCanceledException,
                                java.net.MalformedURLException,
                                java.io.IOException,
                                JRResponseException
Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).

Views a report with parameters.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - The Hashtable that contains the parameter values of the report. For each item in the Hashtable, the key is jrs.param$ + PARAMETER_NAME, and the value is the value of the parameter.
title - The title of the report viewer that will be brought up.
wherePortion - The WHERE Portion. The null value or empty string means that no WHERE portion is used.
namedWherePortion - The named WHERE Portion. The null value or empty string means that no named WHERE portion is used.
whereClause - The WHERE clause. Note: this parameter is not available at present.
dbUser - The database user ID for running the report.
dbPassword - The database password for running the report.
rptLanguage - The language for generating the report. The method JRCient.getAvailableLanguages(...) can be used to get the available languages of the report.
rptEncoding - The encoding for generating the report. The method JRCient.getSupportedEncodingNames(...) can be used to get the supported encoding names(same to java encodings).
Returns:
a ViewerThread object. A report viewer frame is brought up by the ViewerThread.
Throws:
ParseParamValuesException - if a ParseParamValuesException occurs.
ParamCanceledException - if cancelled in the parameters dialog box.
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.
See Also:
JRClient.getAvailableLanguages(Frame, String)

view

public static ViewerThread view(java.awt.Frame frame,
                                java.lang.String rptURL,
                                java.util.Hashtable paramValues,
                                java.lang.String title,
                                java.lang.String wherePortion,
                                java.lang.String namedWherePortion,
                                java.lang.String whereClause,
                                java.lang.String dbUser,
                                java.lang.String dbPassword,
                                java.lang.String jdbcUrl,
                                java.lang.String jdbcDriver,
                                java.lang.String rptLanguage,
                                java.lang.String rptEncoding)
                         throws ParseParamValuesException,
                                ParamCanceledException,
                                java.net.MalformedURLException,
                                java.io.IOException,
                                JRResponseException
Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).

Views a report with parameters.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - The Hashtable that contains the parameter values of the report. For each item in the Hashtable, the key is jrs.param$ + PARAMETER_NAME, and the value is the value of the parameter.
title - The title of the report viewer that will be brought up.
wherePortion - The WHERE Portion. The null value or empty string means that no WHERE portion is used.
namedWherePortion - The named WHERE Portion. The null value or empty string means that no named WHERE portion is used.
whereClause - The WHERE clause. Note: this parameter is not available at present.
dbUser - The database user ID for running the report.
dbPassword - The database passowrd for running the report.
jdbcUrl - The JDBC URL for running the report.
jdbcDriver - The JDBC driver for running the report.
rptLanguage - The language for generating the report. The method JRCient.getAvailableLanguages(...) can be used to get the available languages of the report.
rptEncoding - The encoding for generating the report. The method JRCient.getSupportedEncodingNames(...) can be used to get the supported encoding names(same to java ecodings).
Returns:
a ViewerThread object. A report viewer frame is brought up by the ViewerThread.
Throws:
ParseParamValuesException - if a ParseParamValuesException occurs.
ParamCanceledException - if cancelled in the parameters dialog box.
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.
See Also:
JRClient.getAvailableLanguages(Frame, String)

view

public static ViewerThread view(java.awt.Frame frame,
                                java.lang.String rptURL,
                                java.util.Hashtable paramValues,
                                java.lang.String title,
                                java.lang.String wherePortion,
                                java.lang.String namedWherePortion,
                                java.lang.String whereClause,
                                java.lang.String dbUser,
                                java.lang.String dbPassword,
                                java.lang.String jdbcUrl,
                                java.lang.String jdbcDriver,
                                boolean jdbcGetSupportInfo,
                                java.lang.String rptLanguage,
                                java.lang.String rptEncoding)
                         throws ParseParamValuesException,
                                ParamCanceledException,
                                java.net.MalformedURLException,
                                java.io.IOException,
                                JRResponseException
Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).

Views a report with parameters.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - The Hashtable that contains the parameter values of the report. For each item in the Hashtable, the key is jrs.param$ + PARAMETER_NAME, and the value is the value of the parameter.
title - The title of the report viewer that will be brought up.
wherePortion - The WHERE Portion. The null value or empty string means that no WHERE portion is used.
namedWherePortion - The named WHERE Portion. The null value or empty string means that no named WHERE portion is used.
whereClause - The WHERE clause. Note: this parameter is not available at present.
dbUser - The database user ID for running the report.
dbPassword - The database passowrd for running the report.
jdbcUrl - The JDBC URL for running the report.
jdbcDriver - The JDBC driver for running the report.
jdbcGetSupportInfo - Specifies whether to re-get the JDBC support info for the new JDBC setting. The default value is "false".
rptLanguage - The language for generating the report. The method JRCient.getAvailableLanguages(...) can be used to get the available languages of the report.
rptEncoding - The encoding for generating the report. The method JRCient.getSupportedEncodingNames(...) can be used to get the supported encoding names(same to java ecodings).
Returns:
a ViewerThread object. A report viewer frame is brought up by the ViewerThread.
Throws:
ParseParamValuesException - if a ParseParamValuesException occurs.
ParamCanceledException - if cancelled in the parameters dialog box.
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.
See Also:
JRClient.getAvailableLanguages(Frame, String)

view

public static ViewerThread view(java.awt.Frame frame,
                                java.lang.String rptURL,
                                java.util.Hashtable paramValues,
                                java.lang.String title,
                                java.lang.String wherePortion,
                                java.lang.String namedWherePortion,
                                java.lang.String whereClause,
                                java.lang.String dbUser,
                                java.lang.String dbPassword,
                                java.lang.String jdbcUrl,
                                java.lang.String jdbcDriver,
                                boolean jdbcGetSupportInfo,
                                java.lang.String rptLanguage,
                                java.lang.String rptCountry,
                                java.lang.String rptEncoding)
                         throws ParseParamValuesException,
                                ParamCanceledException,
                                java.net.MalformedURLException,
                                java.io.IOException,
                                JRResponseException
Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).

Views a report with parameters.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - The Hashtable that contains the parameter values of the report. For each item in the Hashtable, the key is jrs.param$ + PARAMETER_NAME, and the value is the value of the parameter.
title - The title of the report viewer that will be brought up.
wherePortion - The WHERE Portion. The null value or empty string means that no WHERE portion is used.
namedWherePortion - The named WHERE Portion. The null value or empty string means that no named WHERE portion is used.
whereClause - The WHERE clause. Note: this parameter is not available at present.
dbUser - The database user ID for running the report.
dbPassword - The database passowrd for running the report.
jdbcUrl - The JDBC URL for running the report.
jdbcDriver - The JDBC driver for running the report.
jdbcGetSupportInfo - Specifies whether to re-get the JDBC support info for the new JDBC setting. The default value is "false".
rptLanguage - The language for generating the report. The method JRCient.getAvailableLanguages(...) can be used to get the available languages of the report.
rptCountry - The country for generating the report.
rptEncoding - The encoding for generating the report. The method JRCient.getSupportedEncodingNames(...) can be used to get the supported encoding names(same to java ecodings).
Returns:
a ViewerThread object. A report viewer frame is brought up by the ViewerThread.
Throws:
ParseParamValuesException - if a ParseParamValuesException occurs.
ParamCanceledException - if cancelled in the parameters dialog box.
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.
See Also:
JRClient.getAvailableLanguages(Frame, String)

view

public static ViewerThread view(java.awt.Frame frame,
                                java.lang.String rptURL,
                                java.util.Hashtable paramValues,
                                java.lang.String title,
                                java.lang.String wherePortion,
                                java.lang.String namedWherePortion,
                                java.lang.String whereClause,
                                java.lang.String dbUser,
                                java.lang.String dbPassword,
                                java.lang.String jdbcUrl,
                                java.lang.String jdbcDriver,
                                boolean jdbcGetSupportInfo,
                                java.lang.String rptLanguage,
                                java.lang.String rptCountry,
                                java.lang.String rptEncoding,
                                java.lang.String rptStyle)
                         throws ParseParamValuesException,
                                ParamCanceledException,
                                java.net.MalformedURLException,
                                java.io.IOException,
                                JRResponseException
Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).

Views a report with parameters.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - The Hashtable that contains the parameter values of the report. For each item in the Hashtable, the key is jrs.param$ + PARAMETER_NAME, and the value is the value of the parameter.
title - The title of the report viewer that will be brought up.
wherePortion - The WHERE Portion. The null value or empty string means that no WHERE portion is used.
namedWherePortion - The named WHERE Portion. The null value or empty string means that no named WHERE portion is used.
whereClause - The WHERE clause. Note: this parameter is not available at present.
dbUser - The database user ID for running the report.
dbPassword - The database passowrd for running the report.
jdbcUrl - The JDBC URL for running the report.
jdbcDriver - The JDBC driver for running the report.
jdbcGetSupportInfo - Specifies whether to re-get the JDBC support info for the new JDBC setting. The default value is "false".
rptLanguage - The language for generating the report. The method JRCient.getAvailableLanguages(...) can be used to get the available languages of the report.
rptCountry - The country for generating the report.
rptEncoding - The encoding for generating the report. The method JRCient.getSupportedEncodingNames(...) can be used to get the supported encoding names(same to java ecodings).
rptStyle - The style for generating the report. The method JRCient.getStyleGroupDisplayNames(...) can be used to get the supported style group.
Returns:
a ViewerThread object. A report viewer frame is brought up by the ViewerThread.
Throws:
ParseParamValuesException - if a ParseParamValuesException occurs.
ParamCanceledException - if cancelled in the parameters dialog box.
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.
See Also:
JRClient.getAvailableLanguages(Frame, String)

viewEx

public static ViewerThread viewEx(java.awt.Frame frame,
                                  java.lang.String rptURL,
                                  java.lang.String title,
                                  java.util.Hashtable viewProps)
                           throws ParseParamValuesException,
                                  ParamCanceledException,
                                  java.net.MalformedURLException,
                                  java.io.IOException,
                                  JRResponseException
Views a report with parameters.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
title - The title of the report viewer that will be brought up.
viewProps - A Hashtable which contains properties to run report. The properties can include values for the following keys:
Key Description of Associated Value.
APIConst.TAG_PARAM_VALUES The escaped string of the parameter values of the report. Format: parameter_NAME=VALUE,parameter_NAME=VALUE,...
Examples: "STARTDATE=1998-05-10,ENDDATE=1998-07-10" and "PTODAY=May 21\, 1998,TERMSDAYS=30"
APIConst.TAG_PARAM_FILE If the associated value is "true", the Hashtable viewProps contains the parameter values of the report. For each item in the viewProps, the key is jrs.param$ + PARAMETER_NAME, and the value is the value of the parameter.
APIConst.TAG_WHERE_PORTION The WHERE Portion. The null value or empty string means that no WHERE portion is used.
APIConst.TAG_NAMED_WHERE_PORTION The named WHERE Portion. The null value or empty string means that no named WHERE portion is used.
APIConst.TAG_WHERE_CLAUSE The WHERE clause. Note: this parameter is not available at present.
APIConst.TAG_DB_USER The database user ID for running the report.
APIConst.TAG_DB_PSWD The database passowrd for running the report.
APIConst.TAG_JDBC_URL The JDBC URL for running the report.
APIConst.TAG_JDBC_DRIVER The JDBC driver for running the report.
APIConst.TAG_JDBC_GET_SUPPORT_INFO Specifies whether to re-get the JDBC support info for the new JDBC setting. The default value is "false".
APIConst.TAG_REPORT_LANGUAGE The language for generating the report. The method JRCient.getAvailableLanguages(...) can be used to get the available languages of the report.
APIConst.TAG_REPORT_COUNTRY The country for generating the report. The method JRCient.getAvailableLanguages(...) can be used to get the available languages of the report.
APIConst.TAG_REPORT_ENCODING The encoding for generating the report. The method JRCient.getSupportedEncodingNames(...) can be used to get the supported encoding names(same to java ecodings).
APIConst.TAG_STYLE_GROUP The style for generating the report. The method JRCient.getStyleGroupDisplayNames(...) can be used to get the supported style group.
APIConst.TAG_REPORT The report name.
APIConst.TAG_CATALOG The catalog name.
APIConst.TAG_RPT_VERSION The report version number.
APIConst.TAG_CAT_VERSION The catalog version number.
Returns:
a ViewerThread object. A report viewer frame is brought up by the ViewerThread.
Throws:
ParseParamValuesException - if a ParseParamValuesException occurs.
ParamCanceledException - if cancelled in the parameters dialog box.
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.
See Also:
JRClient.getAvailableLanguages(Frame, String)

view

public static ViewerThread view(java.awt.Frame frame,
                                java.lang.String rptURL,
                                java.lang.String paramValues,
                                java.lang.String title,
                                java.lang.String wherePortion,
                                java.lang.String namedWherePortion,
                                java.lang.String whereClause,
                                java.lang.String dbUser,
                                java.lang.String dbPassword)
                         throws ParseParamValuesException,
                                ParamCanceledException,
                                java.net.MalformedURLException,
                                java.io.IOException,
                                JRResponseException
Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).

Views a report with parameters.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - The escaped string of the parameter values of the report. Format: parameter_NAME=VALUE,parameter_NAME=VALUE,... Examples: "STARTDATE=1998-05-10,ENDDATE=1998-07-10" and "PTODAY=May 21\, 1998,TERMSDAYS=30"
title - The title of the report viewer that will be brought up.
wherePortion - The WHERE Portion. The null value or empty string means that no WHERE portion is used.
namedWherePortion - The named WHERE Portion. The null value or empty string means that no named WHERE portion is used.
whereClause - The WHERE clause. Note: this parameter is not available at present.
dbUser - The database user ID for running the report.
dbPassword - The database passowrd for running the report.
Returns:
a ViewerThread object. A report viewer frame is brought up by the ViewerThread.
Throws:
ParseParamValuesException - if a ParseParamValuesException occurs.
ParamCanceledException - if cancelled in the parameters dialog box.
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.

view

public static ViewerThread view(java.awt.Frame frame,
                                java.lang.String rptURL,
                                java.lang.String paramValues,
                                java.lang.String title,
                                java.lang.String wherePortion,
                                java.lang.String namedWherePortion,
                                java.lang.String whereClause,
                                java.lang.String dbUser,
                                java.lang.String dbPassword,
                                java.lang.String jdbcUrl,
                                java.lang.String jdbcDriver,
                                java.lang.String rptLanguage,
                                java.lang.String rptEncoding)
                         throws ParseParamValuesException,
                                ParamCanceledException,
                                java.net.MalformedURLException,
                                java.io.IOException,
                                JRResponseException
Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).

Views a report with parameters.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - the escaped string of the parameter values of the report. Format: parameter_NAME=VALUE,parameter_NAME=VALUE,... Examples: "STARTDATE=1998-05-10,ENDDATE=1998-07-10" and "PTODAY=May 21\, 1998,TERMSDAYS=30"
title - The title of the report viewer that will be brought up.
wherePortion - The WHERE Portion. The null value or empty string means that no WHERE portion is used.
namedWherePortion - The named WHERE Portion. The null value or empty string means that no named WHERE portion is used.
whereClause - The WHERE clause. Note: this parameter is not available at present.
dbUser - The database user ID for running the report.
dbPassword - The database passowrd for running the report.
jdbcUrl - The JDBC URL for running the report.
jdbcDriver - The JDBC driver for running the report.
rptLanguage - The language for generating the report. The method JRCient.getAvailableLanguages(...) can be used to get the available languages of the report.
rptEncoding - The encoding for generating the report. The method JRCient.getSupportedEncodingNames(...) can be used to get the supported encoding names(same to java ecodings).
Returns:
a ViewerThread object. A report viewer frame is brought up by the ViewerThread.
Throws:
ParseParamValuesException - if a ParseParamValuesException occurs.
ParamCanceledException - if cancelled in the parameters dialog box.
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.
See Also:
JRClient.getAvailableLanguages(Frame, String)

view

public static ViewerThread view(java.awt.Frame frame,
                                java.lang.String rptURL,
                                java.lang.String paramValues,
                                java.lang.String title,
                                java.lang.String wherePortion,
                                java.lang.String namedWherePortion,
                                java.lang.String whereClause,
                                java.lang.String dbUser,
                                java.lang.String dbPassword,
                                java.lang.String jdbcUrl,
                                java.lang.String jdbcDriver,
                                boolean jdbcGetSupportInfo,
                                java.lang.String rptLanguage,
                                java.lang.String rptEncoding)
                         throws ParseParamValuesException,
                                ParamCanceledException,
                                java.net.MalformedURLException,
                                java.io.IOException,
                                JRResponseException
Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).

Views a report with parameters.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - the escaped string of the parameter values of the report. Format: parameter_NAME=VALUE,parameter_NAME=VALUE,... Examples: "STARTDATE=1998-05-10,ENDDATE=1998-07-10" and "PTODAY=May 21\, 1998,TERMSDAYS=30"
title - The title of the report viewer that will be brought up.
wherePortion - The WHERE Portion. The null value or empty string means that no WHERE portion is used.
namedWherePortion - The named WHERE Portion. The null value or empty string means that no named WHERE portion is used.
whereClause - The WHERE clause. Note: this parameter is not available at present.
dbUser - The database user ID for running the report.
dbPassword - The database passowrd for running the report.
jdbcUrl - The JDBC URL for running the report.
jdbcDriver - The JDBC driver for running the report.
jdbcGetSupportInfo - Specifies whether to re-get the JDBC support info for the new JDBC setting. The default value is "false".
rptLanguage - The language for generating the report. The method JRCient.getAvailableLanguages(...) can be used to get the available languages of the report.
rptEncoding - The encoding for generating the report. The method JRCient.getSupportedEncodingNames(...) can be used to get the supported encoding names(same to java ecodings).
Returns:
a ViewerThread object. A report viewer frame is brought up by the ViewerThread.
Throws:
ParseParamValuesException - if a ParseParamValuesException occurs.
ParamCanceledException - if cancelled in the parameters dialog box.
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.
See Also:
JRClient.getAvailableLanguages(Frame, String)

view

public static ViewerThread view(java.awt.Frame frame,
                                java.lang.String rptURL,
                                java.lang.String paramValues,
                                java.lang.String title,
                                java.lang.String wherePortion,
                                java.lang.String namedWherePortion,
                                java.lang.String whereClause,
                                java.lang.String dbUser,
                                java.lang.String dbPassword,
                                java.lang.String jdbcUrl,
                                java.lang.String jdbcDriver,
                                boolean jdbcGetSupportInfo,
                                java.lang.String rptLanguage,
                                java.lang.String rptEncoding,
                                java.lang.String rptStyle)
                         throws ParseParamValuesException,
                                ParamCanceledException,
                                java.net.MalformedURLException,
                                java.io.IOException,
                                JRResponseException
Deprecated. As for version 6, it is replaced by viewEx(Frame, String, String, Hashtable).

Views a report with parameters.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - the escaped string of the parameter values of the report. Format: parameter_NAME=VALUE,parameter_NAME=VALUE,... Examples: "STARTDATE=1998-05-10,ENDDATE=1998-07-10" and "PTODAY=May 21\, 1998,TERMSDAYS=30"
title - The title of the report viewer that will be brought up.
wherePortion - The WHERE Portion. The null value or empty string means that no WHERE portion is used.
namedWherePortion - The named WHERE Portion. The null value or empty string means that no named WHERE portion is used.
whereClause - The WHERE clause. Note: this parameter is not available at present.
dbUser - The database user ID for running the report.
dbPassword - The database passowrd for running the report.
jdbcUrl - The JDBC URL for running the report.
jdbcDriver - The JDBC driver for running the report.
jdbcGetSupportInfo - Specifies whether to re-get the JDBC support info for the new JDBC setting. The default value is "false".
rptLanguage - The language for generating the report. The method JRCient.getAvailableLanguages(...) can be used to get the available languages of the report.
rptEncoding - The encoding for generating the report. The method JRCient.getSupportedEncodingNames(...) can be used to get the supported encoding names(same to java ecodings).
rptStyle - The style for generating the report. The method JRCient.getStyleGroupDisplayNames(...) can be used to get the supported style group.
Returns:
a ViewerThread object. A report viewer frame is brought up by the ViewerThread.
Throws:
ParseParamValuesException - if a ParseParamValuesException occurs.
ParamCanceledException - if cancelled in the parameters dialog box.
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.
See Also:
JRClient.getAvailableLanguages(Frame, String)

viewTempResult

public static ViewerThread viewTempResult(java.lang.String rptUrl,
                                          java.lang.String rst,
                                          java.lang.String title)
Views a report result. The result name is returned by calling sendCmdRunAndView(...).

Parameters:
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
rst - The report result name in a report server. The result name is returned by calling sendCmdRunAndView(...).
title - The title of the report viewer that will be brought up.
Returns:
a ViewerThread object. A report viewer frame is brought up by the ViewerThread.

viewTempResult

public static ViewerThread viewTempResult(java.lang.String rptUrl,
                                          java.lang.String rst,
                                          java.lang.String sheet,
                                          java.lang.String title,
                                          long duration)
Views a report result. The result name is returned by calling sendCmdRunAndView(...).

Parameters:
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
rst - The report result name in a report server. The result name is returned by calling sendCmdRunAndView(...).
sheet - The report sheet name
title - The title of the report viewer that will be brought up.
duration - Specifies how long the view frame is shown.
Returns:
a ViewerThread object. A report viewer frame is brought up by the ViewerThread.

viewResult

public static ViewerThread viewResult(java.lang.String resultURL,
                                      java.lang.String title)
Views a result in a report server.
 The result URL should be like this: 
     http://localhost:8888/jserver/publish_site/report_results/invoice_1.rst.
 

Parameters:
resultURL - The url string of the result file in a report server.
 For example, 
     http://localhost:8888/jserver/publish_site/report_results/invoice_1.rst.
 
title - The title of the result viewer that will be brought up.
Returns:
a ViewerThread object. A result viewer frame is brought up by the ViewerThread.

viewLocalResult

public static ViewerThread viewLocalResult(java.lang.String resultFile,
                                           java.lang.String title)
Views a local result file.
 The result URL like this: 
     http://localhost:8888/jserver/publish_site/report_results/invoice_1.rst.
 

Parameters:
resultFile - The local result file.
 For example, 
     c:\results\invoice_1.rst.
 
title - The title of the result viewer that will be brought up.
Returns:
a ViewerThread object. A result viewer frame is brought up by the ViewerThread.

viewResultVersion

public static ViewerThread viewResultVersion(java.lang.String rptUrl,
                                             java.lang.String resultVersion,
                                             java.lang.String title)
Views a report result version. The result version name can be got from getResultFilename() of VersionRecord. The VersionRecord list of a report can be got from the method getVersionList(...) of this class.

Parameters:
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
resultVersion - The result version name can be got from getResultFilename() of VersionRecord. The VersionRecord list of a report can be got from the method getVersionList(...) of this class.
title - The title of the report viewer that will be brought up.
Returns:
a ViewerThread object. A report viewer frame is brought up by the ViewerThread.

viewResultVersion

public static ViewerThread viewResultVersion(java.lang.String rptUrl,
                                             java.lang.String resultVersion,
                                             java.lang.String title,
                                             java.lang.String sheet)
Views a report result version. The result version name can be got from getResultFilename() of VersionRecord. The VersionRecord list of a report can be got from the method getVersionList(...) of this class.

Parameters:
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
resultVersion - The result version name can be got from getResultFilename() of VersionRecord. The VersionRecord list of a report can be got from the method getVersionList(...) of this class.
sheet - The report sheet name.
title - The title of the report viewer that will be brought up.
Returns:
a ViewerThread object. A report viewer frame is brought up by the ViewerThread.

createViewResultThread

public static ViewerThread createViewResultThread(java.awt.Frame frame,
                                                  java.lang.String rptURL,
                                                  java.util.Hashtable paramValues,
                                                  java.lang.String title)
                                           throws java.net.MalformedURLException,
                                                  java.io.IOException,
                                                  JRResponseException
Deprecated. As for version 6, it is replaced by createViewResultThreadEx(Frame, String, String, Hashtable).

Creates a ViewerThread to view a new result of a report with parameters. The start() of the ViewerThread can be called to bring up a report viewer.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - The Hashtable that contains the parameter values of the report. For each item in the Hashtable, the key is jrs.param$ + PARAMETER_NAME, and the value is the value of the parameter.
title - The title of the report viewer that will be brought up.
Returns:
a ViewerThread object. The start() of the ViewerThread can be called to bring up a report viewer.
Throws:
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.

createViewResultThread

public static ViewerThread createViewResultThread(java.awt.Frame frame,
                                                  java.lang.String rptURL,
                                                  java.util.Hashtable paramValues,
                                                  java.lang.String title,
                                                  java.lang.String dbUser,
                                                  java.lang.String dbPassword)
                                           throws java.net.MalformedURLException,
                                                  java.io.IOException,
                                                  JRResponseException
Deprecated. As for version 6, it is replaced by createViewResultThreadEx(Frame, String, String, Hashtable).

Creates a ViewerThread to view a new result of a report with parameters. The start() of the ViewerThread can be called to bring up a report viewer.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - The Hashtable that contains the parameter values of the report. For each item in the Hashtable, the key is jrs.param$ + PARAMETER_NAME, and the value is the value of the parameter.
title - The title of the report viewer that will be brought up.
dbUser - The database user ID for running the report.
dbPassword - The database passowrd for running the report.
Returns:
a ViewerThread object. The start() of the ViewerThread can be called to bring up a report viewer.
Throws:
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.

createViewResultThread

public static ViewerThread createViewResultThread(java.awt.Frame frame,
                                                  java.lang.String rptURL,
                                                  java.util.Hashtable paramValues,
                                                  java.lang.String title,
                                                  java.lang.String wherePortion,
                                                  java.lang.String namedWherePortion,
                                                  java.lang.String whereClause,
                                                  java.lang.String dbUser,
                                                  java.lang.String dbPassword)
                                           throws java.net.MalformedURLException,
                                                  java.io.IOException,
                                                  JRResponseException
Deprecated. As for version 6, it is replaced by createViewResultThreadEx(Frame, String, String, Hashtable).

Creates a ViewerThread to view a new result of a report with parameters. The start() of the ViewerThread can be called to bring up a report viewer.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - The Hashtable that contains the parameter values of the report. For each item in the Hashtable, the key is jrs.param$ + PARAMETER_NAME, and the value is the value of the parameter.
title - The title of the report viewer that will be brought up.
wherePortion - The WHERE Portion. The null value or empty string means that no WHERE portion is used.
namedWherePortion - The named WHERE Portion. The null value or empty string means that no named WHERE portion is used.
whereClause - The WHERE clause. Note: this parameter is not available at present.
dbUser - The database user ID for running the report.
dbPassword - The database passowrd for running the report.
Returns:
a ViewerThread object. The start() of the ViewerThread can be called to bring up a report viewer.
Throws:
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.

createViewResultThread

public static ViewerThread createViewResultThread(java.awt.Frame frame,
                                                  java.lang.String rptURL,
                                                  java.util.Hashtable paramValues,
                                                  java.lang.String title,
                                                  java.lang.String wherePortion,
                                                  java.lang.String namedWherePortion,
                                                  java.lang.String whereClause,
                                                  java.lang.String dbUser,
                                                  java.lang.String dbPassword,
                                                  java.lang.String rptLanguage,
                                                  java.lang.String rptEncoding)
                                           throws java.net.MalformedURLException,
                                                  java.io.IOException,
                                                  JRResponseException
Deprecated. As for version 6, it is replaced by createViewResultThreadEx(Frame, String, String, Hashtable).

Creates a ViewerThread to view a new result of a report with parameters. The start() of the ViewerThread can be called to bring up a report viewer.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - The Hashtable that contains the parameter values of the report. For each item in the Hashtable, the key is jrs.param$ + PARAMETER_NAME, and the value is the value of the parameter.
title - The title of the report viewer that will be brought up.
wherePortion - The WHERE Portion. The null value or empty string means that no WHERE portion is used.
namedWherePortion - The named WHERE Portion. The null value or empty string means that no named WHERE portion is used.
whereClause - The WHERE clause. Note: this parameter is not available at present.
dbUser - The database user ID for running the report.
dbPassword - The database passowrd for running the report.
rptLanguage - The language for generating the report. The method JRCient.getAvailableLanguages(...) can be used to get the available languages of the report.
rptEncoding - The encoding for generating the report. The method JRCient.getSupportedEncodingNames(...) can be used to get the supported encoding names(same to java ecodings).
Returns:
a ViewerThread object. The start() of the ViewerThread can be called to bring up a report viewer.
Throws:
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.
See Also:
JRClient.getAvailableLanguages(Frame, String)

createViewResultThread

public static ViewerThread createViewResultThread(java.awt.Frame frame,
                                                  java.lang.String rptURL,
                                                  java.util.Hashtable paramValues,
                                                  java.lang.String title,
                                                  java.lang.String wherePortion,
                                                  java.lang.String namedWherePortion,
                                                  java.lang.String whereClause,
                                                  java.lang.String dbUser,
                                                  java.lang.String dbPassword,
                                                  java.lang.String jdbcUrl,
                                                  java.lang.String jdbcDriver,
                                                  java.lang.String rptLanguage,
                                                  java.lang.String rptEncoding)
                                           throws java.net.MalformedURLException,
                                                  java.io.IOException,
                                                  JRResponseException
Deprecated. As for version 6, it is replaced by createViewResultThreadEx(Frame, String, String, Hashtable).

Creates a ViewerThread to view a new result of a report with parameters. The start() of the ViewerThread can be called to bring up a report viewer.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - The Hashtable that contains the parameter values of the report. For each item in the Hashtable, the key is jrs.param$ + PARAMETER_NAME, and the value is the value of the parameter.
title - The title of the report viewer that will be brought up.
wherePortion - The WHERE Portion. The null value or empty string means that no WHERE portion is used.
namedWherePortion - The named WHERE Portion. The null value or empty string means that no named WHERE portion is used.
whereClause - The WHERE clause. Note: this parameter is not available at present.
dbUser - The database user ID for running the report.
dbPassword - The database passowrd for running the report.
jdbcUrl - The JDBC URL for running the report.
jdbcDriver - The JDBC driver for running the report.
rptLanguage - The language for generating the report. The method JRCient.getAvailableLanguages(...) can be used to get the available languages of the report.
rptEncoding - The encoding for generating the report. The method JRCient.getSupportedEncodingNames(...) can be used to get the supported encoding names(same to java ecodings).
Returns:
a ViewerThread object. The start() of the ViewerThread can be called to bring up a report viewer.
Throws:
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.
See Also:
JRClient.getAvailableLanguages(Frame, String)

createViewResultThread

public static ViewerThread createViewResultThread(java.awt.Frame frame,
                                                  java.lang.String rptURL,
                                                  java.util.Hashtable paramValues,
                                                  java.lang.String title,
                                                  java.lang.String wherePortion,
                                                  java.lang.String namedWherePortion,
                                                  java.lang.String whereClause,
                                                  java.lang.String dbUser,
                                                  java.lang.String dbPassword,
                                                  java.lang.String jdbcUrl,
                                                  java.lang.String jdbcDriver,
                                                  boolean jdbcGetSupportInfo,
                                                  java.lang.String rptLanguage,
                                                  java.lang.String rptEncoding)
                                           throws java.net.MalformedURLException,
                                                  java.io.IOException,
                                                  JRResponseException
Deprecated. As for version 6, it is replaced by createViewResultThreadEx(Frame, String, String, Hashtable).

Creates a ViewerThread to view a new result of a report with parameters. The start() of the ViewerThread can be called to bring up a report viewer.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - The Hashtable that contains the parameter values of the report. For each item in the Hashtable, the key is jrs.param$ + PARAMETER_NAME, and the value is the value of the parameter.
title - The title of the report viewer that will be brought up.
wherePortion - The WHERE Portion. The null value or empty string means that no WHERE portion is used.
namedWherePortion - The named WHERE Portion. The null value or empty string means that no named WHERE portion is used.
whereClause - The WHERE clause. Note: this parameter is not available at present.
dbUser - The database user ID for running the report.
dbPassword - The database passowrd for running the report.
jdbcUrl - The JDBC URL for running the report.
jdbcDriver - The JDBC driver for running the report.
jdbcGetSupportInfo - Specifies whether to re-get the JDBC support info for the new JDBC setting. The default value is "false".
rptLanguage - The language for generating the report. The method JRCient.getAvailableLanguages(...) can be used to get the available languages of the report.
rptEncoding - The encoding for generating the report. The method JRCient.getSupportedEncodingNames(...) can be used to get the supported encoding names(same to java ecodings).
Returns:
a ViewerThread object. The start() of the ViewerThread can be called to bring up a report viewer.
Throws:
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.
See Also:
JRClient.getAvailableLanguages(Frame, String)

createViewResultThread

public static ViewerThread createViewResultThread(java.awt.Frame frame,
                                                  java.lang.String rptURL,
                                                  java.util.Hashtable paramValues,
                                                  java.lang.String title,
                                                  java.lang.String wherePortion,
                                                  java.lang.String namedWherePortion,
                                                  java.lang.String whereClause,
                                                  java.lang.String dbUser,
                                                  java.lang.String dbPassword,
                                                  java.lang.String jdbcUrl,
                                                  java.lang.String jdbcDriver,
                                                  boolean jdbcGetSupportInfo,
                                                  java.lang.String rptLanguage,
                                                  java.lang.String rptCountry,
                                                  java.lang.String rptEncoding,
                                                  java.lang.String rptStyle)
                                           throws java.net.MalformedURLException,
                                                  java.io.IOException,
                                                  JRResponseException
Deprecated. As for version 6, it is replaced by createViewResultThreadEx(Frame, String, String, Hashtable).

Creates a ViewerThread to view a new result of a report with parameters. The start() of the ViewerThread can be called to bring up a report viewer.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - The Hashtable that contains the parameter values of the report. For each item in the Hashtable, the key is jrs.param$ + PARAMETER_NAME, and the value is the value of the parameter.
title - The title of the report viewer that will be brought up.
wherePortion - The WHERE Portion. The null value or empty string means that no WHERE portion is used.
namedWherePortion - The named WHERE Portion. The null value or empty string means that no named WHERE portion is used.
whereClause - The WHERE clause. Note: this parameter is not available at present.
dbUser - The database user ID for running the report.
dbPassword - The database passowrd for running the report.
jdbcUrl - The JDBC URL for running the report.
jdbcDriver - The JDBC driver for running the report.
jdbcGetSupportInfo - Specifies whether to re-get the JDBC support info for the new JDBC setting. The default value is "false".
rptLanguage - The language for generating the report. The method JRCient.getAvailableLanguages(...) can be used to get the available languages of the report.
rptCountry - the country for generating the report.
rptEncoding - The encoding for generating the report. The method JRCient.getSupportedEncodingNames(...) can be used to get the supported encoding names(same to java ecodings).
rptStyle - The style for generating the report. The method JRCient.getStyleGroupDisplayNames(...) can be used to get the supported style group.
Returns:
a ViewerThread object. The start() of the ViewerThread can be called to bring up a report viewer.
Throws:
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.
See Also:
JRClient.getAvailableLanguages(Frame, String)

createViewResultThreadEx

public static ViewerThread createViewResultThreadEx(java.awt.Frame frame,
                                                    java.lang.String rptURL,
                                                    java.lang.String title,
                                                    java.util.Hashtable viewProps)
                                             throws java.net.MalformedURLException,
                                                    java.io.IOException,
                                                    JRResponseException
Creates a ViewerThread to view a new result of a report with parameters. The start() of the ViewerThread can be called to bring up a report viewer.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
title - The title of the report viewer that will be brought up.
viewProps - a Hashtable which contains properties to run report. the properties can include values for following keys:
Key Description of Associated Value.
APIConst.TAG_PARAM_VALUES The escaped string of the parameter values of the report. Format: parameter_NAME=VALUE,parameter_NAME=VALUE,...
Examples: "STARTDATE=1998-05-10,ENDDATE=1998-07-10" and "PTODAY=May 21\, 1998,TERMSDAYS=30"
APIConst.TAG_PARAM_FILE If associated value is "true", the Hashtable viewProps contains the parameter values of the report. For each item in the viewProps, the key is jrs.param$ + PARAMETER_NAME, and the value is the value of the parameter.
APIConst.TAG_WHERE_PORTION The WHERE Portion. The null value or empty string means that no WHERE portion is used.
APIConst.TAG_NAMED_WHERE_PORTION The named WHERE Portion. The null value or empty string means that no named WHERE portion is used.
APIConst.TAG_WHERE_CLAUSE The WHERE clause. Note: this parameter is not available at present.
APIConst.TAG_DB_USER The database user ID for running the report.
APIConst.TAG_DB_PSWD The database passowrd for running the report.
APIConst.TAG_JDBC_URL The JDBC URL for running the report.
APIConst.TAG_JDBC_DRIVER The JDBC driver for running the report.
APIConst.TAG_JDBC_GET_SUPPORT_INFO Specifies whether to re-get the JDBC support info for the new JDBC setting. The default value is "false".
APIConst.TAG_REPORT_LANGUAGE The language for generating the report. The method JRCient.getAvailableLanguages(...) can be used to get the available languages of the report.
APIConst.TAG_REPORT_COUNTRY The country for generating the report. The method JRCient.getAvailableLanguages(...) can be used to get the available languages of the report.
APIConst.TAG_REPORT_ENCODING The encoding for generating the report. The method JRCient.getSupportedEncodingNames(...) can be used to get the supported encoding names(same to java ecodings).
APIConst.TAG_STYLE_GROUP The style for generating the report. The method JRCient.getStyleGroupDisplayNames(...) can be used to get the supported style group.
Returns:
a ViewerThread object. The start() of the ViewerThread can be called to bring up a report viewer.
Throws:
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.
See Also:
JRClient.getAvailableLanguages(Frame, String)

createViewResultThread

public static ViewerThread createViewResultThread(java.awt.Frame frame,
                                                  java.lang.String rptURL,
                                                  java.lang.String paramValues,
                                                  java.lang.String title,
                                                  java.lang.String wherePortion,
                                                  java.lang.String namedWherePortion,
                                                  java.lang.String whereClause,
                                                  java.lang.String dbUser,
                                                  java.lang.String dbPassword)
                                           throws java.net.MalformedURLException,
                                                  java.io.IOException,
                                                  JRResponseException
Deprecated. As for version 6, it is replaced by createViewResultThreadEx(Frame, String, String, Hashtable).

Creates a ViewerThread to view a new result of a report with parameters. The start() of the ViewerThread can be called to bring up a report viewer.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - the escaped string of the parameter values of the report. Format: parameter_NAME=VALUE,parameter_NAME=VALUE,... Examples: "STARTDATE=1998-05-10,ENDDATE=1998-07-10" and "PTODAY=May 21\, 1998,TERMSDAYS=30"
title - The title of the report viewer that will be brought up.
wherePortion - The WHERE Portion. The null value or empty string means that no WHERE portion is used.
namedWherePortion - The named WHERE Portion. The null value or empty string means that no named WHERE portion is used.
whereClause - The WHERE clause. Note: this parameter is not available at present.
dbUser - The database user ID for running the report.
dbPassword - The database passowrd for running the report.
Returns:
a ViewerThread object. The start() of the ViewerThread can be called to bring up a report viewer.
Throws:
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.

createViewResultThread

public static ViewerThread createViewResultThread(java.awt.Frame frame,
                                                  java.lang.String rptURL,
                                                  java.lang.String paramValues,
                                                  java.lang.String title,
                                                  java.lang.String wherePortion,
                                                  java.lang.String namedWherePortion,
                                                  java.lang.String whereClause,
                                                  java.lang.String dbUser,
                                                  java.lang.String dbPassword,
                                                  java.lang.String rptLanguage,
                                                  java.lang.String rptEncoding)
                                           throws java.net.MalformedURLException,
                                                  java.io.IOException,
                                                  JRResponseException
Deprecated. As for version 6, it is replaced by createViewResultThreadEx(Frame, String, String, Hashtable).

Creates a ViewerThread to view a new result of a report with parameters. The start() of the ViewerThread can be called to bring up a report viewer.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - the escaped string of the parameter values of the report. Format: parameter_NAME=VALUE,parameter_NAME=VALUE,... Examples: "STARTDATE=1998-05-10,ENDDATE=1998-07-10" and "PTODAY=May 21\, 1998,TERMSDAYS=30"
title - The title of the report viewer that will be brought up.
wherePortion - The WHERE Portion. The null value or empty string means that no WHERE portion is used.
namedWherePortion - The named WHERE Portion. The null value or empty string means that no named WHERE portion is used.
whereClause - The WHERE clause. Note: this parameter is not available at present.
dbUser - The database user ID for running the report.
dbPassword - The database passowrd for running the report.
rptLanguage - The language for generating the report. The method JRCient.getAvailableLanguages(...) can be used to get the available languages of the report.
rptEncoding - The encoding for generating the report. The method JRCient.getSupportedEncodingNames(...) can be used to get the supported encoding names(same to java ecodings).
Returns:
a ViewerThread object. The start() of the ViewerThread can be called to bring up a report viewer.
Throws:
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.
See Also:
JRClient.getAvailableLanguages(Frame, String)

createViewResultThread

public static ViewerThread createViewResultThread(java.lang.String rptURL,
                                                  java.lang.String rst,
                                                  java.lang.String title)
Creates a ViewerThread to view a temp result of a report. The result name is returned by calling sendCmdRunAndView(...). The start() of the ViewerThread can be called to bring up a report viewer.

Parameters:
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
rst - The temp result name of the report in the report server. The result name is returned by calling sendCmdRunAndView(...).
title - The title of the report viewer that will be brought up.
Returns:
a ViewerThread object. The start() of the ViewerThread can be called to bring up a report viewer.

createViewResultThread

public static ViewerThread createViewResultThread(java.lang.String rptURL,
                                                  java.lang.String rst,
                                                  java.lang.String sheet,
                                                  java.lang.String title)
Creates a ViewerThread to view a temp result of a report. The result name is returned by calling sendCmdRunAndView(...). The start() of the ViewerThread can be called to bring up a report viewer.

Parameters:
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
rst - The temp result name of the report in the report server. The result name is returned by calling sendCmdRunAndView(...).
sheet - The report sheet name.
title - The title of the report viewer that will be brought up.
Returns:
a ViewerThread object. The start() of the ViewerThread can be called to bring up a report viewer.

createViewResultThread

public static ViewerThread createViewResultThread(java.lang.String result,
                                                  java.lang.String title)
Creates a ViewerThread to view a result file in a report server or a local result file. The start() of the ViewerThread can be called to bring up a result viewer.
 The result URL like this: 
     http://localhost:8888/jserver/publish_site/report_results/invoice_1.rst.
 

Parameters:
result - The url string of the result file in a report server or a local result file.
 For example, 
     http://localhost:8888/jserver/publish_site/report_results/invoice_1.rst
 or  c:\results\invoice_1.rst.
 
title - The title of the result viewer that will be brought up.
Returns:
a ViewerThread object. The start() of the ViewerThread can be called to bring up a result viewer.

createViewVersionThread

public static ViewerThread createViewVersionThread(java.lang.String rptURL,
                                                   java.lang.String versionResult,
                                                   java.lang.String title)
Creates a ViewerThread to view a report result version. The result version name can be got from getResultFilename() of VersionRecord. The VersionRecord list of a report can be got from the method getVersionList(...) of this class.

Parameters:
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
versionResult - The result version name can be got from getResultFilename() of VersionRecord. The VersionRecord list of a report can be got from the method getVersionList(...) of this class.
title - The title of the report viewer that will be brought up.
Returns:
a ViewerThread object. The start() of the ViewerThread can be called to bring up a report viewer.

createViewVersionThread

public static ViewerThread createViewVersionThread(java.lang.String rptURL,
                                                   java.lang.String versionResult,
                                                   java.lang.String title,
                                                   java.lang.String sheet)
Creates a ViewerThread to view a report result version. The result version name can be got from getResultFilename() of VersionRecord. The VersionRecord list of a report can be got from the method getVersionList(...) of this class.

Parameters:
rptURL - The url string of the report in a report server, for example, http://localhost:8888/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
versionResult - The result version name can be got from getResultFilename() of VersionRecord. The VersionRecord list of a report can be got from the method getVersionList(...) of this class.
title - The title of the report viewer that will be brought up.
sheet - The report sheet name.
Returns:
a ViewerThread object. The start() of the ViewerThread can be called to bring up a report viewer.

getVersionListDialog

public static java.awt.Dialog getVersionListDialog(java.awt.Frame frame,
                                                   java.lang.String rptURL,
                                                   java.lang.String title)
                                            throws jet.cs.InvalidReportURLException,
                                                   java.io.IOException,
                                                   JRResponseException
Deprecated. As of Version 6.0, replaced by getVersionListDialog(Frame, String, Hashtable, String, String, boolean)

Creates a result version list dialog box to view result versions, new result or create new schedules for this report. This is a modal dialog box.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
title - The title of the dialog box.
Returns:
a dialog box. This is a modal dialog box.
Throws:
jet.cs.InvalidReportURLException - if a InvalidReportURLException occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.

getVersionListDialog

public static java.awt.Dialog getVersionListDialog(java.awt.Frame frame,
                                                   java.lang.String rptURL,
                                                   java.lang.String title,
                                                   boolean isModal)
                                            throws jet.cs.InvalidReportURLException,
                                                   java.io.IOException,
                                                   JRResponseException
Deprecated. As of Version 6.0, replaced by getVersionListDialog(Frame, String, Hashtable, String, String, boolean)

Creates a result version list dialog box to view result versions, new result or create new schedules for this report.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
title - The title of the dialog box.
isModal - if the dialog box is modal.
Returns:
a dialog box. This is a modal/modaless dialog box.
Throws:
jet.cs.InvalidReportURLException - if a InvalidReportURLException occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.

getVersionListDialog

public static java.awt.Dialog getVersionListDialog(java.awt.Frame frame,
                                                   java.lang.String rptURL,
                                                   java.util.Hashtable paramValues,
                                                   java.lang.String title,
                                                   boolean isModal)
                                            throws jet.cs.InvalidReportURLException,
                                                   java.io.IOException,
                                                   JRResponseException
Deprecated. As of Version 6.0, replaced by getVersionListDialog(Frame, String, Hashtable, String, String, boolean)

Creates a result version list dialog box to view result versions, new result or create new schedules for this report.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will still be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
paramValues - The Hashtable that contains the parameter values of the report. For each item in the Hashtable, the key is jrs.param$ + PARAMETER_NAME, and the value is the value of the parameter.
title - The title of the dialog box.
isModal - Specifies if the dialog box is modal.
Returns:
a dialog box. This is a modal/modaless dialog box.
Throws:
jet.cs.InvalidReportURLException - if a InvalidReportURLException occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.

getVersionListDialog

public static java.awt.Dialog getVersionListDialog(java.awt.Frame frame,
                                                   java.lang.String rptURL,
                                                   java.util.Hashtable paramValues,
                                                   java.lang.String title,
                                                   java.lang.String catName,
                                                   boolean isModal)
                                            throws jet.cs.InvalidReportURLException,
                                                   java.io.IOException,
                                                   JRResponseException
Creates a result version list dialog box to view result versions, new result or create new schedules for this report.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/SampleReports/SampleReports.cat/CustomerAnalysis.cls
paramValues - The Hashtable that contains the parameter values of the report. For each item in the Hashtable, the key is jrs.param$ + PARAMETER_NAME, and the value is the value of the parameter.
title - The title of the dialog box.
                        For example, /SampleReports/CustomerAnalysis.cls.
                                        
 
catName - The full catalog path.
                        For example, /SampleReports/Tutorial.cat.
 
isModal - Soecifies if the dialog box is modal.
Returns:
a dialog box. This is a modal/modaless dialog box.
Throws:
jet.cs.InvalidReportURLException - if a InvalidReportURLException occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.

getScheduledListPanel

public static TaskListHolder getScheduledListPanel(java.awt.Frame frame,
                                                   java.lang.String jrsvrURL)
Returns a TaskListHolder to browse scheduled tasks.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
jrsvrURL - The URL string of the JRServlet, for example, http://localhost:8888/jrserver/.
Returns:
the TaskListHolder to browse scheduled tasks.

getNewScheduledDlg

public static ScheduledDlg getNewScheduledDlg(java.awt.Frame frame,
                                              java.lang.String jrsvrURL,
                                              java.lang.String title)
Returns a dialog box to create a scheduled task.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
jrsvrURL - The URL string of the JRServlet, for example, http://localhost:8888/jrserver.
title - The title of the dialog box.
Returns:
the ScheduledDlg object.

getNewScheduledDlgForReport

public static ScheduledDlg getNewScheduledDlgForReport(java.awt.Frame frame,
                                                       java.lang.String rptURL,
                                                       java.lang.String title)
Returns a dialog box to create a scheduled task for a report.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jrserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
title - The title of the dialog box.
Returns:
the ScheduledDlg object.

getNewScheduledDlgForReport

public static ScheduledDlg getNewScheduledDlgForReport(java.awt.Frame frame,
                                                       java.lang.String rptURL,
                                                       java.lang.String title,
                                                       java.lang.String dbUser,
                                                       java.lang.String dbPassword)
Returns a dialog box to create a scheduled task for a report.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jrserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
title - The title of the dialog box.
dbUser - The database user ID for running the report.
dbPassword - The database passowrd for running the report.
Returns:
the ScheduledDlg object.

getNewScheduledDlgForReport

public static ScheduledDlg getNewScheduledDlgForReport(java.awt.Frame frame,
                                                       java.lang.String rptURL,
                                                       java.lang.String title,
                                                       java.lang.String dbUser,
                                                       java.lang.String dbPassword,
                                                       java.lang.String rptLanguage,
                                                       java.lang.String rptEncoding)
Returns a dialog box to create a scheduled task for a report.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jrserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
rptLanguage - The language for generating the report. The method JRCient.getAvailableLanguages(...) can be used to get the available languages of the report.
rptEncoding - The encoding for generating the report. The method JRCient.getSupportedEncodingNames(...) can be used to get the supported encoding names(same to java ecodings).
title - The title of the dialog box.
dbUser - The database user ID for running the report.
dbPassword - The database passowrd for running the report.
Returns:
the ScheduledDlg object.

getNewScheduledDlgForReport

public static ScheduledDlg getNewScheduledDlgForReport(java.awt.Frame frame,
                                                       java.lang.String rptURL,
                                                       java.lang.String title,
                                                       java.lang.String dbUser,
                                                       java.lang.String dbPassword,
                                                       java.lang.String rptLanguage,
                                                       java.lang.String rptCountry,
                                                       java.lang.String rptEncoding,
                                                       java.lang.String rptStyle)
Returns a dialog box to create a scheduled task for a report.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jrserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
rptLanguage - The language for generating the report. The method JRCient.getAvailableLanguages(...) can be used to get the available languages of the report.
rptCountry - The country for generating the report.
rptEncoding - The encoding for generating the report. The method JRCient.getSupportedEncodingNames(...) can be used to get the supported encoding names(same to java ecodings).
rptStyle - The style for generating the report. The method JRCient.getStyleGroupDisplayNames(...) can be used to get the supported style group.
title - The title of the dialog box.
dbUser - The database user ID for running the report.
dbPassword - The database passowrd for running the report.
Returns:
the ScheduledDlg object.

getNewScheduledDlgForReport

public static ScheduledDlg getNewScheduledDlgForReport(java.awt.Frame frame,
                                                       java.lang.String rptURL,
                                                       java.lang.String title,
                                                       java.util.Hashtable prop)
Returns a dialog box to create a scheduled task for a report.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
rptURL - The url string of the report in a report server, for example, http://localhost:8888/jrserver/SampleReports/SampleReports.cat/CustomerAnalysis.cls.
title - The title of the dialog box.
prop - Contains schedule information.
Returns:
the ScheduledDlg object.

getEditScheduledDlg

public static ScheduledDlg getEditScheduledDlg(java.awt.Frame frame,
                                               java.lang.String jrsvrURL,
                                               java.util.Hashtable scheduledTask,
                                               java.lang.String title)
Returns a dialog box to edit a scheduled task.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
jrsvrURL - The URL string of the JRServlet, for example, http://localhost:8888/jrserver.
title - The title of the dialog box.
scheduledTask - The scheduled task.
Returns:
the ScheduledDlg object.
See Also:
JRClient.getScheduled(Frame, String)

getActiveListPanel

public static TaskListHolder getActiveListPanel(java.awt.Frame frame,
                                                java.lang.String jrsvrURL)
Returns a TaskListHolder to browse the active tasks.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
jrsvrURL - The URL string of the JRServlet, for example, http://localhost:8888/jserver.
Returns:
the TaskListHolder to browse the active tasks.

getCompletedListPanel

public static TaskListHolder getCompletedListPanel(java.awt.Frame frame,
                                                   java.lang.String jrsvrURL)
Returns a TaskListHolder to browse the completed tasks.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
jrsvrURL - The URL string of the JRServlet, for example, http://localhost:8888/jserver.
Returns:
the TaskListHolder to browse the completed tasks.

showVersionParamValues

public static void showVersionParamValues(java.awt.Frame frame,
                                          java.lang.String jrsvrURL,
                                          java.lang.String versionID,
                                          java.lang.String title)
                                   throws java.net.MalformedURLException,
                                          java.io.IOException,
                                          JRResponseException
Deprecated. As of Version 6.0, replaced by showVersionParamValues(Frame, String, String, String, String)

Brings up a dialog box to show the report parameter values of the result version.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
jrsvrURL - The URL string of the JRServlet, for example, http://localhost:8888/jserver.
versionID - The result version ID can be got from getVersionID() of VersionRecord. The VersionRecord list of a report can be got from the method getVersionList(...) of this class.
title - The title of the dialog box.
Throws:
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.

showVersionParamValues

public static void showVersionParamValues(java.awt.Frame frame,
                                          java.lang.String jrsvrURL,
                                          java.lang.String versionID,
                                          java.lang.String title,
                                          java.lang.String name)
                                   throws java.net.MalformedURLException,
                                          java.io.IOException,
                                          JRResponseException
Brings up a dialog box to show the report parameter values of the result version.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
jrsvrURL - The URL string of the JRServlet, for example, http://localhost:8888/jserver.
versionID - The result version ID can be got from getVersionID() of VersionRecord. The VersionRecord list of a report can be got from the method getVersionList(...) of this class.
title - The title of the dialog box.
name - The name of the report, for example, /SampleReports/SampleReports.cat/CustomerAnalysis.cls.
Throws:
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.

showVersionParamValues

public static void showVersionParamValues(java.awt.Frame frame,
                                          java.lang.String jrsvrURL,
                                          java.lang.String title,
                                          java.util.Hashtable prop)
                                   throws java.net.MalformedURLException,
                                          java.io.IOException,
                                          JRResponseException
Brings up a dialog box to show the report parameter values of the result version.

Parameters:
frame - frame The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
jrsvrURL - The URL string of the JRServlet, for example, http://localhost:8888/jserver.
title - The title of the dialog box.
prop - A Hashtable which contains properties APIConst.TAG_VERSION_ID to specify the version id, APIConst.TAG_RESULT_TYPE to specify the result type (APIConst.TAG_RESULT or APIConst.TAG_RESUT_DOC), APIConst.TAG_REPORT to specify the report name if result type is the result, and APIConst.TAG_RESULT to specify the result name if result type is the result doc.
Throws:
java.net.MalformedURLException
java.io.IOException
JRResponseException
Since:
7.0

showScheduledParamValues

public static void showScheduledParamValues(java.awt.Frame frame,
                                            java.lang.String jrsvrURL,
                                            java.lang.String scheduleID,
                                            java.lang.String title)
                                     throws java.net.MalformedURLException,
                                            java.io.IOException,
                                            JRResponseException
Brings up a dialog box to show the report parameter values of a scheduled task.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
jrsvrURL - The URL string of the JRServlet, for example, http://localhost:8888/jserver.
scheduleID - The scheduled task ID.
title - The title of the dialog box.
Throws:
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.

showActiveParamValues

public static void showActiveParamValues(java.awt.Frame frame,
                                         java.lang.String jrsvrURL,
                                         java.lang.String paramFile,
                                         java.lang.String taskID,
                                         java.lang.String title)
                                  throws java.net.MalformedURLException,
                                         java.io.IOException,
                                         JRResponseException
Brings up a dialog box to show the report parameter values of a active task.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will be popped up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
jrsvrURL - The URL string of the JRServlet, for example, http://localhost:8888/jserver.
taskID - The active task ID.
title - The title of the dialog box.
Throws:
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.

showActiveParamValues

public static void showActiveParamValues(java.awt.Frame frame,
                                         java.lang.String jrsvrURL,
                                         java.lang.String paramFile,
                                         java.lang.String taskID,
                                         java.lang.String title,
                                         boolean isSwing)
                                  throws java.net.MalformedURLException,
                                         java.io.IOException,
                                         JRResponseException
Deprecated. As of Version 6.0, replaced by showActiveParamValues(Frame, String, String, String, String)

Brings up a dialog box to show the report parameter values of a active task.

Parameters:
frame - The Frame of the login dialog box. If the frame is null, JRClient will create a frame and the login dialog box will pop up when a login is needed(a server returns the Unauthorized response or a proxy returns the Proxy Authentication Required response).
jrsvrURL - The URL string of the JRServlet, for example, http://localhost:8888/jserver.
taskID - The active task ID.
title - The title of the dialog box.
isSwing - The UI style.
Throws:
java.net.MalformedURLException - if a malformed URL exception occurs.
java.io.IOException - if an I/O exception occurs.
JRResponseException - if a JRResponseException occurs.