jet.web.dhtml
Interface DHTMLClientService

public interface DHTMLClientService

DHTML APIs provide APIs for users. With DHTML APIs, users can easily embed the DHTML pages or components into their own JSPs. All the methods in this interface can be invoked by remote server (RMI).

Support the running of multiple report sets in one session, and a report set can include one or more reports.

Descriptions of some key terms:

sessionId: the key for the session in the server (generated by the server automatically when you log in), and users can invoke DHTMLUtil.getSessionID(HttpServletRequest request) to get the key.

rptSetId: the key for the report set in DHTML (generated automatically after the report set has been run), and users can invoke DHTMLUtil.getRptSetId(HttpServletRequest request) to get the key.

rptName: the key for the report in DHTML (retrieved from the report set after the report set has been run), and users can invoke DHTMLUtil.getRptName(HttpServletRequest request) to get the key.

Note of using this DHTML API:

You must follow a certain order for the method which uses the parameters "sessionId", "rptSetId" and "rptName" in dhtml.jsp. For example: getCurrentPageNumber(String sessionId, String rptSetId, String rptName) must be called after the code "Map tmpmap = DHTMLUtil.runReport(request, params);", because the parameters are offered after the report set has been run. If the wrong order is used, a jsp error will be generated. And there is no specified order for the other API methods that do not use the parameters.

Method Summary

