com.ibm.tivoli.maximo.report.birt.design

Interface ReportDesign

public interface ReportDesign

An interface class used to get access to the report design information. NOTE: The actual implementation of this interface is provided by a OSGi bundle that's packaged as part of the BIRT report platform bundles.

Method Summary

Modifier and Type	Method and Description
boolean	changeBidiProperties(java.lang.String orientation, java.lang.String textDirection)
void	changeParameterPattern(java.lang.String paramName, java.lang.String category, java.lang.String pattern) Changes the report design parameter information.
void	close() Closes the report design and releases any resources used.
java.lang.String	getDescription() Returns the description used by the report (long description)
java.lang.String	getIncludedResourceFileName() Returns the name of the included resource file.
ReportLabelInfo[]	getLabelInfo() Returns report labels used within the report.
ReportLibraryInfo[]	getLibraryInfo() Returns report dependent library information.
ReportParameterInfo[]	getParameterInfo() Returns report parameter information.
java.lang.String	getReportFolder() Returns the report folder name.
java.lang.String	getTitle() Returns the title used by the report (brief description).
void	save() Saves the changes made to the report design.

Method Detail

getTitle

java.lang.String getTitle()

Returns the title used by the report (brief description).

Returns:

getDescription

java.lang.String getDescription()

Returns the description used by the report (long description)

Returns:

getReportFolder

java.lang.String getReportFolder()

Returns the report folder name.

Returns:

getParameterInfo

ReportParameterInfo[] getParameterInfo()
                                throws BirtReportDesignException

Returns report parameter information.

Returns:

Throws:

BirtReportDesignException

getLibraryInfo

ReportLibraryInfo[] getLibraryInfo()
                            throws BirtReportDesignException

Returns report dependent library information.

Returns:

Throws:

BirtReportDesignException

getLabelInfo

ReportLabelInfo[] getLabelInfo()
                        throws BirtReportDesignException

Returns report labels used within the report.

Returns:

Throws:

BirtReportDesignException

getIncludedResourceFileName

java.lang.String getIncludedResourceFileName()
                                      throws BirtReportDesignException

Returns the name of the included resource file.

Returns:

included resource file name

Throws:

BirtReportDesignException

close

void close()
    throws BirtReportDesignException

Closes the report design and releases any resources used.

Throws:

BirtReportDesignException

changeParameterPattern

void changeParameterPattern(java.lang.String paramName,
                            java.lang.String category,
                            java.lang.String pattern)
                     throws BirtReportDesignException

Changes the report design parameter information.

Parameters:

paramName -

category -

pattern -

Throws:

BirtReportDesignException

save

void save()
   throws BirtReportDesignException

Saves the changes made to the report design.

Throws:

BirtReportDesignException

changeBidiProperties

boolean changeBidiProperties(java.lang.String orientation,
                             java.lang.String textDirection)