|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface ReportInfo
Interface ReportInfo contains information of a report in the server.
| Method Summary | |
|---|---|
boolean |
canExportDHTMLResult()
Deprecated. Need to set the status for reports - APIConst.RPT_STATUS_CURRENT, APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL, or server will use APIConst.RPT_STATUS_ALL as default |
boolean |
canExportDHTMLResult(int status)
Checks if the report can export to DHTML result(.rsd result), this type of result can re-run as DHTML. |
java.lang.String[] |
getAllDataSource()
Deprecated. Need to set the status for reports - APIConst.RPT_STATUS_CURRENT, APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL, or server will use APIConst.RPT_STATUS_ALL as default |
java.lang.String[] |
getAllDataSource(int status)
Gets all datasource names of a report used. |
java.util.Vector |
getAvailableGroupFields()
Deprecated. You will not need to replace value options with available group fields when parameter is column.
Example: You can comment line in getRptDescPage.jsp like
//Vector grpCols = rptInfo.getAvailableGroupFields();
And you have to modify the java code in getRptDescPage.jsp from
<%
if (desc.isColumn() && grpCols != null) {
%>
<select name="<%= APIConst.TAG_PARAM_PREFIX + desc.getName()%>" size="1">
<% int sz1 = grpCols.size();
for (int i1 = 0; i1 < sz1; i1++) {
String s = (String)grpCols.elementAt(i1);
to become
<%
if (desc.isColumn() ) {
%>
<select name="<%= APIConst.TAG_PARAM_PREFIX + desc.getName()%>" size="1">
<% Vector v = desc.getValueOptions(Locale.getDefault());
int sz1 = v.size();
for (int i1 = 0; i1 < sz1; i1++) {
String s = (String)v.elementAt(i1);
|
java.util.Vector |
getAvailableLanguages()
Deprecated. Need to set the status for reports - APIConst.RPT_STATUS_CURRENT, APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL, or server will use APIConst.RPT_STATUS_ALL as default |
java.util.Vector |
getAvailableLanguages(int status)
Gets all of the Languages that current report supported. |
java.util.Vector |
getBooleanColumns()
Return boolean value fields of the report. |
ReportSheetInfo |
getCurrentReportSheet()
Deprecated. Need to set the status for reports - APIConst.RPT_STATUS_CURRENT, APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL, or server will use APIConst.RPT_STATUS_ALL as default |
ReportSheetInfo |
getCurrentReportSheet(int status)
Returns the current report sheet info. |
java.lang.String |
getDefaultStyleGroupName()
Deprecated. Need to set the status for reports - APIConst.RPT_STATUS_CURRENT, APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL, or server will use APIConst.RPT_STATUS_ALL as default |
java.lang.String |
getDefaultStyleGroupName(int status)
Gets default style group name. |
java.util.Vector |
getOrderOfParams()
Deprecated. Need to set the status for reports - APIConst.RPT_STATUS_CURRENT, APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL, or server will use APIConst.RPT_STATUS_ALL as default |
java.util.Vector |
getOrderOfParams(int status)
Return order of parameters of the report. |
java.lang.String |
getParamEngineId()
Deprecated. Need to set the status for reports - APIConst.RPT_STATUS_CURRENT, APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL, or server will use APIConst.RPT_STATUS_ALL as default |
java.lang.String |
getParamEngineId(int status)
Return the ID of engine which generates parameters. |
java.util.Vector |
getParamInfos()
Deprecated. Need to set the status for reports - APIConst.RPT_STATUS_CURRENT, APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL, or server will use APIConst.RPT_STATUS_ALL as default |
java.util.Vector |
getParamInfos(int status)
Return parameters of the report. |
java.util.Vector |
getParamInfosByParam(java.lang.String paramName,
java.lang.String value,
java.lang.String paramEngineId)
Return parameters of the report according to the name and the value of a certain parameter. |
java.util.Vector |
getParamInfosByParam(java.lang.String paramName,
java.lang.String value,
java.lang.String paramEngineId,
int status)
Return parameters of the report according to the name and the value of a certain parameter. |
java.util.Vector |
getParamInfosByValue(java.lang.String paramName,
java.lang.String[] values,
java.lang.String paramEngineId,
int status)
Return parameters of the report according to the name and the value of a certain parameter. |
java.util.Vector |
getParamInfosByValue(java.lang.String paramName,
java.lang.String value,
java.lang.String paramEngineId)
Return parameters of the report according to the name and the value of a certain parameter. |
java.util.Vector |
getParamInfosByValue(java.lang.String paramName,
java.lang.String value,
java.lang.String paramEngineId,
int status)
Return parameters of the report according to the name and the value of a certain parameter. |
java.util.Vector |
getReportFontFiles()
Gets font file names of a report. |
java.util.Vector |
getReportImageFiles()
Gets image file names of a report. |
java.util.Vector |
getReportSheetInfos()
Deprecated. Need to set the status for reports - APIConst.RPT_STATUS_CURRENT, APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL, or server will use APIConst.RPT_STATUS_ALL as default |
java.util.Vector |
getReportSheetInfos(int status)
Return information of report sheets of the report set. |
java.util.Vector |
getReportSubreports()
Gets sub-report names of a report. |
java.util.Map |
getSheetParamNames(int status)
Return all sheet and its parameters relation Map |
java.util.Vector |
getStyleGroupInfos()
Deprecated. Need to set the status for reports - APIConst.RPT_STATUS_CURRENT, APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL, or server will use APIConst.RPT_STATUS_ALL as default |
java.util.Vector |
getStyleGroupInfos(int status)
Return style group of the report. |
boolean |
hasPageSecurity()
Deprecated. Need to set the status for reports - APIConst.RPT_STATUS_CURRENT, APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL, or server will use APIConst.RPT_STATUS_ALL as default |
boolean |
hasPageSecurity(int status)
Checks if the report has page security. |
boolean |
hasReportParam()
Deprecated. Need to set the status for reports - APIConst.RPT_STATUS_CURRENT, APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL, or server will use APIConst.RPT_STATUS_ALL as default |
boolean |
hasReportParam(int status)
checks if reports in report set has parameters. |
boolean |
isPortletPreferred()
If the report set contains only one report sheet, and the report sheet is portlet preferred. |
void |
removeParamEngineById(java.lang.String paramEngineId)
Remove engine object according to the ID of engine which generates parameters. |
java.lang.String |
validateParameter(int status,
java.util.Properties prop)
Check parameters validation |
| Method Detail |
|---|
java.util.Vector getReportSheetInfos()
throws RptServerException
RptServerException - if a RptServerException occurs.ReportSheetInfo
java.util.Vector getReportSheetInfos(int status)
throws RptServerException
status - the status for reports - APIConst.RPT_STATUS_CURRENT,
APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL
RptServerException - if a RptServerException occurs.ReportSheetInfo
java.util.Vector getParamInfos()
throws RptServerException
RptServerException - if a RptServerException occurs.ParamInfo
java.util.Vector getParamInfos(int status)
throws RptServerException
status - the status for reports - APIConst.RPT_STATUS_CURRENT,
APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL
RptServerException - if a RptServerException occurs.ParamInfo
java.util.Vector getParamInfosByParam(java.lang.String paramName,
java.lang.String value,
java.lang.String paramEngineId)
throws RptServerException
paramName - the parameter name.value - the value of the parameter.paramEngineId - the ID of engine which generates parameters.
RptServerException - if a RptServerException occurs.ParamInfo
java.util.Vector getParamInfosByParam(java.lang.String paramName,
java.lang.String value,
java.lang.String paramEngineId,
int status)
throws RptServerException
paramName - the parameter name.value - the value of the parameter.paramEngineId - the ID of engine which generates parameters.status - the status for reports - APIConst.RPT_STATUS_CURRENT,
APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL
RptServerException - if a RptServerException occurs.
RptServerException
java.util.Vector getParamInfosByValue(java.lang.String paramName,
java.lang.String value,
java.lang.String paramEngineId)
throws RptServerException
paramName - the parameter name.value - the value of the parameter.paramEngineId - the ID of engine which generates parameters.
RptServerException - if a RptServerException occurs.ParamInfo
java.util.Vector getParamInfosByValue(java.lang.String paramName,
java.lang.String value,
java.lang.String paramEngineId,
int status)
throws RptServerException
paramName - the parameter name.value - the value of the parameter.paramEngineId - the ID of engine which generates parameters.status -
RptServerException - if a RptServerException occurs.
java.util.Vector getParamInfosByValue(java.lang.String paramName,
java.lang.String[] values,
java.lang.String paramEngineId,
int status)
throws RptServerException
paramName - the parameter name.values - the values of the parameter.paramEngineId - the ID of engine which generates parameters.status -
RptServerException - if a RptServerException occurs.
boolean hasReportParam()
throws RptServerException
RptServerException - if a RptServerException occurs.
boolean hasReportParam(int status)
throws RptServerException
status - the status for reports - APIConst.RPT_STATUS_CURRENT,
APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL
RptServerException
java.util.Map getSheetParamNames(int status)
throws RptServerException
status - the status for reports - APIConst.RPT_STATUS_CURRENT,
APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL
RptServerException
ReportSheetInfo getCurrentReportSheet()
throws RptServerException
RptServerException - if a RptServerException occurs.
ReportSheetInfo getCurrentReportSheet(int status)
throws RptServerException
status - the status for reports - APIConst.RPT_STATUS_CURRENT,
APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL
RptServerException - if a RptServerException occurs.
java.lang.String getParamEngineId()
throws RptServerException
RptServerException - if a RptServerException occurs.
java.lang.String getParamEngineId(int status)
throws RptServerException
status - the status for reports - APIConst.RPT_STATUS_CURRENT,
APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL
RptServerException - if a RptServerException occurs.
void removeParamEngineById(java.lang.String paramEngineId)
throws RptServerException
paramEngineId - the ID of engine which generates parameters.
RptServerException - if a RptServerException occurs.
java.util.Vector getAvailableGroupFields()
throws RptServerException
Example: You can comment line in getRptDescPage.jsp like
//Vector grpCols = rptInfo.getAvailableGroupFields();
And you have to modify the java code in getRptDescPage.jsp from
<%
if (desc.isColumn() && grpCols != null) {
%>
<select name="<%= APIConst.TAG_PARAM_PREFIX + desc.getName()%>" size="1">
<% int sz1 = grpCols.size();
for (int i1 = 0; i1 < sz1; i1++) {
String s = (String)grpCols.elementAt(i1);
to become
<%
if (desc.isColumn() ) {
%>
<select name="<%= APIConst.TAG_PARAM_PREFIX + desc.getName()%>" size="1">
<% Vector v = desc.getValueOptions(Locale.getDefault());
int sz1 = v.size();
for (int i1 = 0; i1 < sz1; i1++) {
String s = (String)v.elementAt(i1);
RptServerException - if a RptServerException occurs.
java.util.Vector getOrderOfParams()
throws RptServerException
RptServerException - if a RptServerException occurs.
java.util.Vector getOrderOfParams(int status)
throws RptServerException
status - the status for reports - APIConst.RPT_STATUS_CURRENT,
APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL
RptServerException - if a RptServerException occurs.
java.util.Vector getStyleGroupInfos()
throws RptServerException
RptServerException - if a RptServerException occurs.
java.util.Vector getStyleGroupInfos(int status)
throws RptServerException
status - the status for reports - APIConst.RPT_STATUS_CURRENT,
APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL
RptServerException - if a RptServerException occurs.
java.util.Vector getBooleanColumns()
throws RptServerException
RptServerException - if a RptServerException occurs.
java.util.Vector getAvailableLanguages()
throws RptServerException
RptServerException - if a RptServerException occurs.
java.util.Vector getAvailableLanguages(int status)
throws RptServerException
status - the status for reports - APIConst.RPT_STATUS_CURRENT,
APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL
RptServerException - if a RptServerException occurs.
boolean hasPageSecurity()
throws RptServerException
RptServerException - if a RptServerException occurs.
boolean hasPageSecurity(int status)
throws RptServerException
RptServerException - if a RptServerException occurs.
boolean canExportDHTMLResult()
throws RptServerException
RptServerException - if a RptServerException occurs.
boolean canExportDHTMLResult(int status)
throws RptServerException
status - the status for reports - APIConst.RPT_STATUS_CURRENT,
APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL
RptServerException - if a RptServerException occurs.
java.lang.String getDefaultStyleGroupName()
throws RptServerException
RptServerException - if a RptServerException occurs.
java.lang.String getDefaultStyleGroupName(int status)
throws RptServerException
status - the status for reports - APIConst.RPT_STATUS_CURRENT,
APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL
RptServerException - if a RptServerException occurs.
java.util.Vector getReportImageFiles()
throws RptServerException
RptServerException - if a RptServerException occurs.
java.util.Vector getReportFontFiles()
throws RptServerException
RptServerException - if a RptServerException occurs.
java.util.Vector getReportSubreports()
throws RptServerException
RptServerException - if a RptServerException occurs.
java.lang.String[] getAllDataSource()
throws RptServerException
RptServerException - if a RptServerException occurs.
java.lang.String[] getAllDataSource(int status)
throws RptServerException
status - the status for reports - APIConst.RPT_STATUS_CURRENT,
APIConst.RPT_STATUS_OPEN and APIConst.RPT_STATUS_ALL
RptServerException - if a RptServerException occurs.
boolean isPortletPreferred()
throws RptServerException
RptServerException - if a RptServerException occurs.
java.lang.String validateParameter(int status,
java.util.Properties prop)
throws RptServerException
status - prop -
RptServerException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||