boolean	canNewReport(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Determines whether a new report set can be created or not.
java.lang.String	checkFlyFormulaSyntax(java.lang.String reportId, DHTMLFlyResourceScope scope, java.lang.String expression, java.lang.String blQulifyDisplayName) Checks whether the fly formula has syntax error.
boolean	checkFlyResourceName(java.lang.String reportId, DHTMLFlyResourceScope scope, java.lang.String rscQulifiedDisplayName) Checks whether the rscQulifiedDisplayName of a dynamic resource is valid or not in current environment.
java.lang.String	checkSelectParameters(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName, java.util.Hashtable parameters) Checks user-selected parameters.
void	clearDHTMLExceptions(java.lang.String sessionId, java.lang.String dRptSetId) Clears all current DHTML Exceptions.
byte[]	copyOctet(java.util.Hashtable params) Copies the content of the specified binary file to a byte array.
int	createDHTMLSession(java.lang.String sessionID, java.lang.String UserName) Checks and creates DHTML Session information.
java.lang.String	createReportSetId() Gets the id generated after the report set has been initialized for opening or cancelling a report set.
void	expire(java.lang.String sessionId) Destroys user session when it expires.
java.lang.String[]	getAllFonts() Gets all fonts.
java.lang.String[]	getAllRptNames(java.lang.String rptSetId) Gets names of all reports in the report set.
java.util.Hashtable	getAutoRefreshReportDataInfo(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Gets the information about auto refreshing report data.
int	getBrowserType(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Gets the browser type.
int	getBuildNumber() Gets the build number of JReport Server.
int	getBuildUpdate() Gets the update number of JReport Server.
boolean	getCanRedo(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Determines whether a redo action can be performed or not.
boolean	getCanUndo(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Determines whether an undo action can be performed or not.
CatalogInfo	getCatalogInfo(java.lang.String catalogName, java.lang.String userName) Gets the CatalogInfo object of a catalog.
CatalogInfo	getCatalogInfo(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String sheetId, java.lang.String subKey) Gets the CatalogInfo object of a report set.
java.lang.String	getCatalogName(java.lang.String rptSetId) Gets the catalog name of the report set.
java.lang.String	getCatalogName(java.lang.String userName, java.lang.String resourcePath) Gets the real path of the catalog.
java.lang.String	getCatalogResourceName(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Gets the relative path and name of the catalog used by the specified report.
ChartTypeInfo	getChartTypeInfo() Gets the ChartTypeInfo.
java.lang.String	getConcurrentReports() Gets the maximum number of concurrent reports.
java.lang.String	getConcurrentUsers() Gets the maximum number of concurrent users.
JNode	getCubeTreeNode(java.lang.String rptset_id, java.lang.String report_id, java.lang.String rcName) Gets the cube tree.
JNode	getCubeTreeNode(java.lang.String rptset_id, java.lang.String report_id, java.lang.String rcName, java.util.HashMap prop) Gets the cube tree.
int	getCurrentPageNumber(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Gets the current page number.
java.lang.String	getCurrentPagePanelInstanceName(java.lang.String sessionId, java.lang.String dRptSetId, java.lang.String drptName, java.lang.String dsId) Gets the current page panel instance name.
java.lang.String	getCurrentStyle(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Gets the current style name.
java.lang.String	getCurReportId(java.lang.String rptSetId) Gets the name of the active report in the report set.
jet.web.dhtml.DHTMLAction	getDHTMLAction() Gets a DHTMLAction instance.
DHTMLConfig	getDHTMLConfig() Gets a DHTMLConfig instance.
DHTMLDataInfo	getDHTMLDataInfo() Gets a DHTMLDataInfo instance.
java.lang.Throwable[]	getDHTMLExceptions(java.lang.String sessionId, java.lang.String dRptSetId) Gets all current DHTML Exceptions.
DHTMLToolkit	getDHTMLToolkit() Gets a DHTMLToolkit instance.
DHTMLWriter	getDHTMLWriter(java.lang.String sessionID, java.lang.String rptSetId) Gets a DHTMLWriter instance.
java.util.Vector	getDlgStatus(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName, java.lang.String dlgName) Gets status of dialogs.
java.lang.String	getExpire() Gets the expiration time of JReport Server license.
FlyFormula	getFlyFormula(java.lang.String reportId, DHTMLFlyResourceScope scope, java.lang.String rscQulifiedDisplayName) Gets dynamic formula with the scope (report, data source, query).
FlyMeasure	getFlyMeasure(java.lang.String reportId, DHTMLFlyResourceScope scope, java.lang.String rscQulifiedDisplayName) Gets dynamic measure with the scope (report, data source, query).
java.lang.String[][]	getGotoList(java.lang.String sessionId, java.lang.String rptSetId) Gets the report list generated by Go series actions (such as go up/go down).
java.lang.String	getHelpPath(java.lang.String helpId) Gets help path URL.
java.lang.String	getHelpRootPath() Gets JReport Server help's root path
java.lang.String	getHomePath() Gets the home path of the report server.
java.lang.String[]	getJoinPathList(java.lang.String sessionId, java.lang.String rptSetId) Gets the list of join paths among the query tables for continuing to run the report, for the case when queries are created in JReport Viewer.
java.lang.String	getLicenseType() Gets the license type, for example whether it is a temporary license.
java.lang.String	getLicenseUser() Gets the user id used for installing the JReport Server.
java.lang.String	getMainPage() Gets the path and filename of user main page.
java.lang.String[]	getOpenedRptDisplayNames(java.lang.String rptSetId) Gets display names of all open reports in the report set.
java.lang.String[]	getOpenedRptNames(java.lang.String rptSetId) Gets names of all open reports in the report set.
java.lang.String[][]	getOpenedRptsNames(java.lang.String rptSetId) Gets names and display names of all open reports in the report set.
int[]	getOpenReportStates(java.lang.String sessionId, java.lang.String rptSetId) Gets the open state of the report set. In order to avoid repeatedly showing the alert message to the user.
java.lang.String[][]	getPagePanelsObject(java.lang.String rptSetId, java.lang.String rptName, java.lang.String subRptKey) Gets a list of page panels in the report.
PropertiesInfo	getPagePropertiesInfo(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName, java.lang.String dsid, java.lang.String subkey) Gets a PropertiesInfo instance of the report page.
jet.web.dhtml.PropertyInfo	getPagePropertyInfo(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName, java.lang.String propName) Gets a PropertyInfo instance of a property of the report page.
ParametersInfo	getParametersInfo(java.lang.String sessionId, java.lang.String rptsetId) Gets parameters information for an open report set
java.lang.String	getPreviousBusinessCubeName(java.lang.String sessionId, java.lang.String rptSetId) Gets a Business Cube's BLName in previous DataContainerWizardInformation.
PropertiesInfo	getPropertisInfo(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName, java.lang.String dsid) Gets a PropertiesInfo instance of a component.
PropertiesInfo	getPropertisInfo(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName, java.lang.String dsid, java.lang.String instName) Gets a PropertiesInfo instance of a component.
jet.web.dhtml.PropertyInfo	getPropertyInfo(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName, java.lang.String dsid, java.lang.String propName) Gets a PropertyInfo instance of a property of a result object.
jet.web.dhtml.PropertyInfo	getPropertyInfo(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName, java.lang.String dsid, java.lang.String instName, java.lang.String propName) Gets a PropertyInfo instance of a property of a result object.
java.lang.String	getPropertyValue(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName, java.lang.String dsid, java.lang.String instName, java.lang.String propName) Gets the property value of the specified object.
java.util.Hashtable	getReferedByParameters(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String paramName, java.lang.Object paramValue) Gets all referred parameters information with the specified parameter name and value of open report set.
ParametersInfo	getReferedByParametersInfo(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String paramName, java.lang.String paramValue) Gets all referred parameters information with the specified parameter name and value of the open report set.
PropertiesInfo	getRenderPropertyInfo(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName, java.lang.String dsid, int renderType) Gets a PropertiesInfo instance of a render.
jet.web.dhtml.PropertyInfo	getRenderPropertyInfo(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName, java.lang.String dsid, int renderType, java.lang.String propName) Gets a PropertyInfo instance of a property of the Render.
PropertiesInfo	getReportPropertiesInfo(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Gets a PropertyInfo instance of the report.
jet.web.dhtml.PropertyInfo	getReportPropertyInfo(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName, java.lang.String propName) Gets a PropertyInfo instance of a property of the report.
java.lang.String	getReportResourceName(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Gets the relative path and name of the report set.
java.lang.String	getRestrictID() Gets the restrict id.
java.lang.String	getResultTempPath(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Returns the report result temporary path.
java.lang.String	getRptCountry(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Gets the country information used by the report set.
java.lang.String	getRptEncoding(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Gets the encoding used by the report set.
java.lang.String	getRptLanguage(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Gets the language used by the report set.
int[]	getRptPageWH(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Gets the current report page's width and height.
java.lang.String	getRptSetDisplayName(java.lang.String rptSetId) Gets the display name of the report set.
java.lang.String	getRptSheetDesc(java.lang.String rptSetId, java.lang.String rptName) Gets the report sheet descirption.
java.lang.String	getRptSheetDisplayName(java.lang.String rptSetId, java.lang.String rptName) Gets the display name of the report sheet.
jet.web.dhtml.SearchInfo	getSearchInfo(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Gets a SearchInfo instance of the report.
jet.web.dhtml.SearchInfo	getSearchInfo(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName, java.lang.String dsId) Gets a SearchInfo instance of the report.
java.lang.String[][]	getStyleList() Gets the display name and CSS path of the style list.
java.lang.String	getSubReportKey(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName, java.lang.String dsid) Gets the key of the engine corresponding to the current object.
java.lang.String[]	getSubReportKeys(java.lang.String rptSetId, java.lang.String rptName) Gets the list of keys of all engines related to the current report.
java.util.List	getTempFileDirectories() Gets the temporary file directories.
int	getTotalPageNumnber(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Gets the total physical page number.
java.lang.String	getUsableReportName(java.lang.String rptSetId) Gets the report name when creating a new report.
java.lang.String	getUserName(java.lang.String sessionId) Gets the user name by the session id.
java.lang.String	getVersion() Gets the version number of JReport Server.
boolean	hasMaster(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Determines whether the report is linked from a master report or not.
boolean	hasNextDetail(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Determines whether the report will link to another detail report or not.
boolean	hasPrevDetail(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Determines whether the report is linked to another detail report or not.
boolean	isCloseWindow(java.lang.String sessionId) Gets the mode of closing window for a specified user.
boolean	isDesignerViewMode(java.lang.String sessionId, java.lang.String rptSetId) Determines whether it is Designer view mode or not.
boolean	isFinishPipeline(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Determines whether the report is pipe-line mode or not.
boolean	isFirstOpen(java.lang.String sessionId) Determines whether it is the first time to run the report set or not.
boolean	isLink(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Determines whether the report is a link report or not.
boolean	isModified(java.lang.String sessionId, java.lang.String rptSetId) Determines whether the report set has been modified or not.
boolean	isNewReportSet(java.lang.String sessionId, java.lang.String rptSetId) Determines whether the report set is newly-created or not.
boolean	isOldRptSetVersion(java.lang.String dRptSetId) Determines whether the report is an old version (8.2) report or not.
boolean	isOpened(java.lang.String rptSetId, java.lang.String rptName) Determines whether the report is opened or not.
boolean	isRSD(java.lang.String sessionId, java.lang.String rptSetId) Determines whether the report set is of RSD type or not.
boolean	isRsdFile(java.lang.String sessionId, java.lang.String rptSetId) Determines whether the report set is of RSD type or not.
boolean	isRSDFile(java.lang.String sessionId, java.lang.String rptSetId) Determines whether the report is RSD or not.
boolean	isSaved(java.lang.String sessionId, java.lang.String rptSetId) Determines whether the report set has been saved or not.
boolean	isShowSpalshScreen(java.lang.String sessionId) Determines whether to show the splash screen or not.
boolean	isTaglib(java.lang.String sessionId, java.lang.String rptSetId) Determines whether to use taglib to run report set or not.
void	loadSkin(java.lang.String sessionId, java.lang.String rptSetId) Loads the default current skin name from session or skin.txt
java.util.Hashtable	openReport(java.util.Hashtable params) Opens a report set with an active report.
java.lang.String[]	parseRuntimeID(java.lang.String runtimeID) Builds an array from a runtimeID.
void	setCloseWindow(boolean closeWindow) Sets the mode of closing window for all users.
void	setCloseWindow(java.lang.String sessionId, boolean closeWindow) Sets the mode of closing window for a specified user.
jet.web.dhtml.SearchInfo	updateSearchInfo(java.lang.String sessionId, java.lang.String rptSetId, java.lang.String rptName) Updates the SearchInfo of the report.

Method Detail

createDHTMLSession

int createDHTMLSession(java.lang.String sessionID,
                       java.lang.String UserName)

Checks and creates DHTML Session information.

An example of the method:

%serverhome%/public_html/dhtmljsp/customize_panel.jsp.

Parameters:

sessionId - the user session id.

UserName - user name.

Returns:

value which is defined in DHTMLConstant:

DHTMLConstant.CHECK_CREATE_SESSION_OK -- The job is finished successfully.

DHTMLConstant.CHECK_CREATE_SESSION_ERROR -- The job failed with error.

createReportSetId

java.lang.String createReportSetId()

Gets the id generated after the report set has been initialized for opening or cancelling a report set.

Returns:

report set id.

expire

void expire(java.lang.String sessionId)

Destroys user session when it expires.

Parameters:

sessionId - the user session id.

getAllRptNames

java.lang.String[] getAllRptNames(java.lang.String rptSetId)

Gets names of all reports in the report set.

Parameters:

rptSetId - the report set id.

Returns:

names of all reports in the report set.

getCanUndo

boolean getCanUndo(java.lang.String sessionId,
                   java.lang.String rptSetId,
                   java.lang.String rptName)

Determines whether an undo action can be performed or not.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

true if an undo action can be performed; otherwise false.

getCanRedo

boolean getCanRedo(java.lang.String sessionId,
                   java.lang.String rptSetId,
                   java.lang.String rptName)

Determines whether a redo action can be performed or not.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

true if a redo action can be performed; otherwise false.

getCatalogName

java.lang.String getCatalogName(java.lang.String rptSetId)

Gets the catalog name of the report set.

An example of the method:

%serverhome%/public_html/dhtmljsp/newchart.jsp.

Parameters:

rptSetId - the report set id.

Returns:

the catalog name of the report set.

getCatalogName

java.lang.String getCatalogName(java.lang.String userName,
                                java.lang.String resourcePath)

Gets the real path of the catalog.

An example of the method:

%serverhome%/public_html/dhtmljsp/newchart.jsp.

Parameters:

userName - the user name.

resourcePath - the relative path of the catalog resources.

Returns:

the real path of the catalog.

isCloseWindow

boolean isCloseWindow(java.lang.String sessionId)

Gets the mode of closing window for a specified user.

Parameters:

sessionId - the user session id.

Returns:

the mode of closing window:

true -- close the window,

false -- keep the window open.

getCurrentPageNumber

int getCurrentPageNumber(java.lang.String sessionId,
                         java.lang.String rptSetId,
                         java.lang.String rptName)

Gets the current page number.

An example of the method:

%serverhome%/public_html/dhtmljsp/commontoolbar.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

the current page number.

getCurrentStyle

java.lang.String getCurrentStyle(java.lang.String sessionId,
                                 java.lang.String rptSetId,
                                 java.lang.String rptName)

Gets the current style name.

An example of the method:

%serverhome%/public_html/dhtmljsp/rptmain.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

the current style name.

getCurReportId

java.lang.String getCurReportId(java.lang.String rptSetId)

Gets the name of the active report in the report set.

An example of the method:

%serverhome%/public_html/dhtmljsp/rptsetbar.jsp.

Parameters:

rptSetId - the report set id.

Returns:

the name of the active report in the report set.

getDHTMLConfig

DHTMLConfig getDHTMLConfig()

Gets a DHTMLConfig instance.

An example of the method:

%serverhome%/public_html/dhtmljsp/dhtml.jsp.

Returns:

a DHTMLConfig instance.

getDHTMLDataInfo

DHTMLDataInfo getDHTMLDataInfo()

Gets a DHTMLDataInfo instance.

An example of the method:

%serverhome%/public_html/dhtmljsp/builddso.jsp.

Returns:

a DHTMLDataInfo instance.

getDHTMLWriter

DHTMLWriter getDHTMLWriter(java.lang.String sessionID,
                           java.lang.String rptSetId)

Gets a DHTMLWriter instance.

An example of the method:

%serverhome%/public_html/dhtmljsp/report.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

Returns:

a DHTMLWriter instance.

getOpenedRptNames

java.lang.String[] getOpenedRptNames(java.lang.String rptSetId)

Gets names of all open reports in the report set.

Parameters:

rptSetId - the report set id.

Returns:

names of all open reports in the report set.

getRptLanguage

java.lang.String getRptLanguage(java.lang.String sessionId,
                                java.lang.String rptSetId,
                                java.lang.String rptName)

Gets the language used by the report set.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

the language used by the report set.

getRptEncoding

java.lang.String getRptEncoding(java.lang.String sessionId,
                                java.lang.String rptSetId,
                                java.lang.String rptName)

Gets the encoding used by the report set.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

the encoding used by the report set.

getRptCountry

java.lang.String getRptCountry(java.lang.String sessionId,
                               java.lang.String rptSetId,
                               java.lang.String rptName)

Gets the country information used by the report set.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

the country information used by the report set.

getRptSetDisplayName

java.lang.String getRptSetDisplayName(java.lang.String rptSetId)

Gets the display name of the report set.

Parameters:

rptSetId - the report set id.

Returns:

the display name of the report set.

getRptSheetDisplayName

java.lang.String getRptSheetDisplayName(java.lang.String rptSetId,
                                        java.lang.String rptName)

Gets the display name of the report sheet.

An example of the method:

%serverhome%/public_html/dhtmljsp/openrptdlg.jsp.

Parameters:

rptSetId - the report set id.

rptName - the report name.

Returns:

the display name of the report sheet.

getStyleList

java.lang.String[][] getStyleList()

Gets the display name and CSS path of the style list.

Returns:

the two-dimensional style list String [[stylename1,d:\XXX],[stylename2,c:\XXX],...].

getTotalPageNumnber

int getTotalPageNumnber(java.lang.String sessionId,
                        java.lang.String rptSetId,
                        java.lang.String rptName)

Gets the total physical page number.

An example of the method:

%serverhome%/public_html/dhtmljsp/commontoolbar.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

The total physical page number.

setCloseWindow

void setCloseWindow(java.lang.String sessionId,
                    boolean closeWindow)

Sets the mode of closing window for a specified user.

Parameters:

sessionId - the user session id.

closeWindow - if true, the window will be closed; otherwise the window will not be closed.

setCloseWindow

void setCloseWindow(boolean closeWindow)

Sets the mode of closing window for all users.

Parameters:

closeWindow - if true, the window will be closed; otherwise the window will not be closed.

getSubReportKeys

java.lang.String[] getSubReportKeys(java.lang.String rptSetId,
                                    java.lang.String rptName)

Gets the list of keys of all engines related to the current report.

An example of the method:

%serverhome%/public_html/dhtmljsp/filter.jsp.

Parameters:

rptSetId - the report set id.

rptName - the report name.

Returns:

the list of keys of all engines related to the current report.

parseRuntimeID

java.lang.String[] parseRuntimeID(java.lang.String runtimeID)

Builds an array from a runtimeID.

Parameters:

runtimeID - runtime id. supported runtimeID format: SessionID-RptSetId-RptName or SessionID-RptSetId.

Returns:

an array, such as: [SessionID,RptSetId,RptName] or [SessionID,RptSetId]

openReport

java.util.Hashtable openReport(java.util.Hashtable params)
                               throws RptServerException,
                                      java.io.IOException,
                                      jet.JDException

Opens a report set with an active report.

Parameters:

params - input user parameter.

Returns:

the report information.

Throws:

RptServerException

java.io.IOException

jet.JDException

getDHTMLAction

jet.web.dhtml.DHTMLAction getDHTMLAction()

Gets a DHTMLAction instance.

An example of the method:

%serverhome%/public_html/dhtmljsp/customize_panel.jsp.

Returns:

a DHTMLAction instance.

getSubReportKey

java.lang.String getSubReportKey(java.lang.String sessionId,
                                 java.lang.String rptSetId,
                                 java.lang.String rptName,
                                 java.lang.String dsid)

Gets the key of the engine corresponding to the current object.

An example of the method:

%serverhome%/public_html/dhtmljsp/selectvalues.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

dsid - ID of the result object.

Returns:

the key of the engine corresponding to the current object.

getOpenedRptDisplayNames

java.lang.String[] getOpenedRptDisplayNames(java.lang.String rptSetId)

Gets display names of all open reports in the report set.

Parameters:

rptSetId - the report set id.

Returns:

display names of all open reports in the report set.

getOpenedRptsNames

java.lang.String[][] getOpenedRptsNames(java.lang.String rptSetId)

Gets names and display names of all open reports in the report set.

An example of the method:

%serverhome%/public_html/dhtmljsp/rptsetbar.jsp.

Parameters:

rptSetId - the report set id.

Returns:

String[][], first array member is name, second DisplayName.

isOpened

boolean isOpened(java.lang.String rptSetId,
                 java.lang.String rptName)

Determines whether the report is opened or not.

Parameters:

rptSetId - the report set id.

rptName - the report name.

Returns:

true if the report is opened, otherwise false.

getUserName

java.lang.String getUserName(java.lang.String sessionId)

Gets the user name by the session id.

An example of the method:

%serverhome%/public_html/dhtmljsp/footer.jsp.

Parameters:

sessionId - the user session id.

Returns:

the user name.

getPropertyInfo

jet.web.dhtml.PropertyInfo getPropertyInfo(java.lang.String sessionId,
                                           java.lang.String rptSetId,
                                           java.lang.String rptName,
                                           java.lang.String dsid,
                                           java.lang.String propName)

Gets a PropertyInfo instance of a property of a result object.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

dsid - the result object id.

propName - the property name.

Returns:

a PropertyInfo instance or null.

getPropertyInfo

jet.web.dhtml.PropertyInfo getPropertyInfo(java.lang.String sessionId,
                                           java.lang.String rptSetId,
                                           java.lang.String rptName,
                                           java.lang.String dsid,
                                           java.lang.String instName,
                                           java.lang.String propName)

Gets a PropertyInfo instance of a property of a result object.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

dsid - the result object id.

instName - the instant name of templet object.

propName - the property name.

Returns:

a PropertyInfo instance or null.

getSearchInfo

jet.web.dhtml.SearchInfo getSearchInfo(java.lang.String sessionId,
                                       java.lang.String rptSetId,
                                       java.lang.String rptName)
                                       throws jet.rptservice.api.exception.JRScheduleException

Gets a SearchInfo instance of the report.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

a SearchInfo instance, not null.

Throws:

jet.rptservice.api.exception.JRScheduleException

getSearchInfo

jet.web.dhtml.SearchInfo getSearchInfo(java.lang.String sessionId,
                                       java.lang.String rptSetId,
                                       java.lang.String rptName,
                                       java.lang.String dsId)
                                       throws jet.rptservice.api.exception.JRScheduleException

Gets a SearchInfo instance of the report.

An example of the method:

%serverhome%/public_html/dhtmljsp/searchdialog.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

dsId - the result object id.

Returns:

a SearchInfo instance, not null.

Throws:

jet.rptservice.api.exception.JRScheduleException

updateSearchInfo

jet.web.dhtml.SearchInfo updateSearchInfo(java.lang.String sessionId,
                                          java.lang.String rptSetId,
                                          java.lang.String rptName)
                                          throws jet.rptservice.api.exception.JRScheduleException

Updates the SearchInfo of the report.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

the new SearchInfo instance, not null.

Throws:

jet.rptservice.api.exception.JRScheduleException

copyOctet

byte[] copyOctet(java.util.Hashtable params)
                 throws jet.JDException

Copies the content of the specified binary file to a byte array.

Parameters:

params - input user parameters:

DHTMLConstant.SESSION_ID, the user session id,

DHTMLConstant.RPTSET_ID, the report set id,

DHTMLConstant.RPT_NAME, the report name,

DHTMLConstant.TRANSLATE, the file name.

Returns:

a byte array.

Throws:

jet.JDException

getBrowserType

int getBrowserType(java.lang.String sessionId,
                   java.lang.String rptSetId,
                   java.lang.String rptName)

Gets the browser type.

An example of the method:

%serverhome%/public_html/dhtmljsp/customize_panel.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

the browser type which is defined in DHTMLConstant:

DHTMLConstant.BROWSER_IE,

...

DHTMLConstant.BROWSER_CHROME.

hasMaster

boolean hasMaster(java.lang.String sessionId,
                  java.lang.String rptSetId,
                  java.lang.String rptName)

Determines whether the report is linked from a master report or not.

An example of the method:

%serverhome%/public_html/dhtmljsp/linkbar.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

true if the report is linked from a master report; otherwise false.

hasPrevDetail

boolean hasPrevDetail(java.lang.String sessionId,
                      java.lang.String rptSetId,
                      java.lang.String rptName)

Determines whether the report is linked to another detail report or not.

An example of the method:

%serverhome%/public_html/dhtmljsp/linkbar.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

true if the report is linked to another detail report; otherwise false.

hasNextDetail

boolean hasNextDetail(java.lang.String sessionId,
                      java.lang.String rptSetId,
                      java.lang.String rptName)

Determines whether the report will link to another detail report or not.

An example of the method:

%serverhome%/public_html/dhtmljsp/linkbar.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

true if the report will link to another detail report; otherwise false.

isLink

boolean isLink(java.lang.String sessionId,
               java.lang.String rptSetId,
               java.lang.String rptName)

Determines whether the report is a link report or not.

An example of the method:

%serverhome%/public_html/dhtmljsp/linkbar.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

true if the report is a link report; otherwise false.

getDlgStatus

java.util.Vector getDlgStatus(java.lang.String sessionId,
                              java.lang.String rptSetId,
                              java.lang.String rptName,
                              java.lang.String dlgName)
                              throws jet.rptservice.api.exception.JRScheduleException

Gets status of dialogs.

An example of the method:

%serverhome%/public_html/dhtmljsp/filter.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

dlgName - the dialog name: "filter" or "sort".

Returns:

status of dialogs, such as:

vector[0]: "dataset"/"component",

vector[1]: component name,...sub component,

....

Throws:

jet.rptservice.api.exception.JRScheduleException

getDHTMLToolkit

DHTMLToolkit getDHTMLToolkit()

Gets a DHTMLToolkit instance.

Returns:

a DHTMLToolkit instance.

getRptPageWH

int[] getRptPageWH(java.lang.String sessionId,
                   java.lang.String rptSetId,
                   java.lang.String rptName)

Gets the current report page's width and height.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

the current report page's width and height.

getMainPage

java.lang.String getMainPage()

Gets the path and filename of user main page.

Returns:

the path and filename of user main page.

getRptSheetDesc

java.lang.String getRptSheetDesc(java.lang.String rptSetId,
                                 java.lang.String rptName)

Gets the report sheet descirption.

An example of the method:

%serverhome%/public_html/dhtmljsp/openrptdlg.jsp.

Parameters:

rptSetId - the report set id.

rptName - the report name.

Returns:

the report sheet descirption. For example: %serverhome%/public_html/dhtmljsp/openrptdlg.jsp.

getParametersInfo

ParametersInfo getParametersInfo(java.lang.String sessionId,
                                 java.lang.String rptsetId)

Gets parameters information for an open report set

An example of the method:

%serverhome%/public_html/dhtmljsp/select_parameter.jsp.

Parameters:

sessionId - the user session id

rptsetId - the report set id

Returns:

The jet.webreport.ParametersInfo

getReferedByParametersInfo

ParametersInfo getReferedByParametersInfo(java.lang.String sessionId,
                                          java.lang.String rptSetId,
                                          java.lang.String paramName,
                                          java.lang.String paramValue)

Gets all referred parameters information with the specified parameter name and value of the open report set.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

paramName - parameter name.

paramValue - parameter value.

Returns:

all reffered parameters information.

getReferedByParameters

java.util.Hashtable getReferedByParameters(java.lang.String sessionId,
                                           java.lang.String rptSetId,
                                           java.lang.String paramName,
                                           java.lang.Object paramValue)

Gets all referred parameters information with the specified parameter name and value of open report set.

An example of the method:

%serverhome%/public_html/dhtmljsp/actionjsp/get_referedby_parameter.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

paramName - the parameter name.

paramValue - the parameter value:

for multi-value, input String[]; for single value, input String.

Returns:

all referred parameters information, such as
{"param1":{"defaultValue":"1","isAll":"true","selectValues":[["1","Ann"],["2","John"]...]}, "param2":{},...}; For example: %serverhome%/public_html/dhtmljsp/actionjsp/get_referedby_parameter.jsp.

getJoinPathList

java.lang.String[] getJoinPathList(java.lang.String sessionId,
                                   java.lang.String rptSetId)

Gets the list of join paths among the query tables for continuing to run the report, for the case when queries are created in JReport Viewer.

An example of the method:

%serverhome%/public_html/dhtmljsp/select_joinpath.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

paramName - the name of the parameter.

Returns:

the join paths list.

getPagePropertyInfo

jet.web.dhtml.PropertyInfo getPagePropertyInfo(java.lang.String sessionId,
                                               java.lang.String rptSetId,
                                               java.lang.String rptName,
                                               java.lang.String propName)

Gets a PropertyInfo instance of a property of the report page.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

propName - the property name.

Returns:

the instance of PropertyInfo.

getReportPropertyInfo

jet.web.dhtml.PropertyInfo getReportPropertyInfo(java.lang.String sessionId,
                                                 java.lang.String rptSetId,
                                                 java.lang.String rptName,
                                                 java.lang.String propName)

Gets a PropertyInfo instance of a property of the report.

An example of the method:

%serverhome%/public_html/dhtmljsp/header.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

propName - the property name.

Returns:

the instance of PropertyInfo.

getHelpRootPath

java.lang.String getHelpRootPath()

Gets JReport Server help's root path

Returns:

help root path

getHelpPath

java.lang.String getHelpPath(java.lang.String helpId)

Gets help path URL.

An example of the method:

%serverhome%/public_html/dhtmljsp/help.jsp.

Returns:

the help path URL, or null if the help is unavailable.

getCatalogResourceName

java.lang.String getCatalogResourceName(java.lang.String sessionId,
                                        java.lang.String rptSetId,
                                        java.lang.String rptName)

Gets the relative path and name of the catalog used by the specified report.

An example of the method:

%serverhome%/public_html/dhtmljsp/newreport.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

the relative path and name of the catalog.

getReportResourceName

java.lang.String getReportResourceName(java.lang.String sessionId,
                                       java.lang.String rptSetId,
                                       java.lang.String rptName)

Gets the relative path and name of the report set.

An example of the method:

%serverhome%/public_html/dhtmljsp/index.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

the relative path and name of the report set.

getOpenReportStates

int[] getOpenReportStates(java.lang.String sessionId,
                          java.lang.String rptSetId)

Gets the open state of the report set.
In order to avoid repeatedly showing the alert message to the user.

An example of the method:

%serverhome%/public_html/dhtmljsp/linkbar.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

Returns:

a two length int array [n1,n2]:

[n1]- the number of non-open reports in the report set.

[n2]- the number of open reports in the report set.

isSaved

boolean isSaved(java.lang.String sessionId,
                java.lang.String rptSetId)

Determines whether the report set has been saved or not.

An example of the method:

%serverhome%/public_html/dhtmljsp/actionjsp/saveresult.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

Returns:

true, if the report set has been saved, otherwise false.

getPagePanelsObject

java.lang.String[][] getPagePanelsObject(java.lang.String rptSetId,
                                         java.lang.String rptName,
                                         java.lang.String subRptKey)

Gets a list of page panels in the report.

An example of the method:

%serverhome%/public_html/dhtmljsp/dialogjsp/pageproperty.jsp.

Parameters:

rptSetId - the report set id.

rptName - the report name.

subRptKey - the key of the engine.

Returns:

a list of page panels in the report.

isFirstOpen

boolean isFirstOpen(java.lang.String sessionId)

Determines whether it is the first time to run the report set or not.

Parameters:

sessionId - the user session id.

Returns:

true if it is the first time to run the report set, otherwise false.

loadSkin

void loadSkin(java.lang.String sessionId,
              java.lang.String rptSetId)

Loads the default current skin name from session or skin.txt

An example of the method:

%serverhome%/public_html/dhtmljsp/customize_panel.jsp.

Parameters:

sessionId - the user session id.

isNewReportSet

boolean isNewReportSet(java.lang.String sessionId,
                       java.lang.String rptSetId)

Determines whether the report set is newly-created or not.

An example of the method:

%serverhome%/public_html/dhtmljsp/index.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

Returns:

true if the report set is newly-created, otherwise false.

isRSD

boolean isRSD(java.lang.String sessionId,
              java.lang.String rptSetId)

Determines whether the report set is of RSD type or not.

An example of the method:

%serverhome%/public_html/dhtmljsp/save_result.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

Returns:

true if the report set is of RSD type, otherwise false.

getUsableReportName

java.lang.String getUsableReportName(java.lang.String rptSetId)

Gets the report name when creating a new report.

An example of the method:

%serverhome%/public_html/dhtmljsp/newreport.jsp.

Parameters:

rptSetId - the report set id.

Returns:

the report name when creating a new report.

canNewReport

boolean canNewReport(java.lang.String sessionId,
                     java.lang.String rptSetId,
                     java.lang.String rptName)

Determines whether a new report set can be created or not.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

true if a new report set can be created, otherwise false.

getVersion

java.lang.String getVersion()

Gets the version number of JReport Server.

An example of the method:

%serverhome%/public_html/dhtmljsp/dailogjsp/aboutdhtml.jsp.

Returns:

the version number of JReport Server, such as: v9.0.0 Service Pack 1.

getBuildNumber

int getBuildNumber()

Gets the build number of JReport Server.

Returns:

the build number of JReport Server.

getBuildUpdate

int getBuildUpdate()

Gets the update number of JReport Server.

Returns:

the update number of JReport Server.

getLicenseUser

java.lang.String getLicenseUser()

Gets the user id used for installing the JReport Server.

An example of the method:

%serverhome%/public_html/dhtmljsp/dailogjsp/aboutdhtml.jsp.

Returns:

the user id used for installing the JReport Server.

getExpire

java.lang.String getExpire()

Gets the expiration time of JReport Server license.

An example of the method:

%serverhome%/public_html/dhtmljsp/dailogjsp/aboutdhtml.jsp.

Returns:

the expiration time of JReport Server license.

getLicenseType

java.lang.String getLicenseType()

Gets the license type, for example whether it is a temporary license.

An example of the method:

%serverhome%/public_html/dhtmljsp/dailogjsp/aboutdhtml.jsp.

Returns:

the license type.

getRestrictID

java.lang.String getRestrictID()

Gets the restrict id.

An example of the method:

%serverhome%/public_html/dhtmljsp/dailogjsp/aboutdhtml.jsp.

Returns:

the restrict id.

getConcurrentUsers

java.lang.String getConcurrentUsers()

Gets the maximum number of concurrent users.

An example of the method:

%serverhome%/public_html/dhtmljsp/dailogjsp/aboutdhtml.jsp.

Returns:

the maximum number of concurrent users.

getConcurrentReports

java.lang.String getConcurrentReports()

Gets the maximum number of concurrent reports.

An example of the method:

%serverhome%/public_html/dhtmljsp/dailogjsp/aboutdhtml.jsp.

Returns:

the maximum number of concurrent reports.

getResultTempPath

java.lang.String getResultTempPath(java.lang.String sessionId,
                                   java.lang.String rptSetId,
                                   java.lang.String rptName)

Returns the report result temporary path.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

the report result temporary path.

getHomePath

java.lang.String getHomePath()

Gets the home path of the report server.

Returns:

the home path of the report server. It is the install-root of JReport Server.

See Also:

jet.server.api.ServerEnv.getHomePath().

getRenderPropertyInfo

jet.web.dhtml.PropertyInfo getRenderPropertyInfo(java.lang.String sessionId,
                                                 java.lang.String rptSetId,
                                                 java.lang.String rptName,
                                                 java.lang.String dsid,
                                                 int renderType,
                                                 java.lang.String propName)

Gets a PropertyInfo instance of a property of the Render.

An example of the method:

%serverhome%/public_html/dhtmljsp/dailogjsp/fieldproperty.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

dsid - the result object id.

renderType - the render type of the target object.

propName - the property name.

Returns:

a PropertyInfo instance or null.

checkSelectParameters

java.lang.String checkSelectParameters(java.lang.String sessionId,
                                       java.lang.String rptSetId,
                                       java.lang.String rptName,
                                       java.util.Hashtable parameters)

Checks user-selected parameters.

An example of the method:

%serverhome%/public_html/dhtmljsp/actionjsp/check_select_paramter.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

parameters - the user input parameters and the parameter's value(s).

Returns:

the error message.

isModified

boolean isModified(java.lang.String sessionId,
                   java.lang.String rptSetId)

Determines whether the report set has been modified or not.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

Returns:

true if the report set has been modified, otherwise false.

isTaglib

boolean isTaglib(java.lang.String sessionId,
                 java.lang.String rptSetId)

Determines whether to use taglib to run report set or not.

An example of the method:

%serverhome%/public_html/dhtmljsp/customize_panel.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

Returns:

true if to use taglib, otherwise false.

isRsdFile

boolean isRsdFile(java.lang.String sessionId,
                  java.lang.String rptSetId)

Determines whether the report set is of RSD type or not.

An example of the method:

%serverhome%/public_html/dhtmljsp/builddso.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

Returns:

true if the report set is of RSD type, otherwise false.

getDHTMLExceptions

java.lang.Throwable[] getDHTMLExceptions(java.lang.String sessionId,
                                         java.lang.String dRptSetId)

Gets all current DHTML Exceptions.

Parameters:

sessionId - the user session id.

dRptSetId - the report set id.

Returns:

all current DHTML Exceptions.

clearDHTMLExceptions

void clearDHTMLExceptions(java.lang.String sessionId,
                          java.lang.String dRptSetId)

Clears all current DHTML Exceptions.

An example of the method:

%serverhome%/public_html/dhtmljsp/errorpage.jsp.

Parameters:

sessionId - the user session id.

dRptSetId - the report set id.

getCatalogInfo

CatalogInfo getCatalogInfo(java.lang.String catalogName,
                           java.lang.String userName)

Gets the CatalogInfo object of a catalog.

An example of the method:

%serverhome%/public_html/dhtmljsp/builddatasource.jsp.

Parameters:

catalogName - the catalog resource name.

userName - the user name.

Returns:

the jet.webreport.CatalogInfo.

getCatalogInfo

CatalogInfo getCatalogInfo(java.lang.String sessionId,
                           java.lang.String rptSetId,
                           java.lang.String sheetId,
                           java.lang.String subKey)

Gets the CatalogInfo object of a report set.

An example of the method:

%serverhome%/public_html/dhtmljsp/create/common/data_tree_for_component.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

sheetId - the report name.

subKey - the key of the engine.

Returns:

the jet.webreport.CatalogInfo.

getChartTypeInfo

ChartTypeInfo getChartTypeInfo()

Gets the ChartTypeInfo.

An example of the method:

%serverhome%/public_html/dhtmljsp/insertchart.jsp.

isDesignerViewMode

boolean isDesignerViewMode(java.lang.String sessionId,
                           java.lang.String rptSetId)

Determines whether it is Designer view mode or not.

An example of the method:

%serverhome%/public_html/dhtmljsp/rptmain.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

Returns:

whether it is Designer view mode or not.

isShowSpalshScreen

boolean isShowSpalshScreen(java.lang.String sessionId)

Determines whether to show the splash screen or not.

An example of the method:

%serverhome%/public_html/dhtmljsp/dhtml.jsp.

Parameters:

sessionId -

Returns:

true if to show the splash screen; otherwise false.

getPropertyValue

java.lang.String getPropertyValue(java.lang.String sessionId,
                                  java.lang.String rptSetId,
                                  java.lang.String rptName,
                                  java.lang.String dsid,
                                  java.lang.String instName,
                                  java.lang.String propName)

Gets the property value of the specified object.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

dsid - the result object id.

instName - the instant name of the templet object.

propName - the property name of the object.

Returns:

the property value.

getTempFileDirectories

java.util.List getTempFileDirectories()

Gets the temporary file directories.

Returns:

the temporary file directories.

isFinishPipeline

boolean isFinishPipeline(java.lang.String sessionId,
                         java.lang.String rptSetId,
                         java.lang.String rptName)

Determines whether the report is pipe-line mode or not.

An example of the method:

%serverhome%/public_html/dhtmljsp/header.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

true if the report is pipe-line mode, otherwise false.

getAllFonts

java.lang.String[] getAllFonts()

Gets all fonts.

An example of the method:

%serverhome%/public_html/dhtmljsp/toolbar_field_property.jsp.

Returns:

all fonts.

getGotoList

java.lang.String[][] getGotoList(java.lang.String sessionId,
                                 java.lang.String rptSetId)

Gets the report list generated by Go series actions (such as go up/go down).

An example of the method:

%serverhome%/public_html/dhtmljsp/linkbar.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

Returns:

the two-dimensional list [reportname][action]:

[reportname] is the report display name.

[action] is the action value.

isRSDFile

boolean isRSDFile(java.lang.String sessionId,
                  java.lang.String rptSetId)

Determines whether the report is RSD or not.

An example of the method:

%serverhome%/public_html/dhtmljsp/builddso.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

Returns:

true, if the report is RSD, otherwise false.

getCurrentPagePanelInstanceName

java.lang.String getCurrentPagePanelInstanceName(java.lang.String sessionId,
                                                 java.lang.String dRptSetId,
                                                 java.lang.String drptName,
                                                 java.lang.String dsId)

Gets the current page panel instance name.

An example of the method:

%serverhome%/public_html/dhtmljsp/dialogjsp/pageproperty.jsp.

Parameters:

sessionId - the user session id.

dRptSetId - the report set id.

drptName - the report name.

dsId - ID of the result object.

Returns:

the current page panel instance name.

isOldRptSetVersion

boolean isOldRptSetVersion(java.lang.String dRptSetId)

Determines whether the report is an old version (8.2) report or not.

An example of the method:

%serverhome%/public_html/dhtmljsp/newreport.jsp.

Parameters:

dRptSetId - the report set id.

Returns:

true, if the report is an old version report, otherwise false.

getPropertisInfo

PropertiesInfo getPropertisInfo(java.lang.String sessionId,
                                java.lang.String rptSetId,
                                java.lang.String rptName,
                                java.lang.String dsid,
                                java.lang.String instName)

Gets a PropertiesInfo instance of a component.

An example of the method:

%serverhome%/public_html/dhtmljsp/dialogjsp/chartpaperproperty.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

dsid - the result object id.

instName - the instant name of templet object.

Returns:

a PropertiesInfo instance or null.

getPropertisInfo

PropertiesInfo getPropertisInfo(java.lang.String sessionId,
                                java.lang.String rptSetId,
                                java.lang.String rptName,
                                java.lang.String dsid)

Gets a PropertiesInfo instance of a component.

An example of the method:

%serverhome%/public_html/dhtmljsp/dialogjsp/fielproperty.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

dsid - the result object id.

Returns:

a PropertiesInfo instance or null.

getRenderPropertyInfo

PropertiesInfo getRenderPropertyInfo(java.lang.String sessionId,
                                     java.lang.String rptSetId,
                                     java.lang.String rptName,
                                     java.lang.String dsid,
                                     int renderType)

Gets a PropertiesInfo instance of a render.

An example of the method:

%serverhome%/public_html/dhtmljsp/dialogjsp/fielproperty.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

dsid - the result object id.

renderType - the type value which is defined in jet.report.mode.common.RptRenderer:

RptRenderer.RENDER_TEXT,

...

RptRenderer.RENDER_TEXTFIELD.

Returns:

a PropertiesInfo instance or null.

getPagePropertiesInfo

PropertiesInfo getPagePropertiesInfo(java.lang.String sessionId,
                                     java.lang.String rptSetId,
                                     java.lang.String rptName,
                                     java.lang.String dsid,
                                     java.lang.String subkey)

Gets a PropertiesInfo instance of the report page.

An example of the method:

%serverhome%/public_html/dhtmljsp/dialogjsp/pageproperty.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

dsid - the result object id or instant name of templet object.

subkey - the key of the engine.

Returns:

the instance of PropertiesInfo.

getReportPropertiesInfo

PropertiesInfo getReportPropertiesInfo(java.lang.String sessionId,
                                       java.lang.String rptSetId,
                                       java.lang.String rptName)

Gets a PropertyInfo instance of the report.

An example of the method:

%serverhome%/public_html/dhtmljsp/dialogjsp/reportproperty.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

the instance of PropertiesInfo.

getCubeTreeNode

JNode getCubeTreeNode(java.lang.String rptset_id,
                      java.lang.String report_id,
                      java.lang.String rcName,
                      java.util.HashMap prop)

Gets the cube tree.

An example of the method:

%serverhome%/public_html/dhtmljsp/dialogjsp/buildformulatree.jsp.

Parameters:

rptset_id - the report set id.

report_id - the report name.

rcName - the rc qualified name (formed by data source name, query name, rc name, with separator '.').

prop - the tree config properties, such as image path, root expand level.
Default you can get via jet.webreport.service.builder.ResourceTreeBuilder.getDefaultSetting().

Returns:

the cube tree root node, jet.webreport.util.JNode.

getCubeTreeNode

JNode getCubeTreeNode(java.lang.String rptset_id,
                      java.lang.String report_id,
                      java.lang.String rcName)

Gets the cube tree.

Parameters:

rptset_id - the report set id.

report_id - the report name.

rcName - the rc qualified name (formed by data source name, query name, rc name, with separator '.').

Returns:

the cube tree root node, jet.webreport.util.JNode.

getFlyFormula

FlyFormula getFlyFormula(java.lang.String reportId,
                         DHTMLFlyResourceScope scope,
                         java.lang.String rscQulifiedDisplayName)

Gets dynamic formula with the scope (report, data source, query).

An example of the method:

%serverhome%/public_html/dhtmljsp/dialogjsp/formula.jsp.

Parameters:

reportId - identifier of report set.

scope - on the fly formula scope, jet.webreport.beans.DHTMLFlyResourceScope.

rscQulifiedDisplayName - the qualified display name of the resource.

Returns:

FlyFormulaInfo. If not find corresponding dynamic formula, throws Exception.

getFlyMeasure

FlyMeasure getFlyMeasure(java.lang.String reportId,
                         DHTMLFlyResourceScope scope,
                         java.lang.String rscQulifiedDisplayName)

Gets dynamic measure with the scope (report, data source, query).

An example of the method:

%serverhome%/public_html/dhtmljsp/dialogjsp/measure.jsp.

Parameters:

reportId - identifier of the report set.

scope - on the fly formula scope, jet.webreport.beans.DHTMLFlyResourceScope.

rscQulifiedDisplayName - the qualified display name of the resource.

Returns:

FlyMeasureInfo. If not find the corresponding fly formula, throws Exception.

checkFlyResourceName

boolean checkFlyResourceName(java.lang.String reportId,
                             DHTMLFlyResourceScope scope,
                             java.lang.String rscQulifiedDisplayName)

Checks whether the rscQulifiedDisplayName of a dynamic resource is valid or not in current environment.

Parameters:

reportId - identifier of the report set.

scope - on the fly formula scope, jet.webreport.beans.DHTMLFlyResourceScope.

rscQulifiedDisplayName - the qualified display name of the resource.

Returns:

true if the rscQulifiedDisplayName is valid, false otherwise.

checkFlyFormulaSyntax

java.lang.String checkFlyFormulaSyntax(java.lang.String reportId,
                                       DHTMLFlyResourceScope scope,
                                       java.lang.String expression,
                                       java.lang.String blQulifyDisplayName)

Checks whether the fly formula has syntax error.

An example of the method:

%serverhome%/public_html/dhtmljsp/dialogjsp/check_fml_syntax.jsp.

Parameters:

reportId - identifier of the report set.

scope - on the fly formula scope, jet.webreport.beans.DHTMLFlyResourceScope.

expression - the formula expression.

blQulifyDisplayName - the qualified display name of the resource.

Returns:

null if no error, otherwise the exception string.

getAutoRefreshReportDataInfo

java.util.Hashtable getAutoRefreshReportDataInfo(java.lang.String sessionId,
                                                 java.lang.String rptSetId,
                                                 java.lang.String rptName)

Gets the information about auto refreshing report data.

An example of the method:

%serverhome%/public_html/dhtmljsp/actionjsp/change_auto_refresh_report_data.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

the information about auto refreshing report data includes enableRefreshReportDataFunction, autoRefreshReportDataMode and autoRefreshReportIntervalTimeMs.

getPreviousBusinessCubeName

java.lang.String getPreviousBusinessCubeName(java.lang.String sessionId,
                                             java.lang.String rptSetId)

Gets a Business Cube's BLName in previous DataContainerWizardInformation. BLName is the ID of the Business Cube in the catalog.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

Returns:

null or a blname.