quadbase.reportorganizer.organizerAPI
Class QbOrganizer

java.lang.Object
  |
  +--quadbase.reportorganizer.organizerAPI.QbOrganizer

public class QbOrganizer

extends java.lang.Object

Constructor Summary

QbOrganizer(java.lang.Object object, java.lang.String userName, java.lang.String password)
Connect to server and get organizer handle

Method Summary

static javax.swing.LookAndFeel	getLookAndFeel()
javax.swing.JFrame	getOrganizerUI() launch the report designer.
Scheduler	getScheduler() Returns a handle to properties of the scheduler.
static java.lang.String	getServletContext() return servlet context
void	insertNewItem(java.lang.String name, java.lang.String description, java.lang.String location, java.lang.String url, java.lang.String folderName) Inserts an item into the organizer.
void	logout() Logout from Organizer
void	removeItem(java.lang.String name, java.lang.String folderName) Removes an item from the organizer.
void	setChartDesignerHandle(IChartHandle chtHandle) modify chart designer by implementing IChartHandle interface
static void	setDebugMode(int mode) set debug mode to display debug statement
static void	setDebugMode(java.lang.String mode) set debug mode to display debug statement
static void	setLookAndFeel(javax.swing.LookAndFeel newLookAndFeel) Sets the look and feel of the designer UI.
void	setReportDesignerHandle(IReportHandle rptHandle) modify report designer by implementing IReportHandle interface
static void	setServletContext(java.lang.String context) set servlet context
static void	setServletRunner(java.lang.String comm_url) Set servlet runner hostname and port number Note: this static method MUST be called before any connection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QbOrganizer

public QbOrganizer(java.lang.Object object,
                   java.lang.String userName,
                   java.lang.String password)
            throws java.lang.Exception

Connect to server and get organizer handle

Parameters:

object - can be null, applet or frame

userName - login user name

password - login user password

Method Detail

logout

public void logout()
            throws java.lang.Exception

Logout from Organizer

getOrganizerUI

public javax.swing.JFrame getOrganizerUI()

launch the report designer. Use this method after calling setVisible(true) to get a reference to the designer JFrame object.

setChartDesignerHandle

public void setChartDesignerHandle(IChartHandle chtHandle)

modify chart designer by implementing IChartHandle interface

setReportDesignerHandle

public void setReportDesignerHandle(IReportHandle rptHandle)

modify report designer by implementing IReportHandle interface

setDebugMode

public static final void setDebugMode(java.lang.String mode)

set debug mode to display debug statement

setDebugMode

public static final void setDebugMode(int mode)

set debug mode to display debug statement

setLookAndFeel

public static void setLookAndFeel(javax.swing.LookAndFeel newLookAndFeel)

 Sets the look and feel of the designer UI.
 User has to call this method before calling QbOrganizer constructor.
 If UIManager.setLookAndFeel(newLookAndFeel) throws exception, this method
 does nothing.
 

 Sample use of this method can be one of the following:
 
 	    QbOrganizer.setLookAndFeel(new javax.swing.plaf.metal.MetalLookAndFeel()); //Java Metal
	    QbOrganizer.setLookAndFeel(new com.sun.java.swing.plaf.windows.WindowsLookAndFeel()); //Windows
      QbOrganizer.setLookAndFeel(new com.sun.java.swing.plaf.motif.MotifLookAndFeel());  // MOTIF UI
 
 

getLookAndFeel

public static javax.swing.LookAndFeel getLookAndFeel()

setServletRunner

public static void setServletRunner(java.lang.String comm_url)

Set servlet runner hostname and port number Note: this static method MUST be called before any connection

Parameters:

comm_url - servlet runner hostname and port number

setServletContext

public static void setServletContext(java.lang.String context)

set servlet context

getServletContext

public static java.lang.String getServletContext()

return servlet context

getScheduler

public Scheduler getScheduler()

Returns a handle to properties of the scheduler.

insertNewItem

public void insertNewItem(java.lang.String name,
                          java.lang.String description,
                          java.lang.String location,
                          java.lang.String url,
                          java.lang.String folderName)
                   throws java.lang.Exception

Inserts an item into the organizer.

Parameters:

name - the name of the item.

description - a brief description of the item.

location - the file path to the item.

url - the url that points to this item.

folderName - the path to the organizer folder to insert this item. Must start with a "/" indicating the root of the organizer. (ex. "/managers/orders").

removeItem

public void removeItem(java.lang.String name,
                       java.lang.String folderName)
                throws java.lang.Exception

Removes an item from the organizer.

Parameters:

name - the name of the item.

folderName - the path to the organizer folder to insert this item. Must start with a "/" indicating the root of the organizer. (ex. "/managers/orders").