com.businessobjects.sdk.plugin.desktop.fullclient
Interface IFullClientPrinterOptions

public interface IFullClientPrinterOptions

This interface allows you to set the printer options for a Desktop Intelligence document.

Nested Class Summary

static interface	IFullClientPrinterOptions.CePageSize Specified Report Page Size.
static interface	IFullClientPrinterOptions.CePrintCollateType Specifies the report print collation.
static interface	IFullClientPrinterOptions.CeReportLayout Specifies Report Layout.

Method Summary

int	getCopies() Returns the number of copies of the report to print.
int	getFromPage() Returns the start of the print range.
short	getPageHeight() Returns the page height in 0.1 millimeter increments.
int	getPageLayout() Returns the page layout for report.
int	getPageSize() Returns the page size for report.
short	getPageWidth() Returns the page width in 0.1 millimeter increments.
int	getPrintCollationType() Returns the print collation type for the report.
java.lang.String	getPrinterName() Returns the name of the printer.
int	getToPage() Returns the end of the print range.
boolean	isEnabled() Returns whether or not to print a report at a scheduled time.
boolean	isLandscapeMode() Returns true if the report will print in landscape mode, and false otherwise.
void	setCopies(int numCopies) Sets the number of copies of the report to print.
void	setEnabled(boolean DoPrint) Sets whether or not to print a report at a scheduled time.
void	setFromPage(int FromPage) Sets the start of the print range.
void	setLandscapeMode(boolean bLandscope) Sets whether the report will print in landscape mode, and false otherwise.
void	setPageHeight(short PageHeight) Sets the page height in 0.1 millimeter increments.
void	setPageLayout(int PageLayout) Sets the page layout for report.
void	setPageSize(int PageSize) Sets the page size for report.
void	setPageWidth(short PageWidth) Sets the page width in 0.1 millimeter increments.
void	setPrintCollationType(int PrintCollateType) Sets the print collation type for the report.
void	setPrinterName(java.lang.String PrinterName) Sets the name of the printer.
void	setToPage(int ToPage) Sets the end of the print range.

Method Detail

isEnabled

boolean isEnabled()
                  throws SDKException

Returns whether or not to print a report at a scheduled time.

Returns:

true if the report will print at a scheduled time, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setEnabled

void setEnabled(boolean DoPrint)
                throws SDKException

Sets whether or not to print a report at a scheduled time.

Parameters:

DoPrint - true if the report will print at a scheduled time, false otherwise.

Throws:

SDKException. - This is thrown if IFullClientPrinterOptions.CeReportLayout.NO_PRINTER_SETTING is specified for the report page layout, the user has no right, or the process is unsuccessful.

SDKException

getPrinterName

java.lang.String getPrinterName()
                                throws SDKException

Returns the name of the printer.

Returns:

A String specifying the name of the printer.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setPrinterName

void setPrinterName(java.lang.String PrinterName)
                    throws SDKException

Sets the name of the printer.

Parameters:

PrinterName - A String specifying the name of the printer.

Throws:

SDKException - This is thrown if user has no right

getCopies

int getCopies()
              throws SDKException

Returns the number of copies of the report to print.

Returns:

An int that specifies the number of copies of the report to print.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setCopies

void setCopies(int numCopies)
               throws SDKException

Sets the number of copies of the report to print.

Parameters:

numCopies - An int specifying the number of copies of the report to print.

Throws:

SDKException - This is thrown if user has no right

getFromPage

int getFromPage()
                throws SDKException

Returns the start of the print range.

Returns:

An int specifying the start of the print page.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setFromPage

void setFromPage(int FromPage)
                 throws SDKException

Sets the start of the print range.

Parameters:

FromPage - An int specifying the start of the print page.

Throws:

SDKException - This is thrown if user has no right.

getToPage

int getToPage()
              throws SDKException

Returns the end of the print range.

Returns:

An int specifying the end of the print range.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setToPage

void setToPage(int ToPage)
               throws SDKException

Sets the end of the print range.

Parameters:

ToPage - An int specifying the end of the print range.

Throws:

SDKException - This is thrown if user has no right.

getPageLayout

int getPageLayout()
                  throws SDKException

Returns the page layout for report.

Returns:

An int containing page layout type, this will be of type CeReportLayout.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IReportPrinterOptions.CeReportLayout

setPageLayout

void setPageLayout(int PageLayout)
                   throws SDKException

Sets the page layout for report.

Parameters:

PageLayout - An int specifying the layout of the report, this will be of type CeReportLayout.

Throws:

SDKException - This is thrown if printer destination is enabled or the process is unsuccessful.

See Also:

IReportPrinterOptions.CeReportLayout

getPageSize

int getPageSize()
                throws SDKException

Returns the page size for report. The default setting is 0.

Returns:

An int specifying page size of the report. This will be of type CePageSize.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IReportPrinterOptions.CePageSize

setPageSize

void setPageSize(int PageSize)
                 throws SDKException

Sets the page size for report. The default setting is 0.

Parameters:

PageSize - An int specifying the page size of the report. This will be of type CePageSize.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IReportPrinterOptions.CePageSize

getPageWidth

short getPageWidth()
                   throws SDKException

Returns the page width in 0.1 millimeter increments. The default setting is 0.

Returns:

A short specifying the page width in 0.1 millimeter increments.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setPageWidth

void setPageWidth(short PageWidth)

Sets the page width in 0.1 millimeter increments. The default setting is 0.

Parameters:

PageWidth - A short specifying the page width in 0.1 millimeter increments.

getPageHeight

short getPageHeight()
                    throws SDKException

Returns the page height in 0.1 millimeter increments.

Returns:

A short specifying the page height in 0.1 millimeter increments.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setPageHeight

void setPageHeight(short PageHeight)

Sets the page height in 0.1 millimeter increments.

Parameters:

PageHeight - A short specifying the page height in 0.1 millimeter increments.

isLandscapeMode

boolean isLandscapeMode()
                        throws SDKException

Returns true if the report will print in landscape mode, and false otherwise. The default value is false.

Returns:

true if the report will print in landscape mode, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setLandscapeMode

void setLandscapeMode(boolean bLandscope)

Sets whether the report will print in landscape mode, and false otherwise. The default value is false.

Parameters:

bLandscope - true if the report will print in landscape mode, and false otherwise.

getPrintCollationType

int getPrintCollationType()
                          throws SDKException

Returns the print collation type for the report.

Returns:

An int that contains the print collation type. This will be of type CePrintCollateType.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IReportPrinterOptions.CePrintCollateType.

setPrintCollationType

void setPrintCollationType(int PrintCollateType)

Sets the print collation type for the report.

Parameters:

PrintCollateType - An int that specifies the collation type.

See Also:

IReportPrinterOptions.CePrintCollateType.