PdfOptions (KonaKartAdmin API Documentation)

java.lang.Object
- com.konakart.app.PdfOptions

All Implemented Interfaces:

PdfOptionsIf
```
public class PdfOptions
extends java.lang.Object
implements PdfOptionsIf
```
PdfOptions object for the creation of PDF documents

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`createFile` Set to true to create a PDF file on disk.
`private java.lang.String`	`custom1` custom1
`private java.lang.String`	`custom2` custom2
`private java.lang.String`	`html` html
`private int`	`id` Unspecified id, usually the OrderId
`private boolean`	`includeAllChildrenCustomerOrders` Includes all orders of the customer's children, grandchildren etc.
`private boolean`	`includeChildrenCustomerOrders` Includes all orders of the customers direct children, but not from any children they may have
`private boolean`	`includeParentCustomerOrders` Includes all orders of the customer's parent
`private boolean`	`includeSiblingCustomerOrders` Includes all orders of the customer's siblings (customers sharing the same parent customer)
`private int`	`languageId` Language Id
`private boolean`	`returnBytes` return an array of bytes representing the PDF file.
`private boolean`	`returnFileName` return a String containing a Full File Name for accessing the PDF file created
`private java.lang.String`	`targetFileName` If a PDF file is defined to be created (see createFile), this will be the name for the new file.
`private java.lang.String`	`templateName` templateName
`private int`	`type` Request type

Constructor Summary

Constructors
Constructor and Description

PdfOptions()
Instantiates a PdfOptions object - a requirement for a bean class

Constructors
Constructor and Description
`PdfOptions()` Instantiates a PdfOptions object - a requirement for a bean class

Method Summary

All Methods Instance Methods Concrete Methods
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
`java.lang.String`	`toString()`
`java.lang.String`	`toStringBrief()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - id
```
private int id
```
    Unspecified id, usually the OrderId
  - languageId
```
private int languageId
```
    Language Id
  - type
```
private int type
```
    Request type
  - createFile
```
private boolean createFile
```
    Set to true to create a PDF file on disk. If set to false a temporary file is created but it's deleted before returning from the engine.
  - templateName
```
private java.lang.String templateName
```
    templateName
  - targetFileName
```
private java.lang.String targetFileName
```
    If a PDF file is defined to be created (see createFile), this will be the name for the new file. If this is null, and a new file is to be created, the file name will be generated by KonaKart.
  - returnFileName
```
private boolean returnFileName
```
    return a String containing a Full File Name for accessing the PDF file created
  - returnBytes
```
private boolean returnBytes
```
    return an array of bytes representing the PDF file.
  - includeParentCustomerOrders
```
private boolean includeParentCustomerOrders
```
    Includes all orders of the customer's parent
  - includeSiblingCustomerOrders
```
private boolean includeSiblingCustomerOrders
```
    Includes all orders of the customer's siblings (customers sharing the same parent customer)
  - includeChildrenCustomerOrders
```
private boolean includeChildrenCustomerOrders
```
    Includes all orders of the customers direct children, but not from any children they may have
  - includeAllChildrenCustomerOrders
```
private boolean includeAllChildrenCustomerOrders
```
    Includes all orders of the customer's children, grandchildren etc.
  - custom1
```
private java.lang.String custom1
```
    custom1
  - custom2
```
private java.lang.String custom2
```
    custom2
  - html
```
private java.lang.String html
```
    html
- Constructor Detail
  - PdfOptions
```
public PdfOptions()
```
    Instantiates a PdfOptions object - a requirement for a bean class
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Returns a string containing the attributes of the PdfOptions object.
  - toStringBrief
```
public java.lang.String toStringBrief()
```
    Returns:
    
    Returns a string containing the attributes of the TaxRate object.
  - getId
```
public int getId()
```
    Specified by:
    
    getId in interface PdfOptionsIf
    
    Returns:
    
    Returns the id.
  - setId
```
public void setId(int id)
```
    Specified by:
    
    setId in interface PdfOptionsIf
    
    Parameters:
    
    id - The id to set.
  - getCustom1
```
public java.lang.String getCustom1()
```
    Specified by:
    
    getCustom1 in interface PdfOptionsIf
    
    Returns:
    
    the custom1
  - setCustom1
```
public void setCustom1(java.lang.String custom1)
```
    Specified by:
    
    setCustom1 in interface PdfOptionsIf
    
    Parameters:
    
    custom1 - the custom1 to set
  - getCustom2
```
public java.lang.String getCustom2()
```
    Specified by:
    
    getCustom2 in interface PdfOptionsIf
    
    Returns:
    
    the custom2
  - setCustom2
```
public void setCustom2(java.lang.String custom2)
```
    Specified by:
    
    setCustom2 in interface PdfOptionsIf
    
    Parameters:
    
    custom2 - the custom2 to set
  - getLanguageId
```
public int getLanguageId()
```
    Specified by:
    
    getLanguageId in interface PdfOptionsIf
    
    Returns:
    
    the Language Id
  - setLanguageId
```
public void setLanguageId(int languageId)
```
    Specified by:
    
    setLanguageId in interface PdfOptionsIf
    
    Parameters:
    
    languageId - the languageId
  - getType
```
public int getType()
```
    Specified by:
    
    getType in interface PdfOptionsIf
    
    Returns:
    
    the report type
  - setType
```
public 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)
    Specified by:
    
    setType in interface PdfOptionsIf
    
    Parameters:
    
    type - the type
  - isReturnFileName
