com.konakartadmin.app

Class AdminPdfOptions

java.lang.Object

com.konakartadmin.app.AdminPdfOptions

public class AdminPdfOptions
extends java.lang.Object

AdminPdfOptions object for the Admin App

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 int	id Unspecified id, usually the OrderId
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 - used when type == KKConstants.HTML_NAMED_TEMPLATE
private int	type request type

Constructor Summary

Constructors

Constructor and Description
AdminPdfOptions() Instantiates an AdminAddressSearch object - a requirement for a bean class

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCustom1()
java.lang.String	getCustom2()
int	getId()
int	getLanguageId()
java.lang.String	getTargetFileName()
java.lang.String	getTemplateName()
int	getType()
boolean	isCreateFile()
boolean	isReturnBytes()
boolean	isReturnFileName()
void	setCreateFile(boolean createFile)
void	setCustom1(java.lang.String custom1)
void	setCustom2(java.lang.String custom2)
void	setId(int id)
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 - used when type == KKConstants.HTML_NAMED_TEMPLATE

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.

custom1

private java.lang.String custom1

custom1

custom2

private java.lang.String custom2

custom2

Constructor Detail

AdminPdfOptions

public AdminPdfOptions()

Instantiates an AdminAddressSearch 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 TaxRateSearch object.

toStringBrief

public java.lang.String toStringBrief()

Returns:

Returns a string containing the attributes of the TaxRate object.

getId

public int getId()

Returns:

Returns the id.

setId

public void setId(int id)

Parameters:

id - The id to set.

getCustom1

public java.lang.String getCustom1()

Returns:

the custom1

setCustom1

public void setCustom1(java.lang.String custom1)

Parameters:

custom1 - the custom1 to set

getCustom2

public java.lang.String getCustom2()

Returns:

the custom2

setCustom2

public void setCustom2(java.lang.String custom2)

Parameters:

custom2 - the custom2 to set

getLanguageId

public int getLanguageId()

Returns:

the Language Id

setLanguageId

public void setLanguageId(int languageId)

Parameters:

languageId - the languageId

getType

public int getType()

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)

Parameters:

type - the type

isReturnFileName

public boolean isReturnFileName()

Returns:

whether the File Name should be returned

setReturnFileName

public void setReturnFileName(boolean returnFileName)

Parameters:

returnFileName - the returnFileName

isReturnBytes

public boolean isReturnBytes()

Returns:

whether the bytes of the PDF file should be returned

setReturnBytes

public void setReturnBytes(boolean returnBytes)

Parameters:

returnBytes - the returnBytes

isCreateFile

public boolean isCreateFile()

Returns:

the createFile

setCreateFile

public void setCreateFile(boolean createFile)

Parameters:

createFile - the createFile to set

getTargetFileName

public java.lang.String getTargetFileName()

Returns:

the targetFileName

setTargetFileName

public void setTargetFileName(java.lang.String targetFileName)

Parameters:

targetFileName - the targetFileName to set

getTemplateName

public java.lang.String getTemplateName()

Returns:

the templateName

setTemplateName

public 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.