Packages in the Client API

JReport Client API mainly includes two packages: the API package and the GUI package. The API package includes methods for running reports, getting information and viewing result versions without using a GUI. The GUI package offers an interface for viewing reports.

This section details the classes in each of these two packages as follows:

• jet.client.api
• jet.client.api.gui

jet.client.api

This package includes the following classes:

• Active
  Contains information to display for an active task from the report server.
• APIUtil
  Provides static methods, such as getting error messages, returning URL strings, getting response messages, and getting task information.
• Completed
  Contains information to display for a completed task from the report server.
• JRClient
  Represents a client of JReport Server. It includes methods for running reports, viewing result versions and creating/editing schedules etc.
• JRResponseException
  Signals that an unexpected response code is returned by a server.
• NodeInfo
  Contains resource node information of a report server for scanning catalogs or directories in the report server.
• NodeProp
  Contains properties of a resource node in a report server.
• ResourcePathInfo
  Contains the path information of a resource node in a report server. Path information includes the servlet path, path info, catalog and the report of a resource in the report server.

  For example, for the URL http://localhost:8888/jrserver/SampleReports/SampleReports.cat/EmployeeInformation.cls.

  where

  The servlet path is /jrserver.
  The path info is /SampleReports/SampleReports.cat/EmployeeInformation.cls.
  The catalog is /SampleReports/SampleReports.cat.
  The report is EmployeeInformation.cls.

• TaskSuccessInfo
  Represents success info of all formats files in a task. Various formats files can be contained in one task. You can get success info of every format file by this API.
• TimeoutException
  Signals timeout.
• VersionRecord
  Represents a result version record of a report from a report server.

jet.client.api.gui

This package includes the following interfaces and classes.

Interfaces

• CatPanelListener
  This interface defines the listener for getting current path changes of a catalog panel.

• DirPanelListener
  This interface defines the listener for getting the current path changes of a directory panel.

Classes

• CatalogPanel
  Class CatalogPanel is a panel for browsing catalogs in the report server.
• CliOpenCatDlg
  Class CliOpenCatDlg is a dialog for selecting a catalog in the report server.
• CliOpenDirDlg
  Class CliOpenDirDlg is a dialog for selecting a directory in the report server.
• ConnectionDialog
  Class ConnectionDialog is a dialog for editing or viewing the information used to connect to JReport Server.
• DeploymentDialog
  Class DeploymentDialog is a dialog for publishing resources to JReport Server.
• DirectoryPanel
  Class DirectoryPanel is a panel for browsing directories in the report server.
• JRClientGUI
  Represents a client of JReport Server. It includes methods to run reports, view result versions and create/edit schedules.
• ScheduledDlg
  Class ScheduledDlg is a dialog for creating or editing a scheduled task.
• TaskListHolder
  Class TaskListHolder is a holder that holds a panel of the scheduled tasks, active tasks or completed tasks. With this class, you can refresh the task list or set a new report server for the task list.
• ViewerThread
  Class ViewerThread is a thread for viewing a report result. It brings up a report viewer (frame) when the thread starts.