```
public boolean isReturnFileName()
```
    Specified by:
    
    isReturnFileName in interface PdfOptionsIf
    
    Returns:
    
    whether the File Name should be returned
  - setReturnFileName
```
public void setReturnFileName(boolean returnFileName)
```
    Specified by:
    
    setReturnFileName in interface PdfOptionsIf
    
    Parameters:
    
    returnFileName - the returnFileName
  - isReturnBytes
```
public boolean isReturnBytes()
```
    Specified by:
    
    isReturnBytes in interface PdfOptionsIf
    
    Returns:
    
    whether the bytes of the PDF file should be returned
  - setReturnBytes
```
public void setReturnBytes(boolean returnBytes)
```
    Specified by:
    
    setReturnBytes in interface PdfOptionsIf
    
    Parameters:
    
    returnBytes - the returnBytes
  - isCreateFile
```
public boolean isCreateFile()
```
    Specified by:
    
    isCreateFile in interface PdfOptionsIf
    
    Returns:
    
    the createFile
  - setCreateFile
```
public void setCreateFile(boolean createFile)
```
    Specified by:
    
    setCreateFile in interface PdfOptionsIf
    
    Parameters:
    
    createFile - the createFile to set
  - getTargetFileName
```
public java.lang.String getTargetFileName()
```
    Specified by:
    
    getTargetFileName in interface PdfOptionsIf
    
    Returns:
    
    the targetFileName
  - setTargetFileName
```
public void setTargetFileName(java.lang.String targetFileName)
```
    Specified by:
    
    setTargetFileName in interface PdfOptionsIf
    
    Parameters:
    
    targetFileName - the targetFileName to set
  - getTemplateName
```
public java.lang.String getTemplateName()
```
    Specified by:
    
    getTemplateName in interface PdfOptionsIf
    
    Returns:
    
    the templateName
  - setTemplateName
```
public void setTemplateName(java.lang.String templateName)
```
    Specified by:
    
    setTemplateName in interface PdfOptionsIf
    
    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
```
public boolean isIncludeParentCustomerOrders()
```
    Includes all orders of the customer's parent
    
    Specified by:
    
    isIncludeParentCustomerOrders in interface PdfOptionsIf
    
    Returns:
    
    the includeParentCustomerOrders
  - setIncludeParentCustomerOrders
