com.konakart.appif

Interface PdfOptionsIf

All Known Implementing Classes:

PdfOptions

public interface PdfOptionsIf

Options when producing a PDF document.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCustom1()
java.lang.String	getCustom2()
java.lang.String	getHtml()
int	getId()
int	getLanguageId()
java.lang.String	getTargetFileName()
java.lang.String	getTemplateName()
int	getType()
boolean	isCreateFile()
boolean	isIncludeAllChildrenCustomerOrders() Includes all orders of the customer's children, grandchildren etc.
boolean	isIncludeChildrenCustomerOrders() Includes all orders of the customers direct children, but not from any children they may have
boolean	isIncludeParentCustomerOrders() Includes all orders of the customer's parent
boolean	isIncludeSiblingCustomerOrders() Includes all orders of the customer's siblings (customers sharing the same parent customer)
boolean	isReturnBytes()
boolean	isReturnFileName()
void	setCreateFile(boolean createFile)
void	setCustom1(java.lang.String custom1)
void	setCustom2(java.lang.String custom2)
void	setHtml(java.lang.String html)
void	setId(int id)
void	setIncludeAllChildrenCustomerOrders(boolean includeAllChildrenCustomerOrders) Includes all orders of the customer's children, grandchildren etc.
void	setIncludeChildrenCustomerOrders(boolean includeChildrenCustomerOrders) Includes all orders of the customers direct children, but not from any children they may have
void	setIncludeParentCustomerOrders(boolean includeParentCustomerOrders) Includes all orders of the customer's parent
void	setIncludeSiblingCustomerOrders(boolean includeSiblingCustomerOrders) Includes all orders of the customer's siblings (customers sharing the same parent customer)
void	setLanguageId(int languageId)
void	setReturnBytes(boolean returnBytes)
void	setReturnFileName(boolean returnFileName)
void	setTargetFileName(java.lang.String targetFileName)
void	setTemplateName(java.lang.String templateName)
void	setType(int type) Request type

Method Detail

getId

int getId()

Returns:

Returns the id.

setId

void setId(int id)

Parameters:

id - The id to set.

getCustom1

java.lang.String getCustom1()

Returns:

the custom1

setCustom1

void setCustom1(java.lang.String custom1)

Parameters:

custom1 - the custom1 to set

getCustom2

java.lang.String getCustom2()

Returns:

the custom2

setCustom2

void setCustom2(java.lang.String custom2)

Parameters:

custom2 - the custom2 to set

getLanguageId

int getLanguageId()

Returns:

the Language Id

setLanguageId

void setLanguageId(int languageId)

Parameters:

languageId - the languageId

getType

int getType()

Returns:

the report type

setType

void setType(int type)

Request type

"HTML types" can be one of:

• KKConstants.HTML_ORDER_DETAIL (= 1)
• KKConstants.HTML_ORDER_INVOICE (= 2)
• KKConstants.HTML_ORDER_PACKING_LIST (= 3)
• KKConstants.HTML_NAMED_TEMPLATE (= 9)

Parameters:

type - the type

isReturnFileName

boolean isReturnFileName()

Returns:

whether the File Name should be returned

setReturnFileName

void setReturnFileName(boolean returnFileName)

Parameters:

returnFileName - the returnFileName

isReturnBytes

boolean isReturnBytes()

Returns:

whether the bytes of the PDF file should be returned

setReturnBytes

void setReturnBytes(boolean returnBytes)

Parameters:

returnBytes - the returnBytes

isCreateFile

boolean isCreateFile()

Returns:

the createFile

setCreateFile

void setCreateFile(boolean createFile)

Parameters:

createFile - the createFile to set

getTargetFileName

java.lang.String getTargetFileName()

Returns:

the targetFileName

setTargetFileName

void setTargetFileName(java.lang.String targetFileName)

Parameters:

targetFileName - the targetFileName to set

getTemplateName

java.lang.String getTemplateName()

Returns:

the templateName

setTemplateName

void setTemplateName(java.lang.String templateName)

Parameters:

templateName - the templateName to set. If the type is set to KKConstants.HTML_NAMED_TEMPLATE the templateName will be used as the template.

isIncludeParentCustomerOrders

boolean isIncludeParentCustomerOrders()

Includes all orders of the customer's parent

Returns:

the includeParentCustomerOrders

setIncludeParentCustomerOrders

void setIncludeParentCustomerOrders(boolean includeParentCustomerOrders)

Includes all orders of the customer's parent

Parameters:

includeParentCustomerOrders - the includeParentCustomerOrders to set

isIncludeSiblingCustomerOrders

boolean isIncludeSiblingCustomerOrders()

Includes all orders of the customer's siblings (customers sharing the same parent customer)

Returns:

the includeSiblingCustomerOrders

setIncludeSiblingCustomerOrders

void setIncludeSiblingCustomerOrders(boolean includeSiblingCustomerOrders)

Includes all orders of the customer's siblings (customers sharing the same parent customer)

Parameters:

includeSiblingCustomerOrders - the includeSiblingCustomerOrders to set

isIncludeChildrenCustomerOrders

boolean isIncludeChildrenCustomerOrders()

Includes all orders of the customers direct children, but not from any children they may have

Returns:

the includeChildrenCustomerOrders

setIncludeChildrenCustomerOrders

void setIncludeChildrenCustomerOrders(boolean includeChildrenCustomerOrders)

Includes all orders of the customers direct children, but not from any children they may have

Parameters:

includeChildrenCustomerOrders - the includeChildrenCustomerOrders to set

isIncludeAllChildrenCustomerOrders

boolean isIncludeAllChildrenCustomerOrders()

Includes all orders of the customer's children, grandchildren etc.

Returns:

the includeAllChildrenCustomerOrders

setIncludeAllChildrenCustomerOrders

void setIncludeAllChildrenCustomerOrders(boolean includeAllChildrenCustomerOrders)

Includes all orders of the customer's children, grandchildren etc.

Parameters:

includeAllChildrenCustomerOrders - the includeAllChildrenCustomerOrders to set

getHtml

java.lang.String getHtml()

Returns:

the html

setHtml

void setHtml(java.lang.String html)

Parameters:

html - the html to set