com.haulmont.yarg.structure

Interface ReportTemplate

All Superinterfaces:

java.io.Serializable

public interface ReportTemplate
extends java.io.Serializable

This interface describes report template document.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_TEMPLATE_CODE

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode()
CustomReport	getCustomReport()
java.io.InputStream	getDocumentContent()
java.lang.String	getDocumentName()
java.lang.String	getDocumentPath()
java.lang.String	getOutputNamePattern()
ReportOutputType	getOutputType()
boolean	isCustom()

Field Detail

DEFAULT_TEMPLATE_CODE

static final java.lang.String DEFAULT_TEMPLATE_CODE

See Also:

Constant Field Values

Method Detail

getCode

java.lang.String getCode()

getDocumentName

java.lang.String getDocumentName()

getDocumentPath

java.lang.String getDocumentPath()

getDocumentContent

java.io.InputStream getDocumentContent()

Returns:

stream containing resulting document

getOutputType

ReportOutputType getOutputType()

Returns:

output type of for this template

getOutputNamePattern

java.lang.String getOutputNamePattern()

Returns:

name pattern for generating document. Example: ${Band1.FILE_NAME} or myDocument.doc

isCustom

boolean isCustom()

Returns:

if report is defined by custom class. In this case band data will be passed in com.haulmont.yarg.structure.ReportTemplate#getCustomReport() object and it will generate binary.

getCustomReport

CustomReport getCustomReport()

Returns:

implementation of custom report logic.