```
public void setIncludeParentCustomerOrders(boolean includeParentCustomerOrders)
```
    Includes all orders of the customer's parent
    
    Specified by:
    
    setIncludeParentCustomerOrders in interface PdfOptionsIf
    
    Parameters:
    
    includeParentCustomerOrders - the includeParentCustomerOrders to set
  - isIncludeSiblingCustomerOrders
```
public boolean isIncludeSiblingCustomerOrders()
```
    Includes all orders of the customer's siblings (customers sharing the same parent customer)
    
    Specified by:
    
    isIncludeSiblingCustomerOrders in interface PdfOptionsIf
    
    Returns:
    
    the includeSiblingCustomerOrders
  - setIncludeSiblingCustomerOrders
```
public void setIncludeSiblingCustomerOrders(boolean includeSiblingCustomerOrders)
```
    Includes all orders of the customer's siblings (customers sharing the same parent customer)
    
    Specified by:
    
    setIncludeSiblingCustomerOrders in interface PdfOptionsIf
    
    Parameters:
    
    includeSiblingCustomerOrders - the includeSiblingCustomerOrders to set
  - isIncludeAllChildrenCustomerOrders
```
public boolean isIncludeAllChildrenCustomerOrders()
```
    Includes all orders of the customer's children, grandchildren etc.
    
    Specified by:
    
    isIncludeAllChildrenCustomerOrders in interface PdfOptionsIf
    
    Returns:
    
    the includeAllChildrenCustomerOrders
  - setIncludeAllChildrenCustomerOrders
```
public void setIncludeAllChildrenCustomerOrders(boolean includeAllChildrenCustomerOrders)
```
    Includes all orders of the customer's children, grandchildren etc.
    
    Specified by:
    
    setIncludeAllChildrenCustomerOrders in interface PdfOptionsIf
    
    Parameters:
    
    includeAllChildrenCustomerOrders - the includeAllChildrenCustomerOrders to set
  - isIncludeChildrenCustomerOrders
```
public boolean isIncludeChildrenCustomerOrders()
```
    Includes all orders of the customers direct children, but not from any children they may have
    
    Specified by:
    
    isIncludeChildrenCustomerOrders in interface PdfOptionsIf
    
    Returns:
    
    the includeChildrenCustomerOrders
  - setIncludeChildrenCustomerOrders
```
public void setIncludeChildrenCustomerOrders(boolean includeChildrenCustomerOrders)
```
    Includes all orders of the customers direct children, but not from any children they may have
    
    Specified by:
    
    setIncludeChildrenCustomerOrders in interface PdfOptionsIf
    
    Parameters:
    
    includeChildrenCustomerOrders - the includeChildrenCustomerOrders to set
  - getHtml
```
public java.lang.String getHtml()
```
    Specified by:
    
    getHtml in interface PdfOptionsIf
    
    Returns:
    
    the html
  - setHtml
```
public void setHtml(java.lang.String html)
```
    Specified by:
    
    setHtml in interface PdfOptionsIf
    
    Parameters:
    
    html - the html to set

Class PdfOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

languageId

type

createFile

templateName

targetFileName

returnFileName

returnBytes

includeParentCustomerOrders

includeSiblingCustomerOrders

includeChildrenCustomerOrders

includeAllChildrenCustomerOrders

custom1

custom2

html

Constructor Detail

PdfOptions

Method Detail

toString

toStringBrief

getId

setId

getCustom1

setCustom1

getCustom2

setCustom2

getLanguageId

setLanguageId

getType

setType

isReturnFileName

setReturnFileName

isReturnBytes

setReturnBytes

isCreateFile

setCreateFile

getTargetFileName

setTargetFileName

getTemplateName

setTemplateName

isIncludeParentCustomerOrders

setIncludeParentCustomerOrders

isIncludeSiblingCustomerOrders

setIncludeSiblingCustomerOrders

isIncludeAllChildrenCustomerOrders

setIncludeAllChildrenCustomerOrders

isIncludeChildrenCustomerOrders

setIncludeChildrenCustomerOrders

getHtml

setHtml