Report (Technia Value Components (2021.1.0) API Documentation

All Known Implementing Classes:

CustomReport, MultiReportCreator, ReportBase, TableBeanBasedCustomReport
```
public interface Report
```
A report holds all information required for being able to create a report.
Typically a Report instance is created from a ReportDef, however, it is also possible to create a report instance without a corresponding definition instance.

Since:

6.4.0

See Also:

ReportDef

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addSourceObject(com.technia.tvc.reportgenerator.ObjectRef objectRef)` Adds a source object to this report
`void`	`addSourceObject(java.lang.String objectId)` Adds a source object to this report
`Handle`	`createReport()` Creates the report.
`java.lang.String`	`getContentType()`
`com.technia.tvc.reportgenerator.ContextProvider`	`getContextProvider()`
`Converter`	`getConverter()`
`java.util.Date`	`getCreateDate()`
`DataExtractor`	`getDataExtractor()`
`java.lang.String`	`getDownloadURL()` Returns the URL of the report download page.
`java.lang.String`	`getFileName()`
`Format`	`getFormat()`
`java.lang.String`	`getId()`
`java.util.Locale`	`getLocale()`
`java.lang.String`	`getName()`
`OutputHandler[]`	`getOutputHandlers()`
`PostProcessor[]`	`getPostProcessors()`
`PreProcessor`	`getPreProcessor()`
`com.technia.tvc.reportgenerator.ObjectRef`	`getReportDef()`
`ReportSettings`	`getSettings()`
`com.technia.tvc.reportgenerator.ObjectRef`	`getSourceObject()`
`int`	`getSourceObjectCount()`
`java.util.Iterator<com.technia.tvc.reportgenerator.ObjectRef>`	`getSourceObjects()`
`java.lang.String`	`getStyleSheet()`
`void`	`handleParameters(java.lang.String name, java.lang.String[] values)` All parameters submitted from a pre-process page are handled by this method.
`boolean`	`hasSourceObject()`
`boolean`	`isSerializable()`
`com.technia.tvc.reportgenerator.ObjectRef`	`removeSourceObject(java.lang.String id)` Removes a source object with the given id.
`void`	`removeSourceObjects()` Remove all source objects.
`void`	`setContentType(java.lang.String contentType)` This method can be used to explicitly specify the content type of the generated report
`void`	`setDisableConverter(boolean disable)` This method can be called explicitly to disable the conversion
`void`	`setDisableOutputHandlers(boolean disable)` This method can be called explicitly to disable any output handlers being specified on the report definition.
`void`	`setDisablePostProcessors(boolean disable)` This method can be used to explicitly disable all the post-processors defined on this report.
`void`	`setEnqueuer(com.technia.tvc.reportgenerator.Enqueuer enqueuer)` Allows custom code to use a specialized `Enqueuer`, which knows how the report will be created
`void`	`setFileName(java.lang.String fileName)` This method can be used to explicitly set the file name of the generated report.

- Method Detail
  - getId
```
java.lang.String getId()
```
    Returns:
    
    The ID of this report
  - getName
```
java.lang.String getName()
```
    Returns:
    
    The name of this report
  - getSettings
```
ReportSettings getSettings()
```
    Returns:
    
    The report settings
  - getFormat
```
Format getFormat()
```
    Returns:
    
    The format that the generated report has
  - getLocale
```
java.util.Locale getLocale()
```
    Returns:
    
    The current locale (typically the locale that the user creating the report has)
  - getCreateDate
```
java.util.Date getCreateDate()
```
    Returns:
    
    The date when the report is created
  - hasSourceObject
```
boolean hasSourceObject()
```
    Returns:
    
    True if getSourceObjectCount() is greater than zero.
  - addSourceObject
```
void addSourceObject(java.lang.String objectId)
              throws TVCException
```
    Adds a source object to this report
    
    Parameters:
    
    objectId - The id of the object to add
    
    Throws:
    
    TVCException - If the id is invalid
  - addSourceObject
```
void addSourceObject(com.technia.tvc.reportgenerator.ObjectRef objectRef)
```
    Adds a source object to this report
    
    Parameters:
    
    objectRef - An ObjectRef representing the source object
  - getSourceObjectCount
```
int getSourceObjectCount()
```
    Returns:
    
    The number of source objects.
  - getSourceObject
```
com.technia.tvc.reportgenerator.ObjectRef getSourceObject()
```
    Returns:
    
    The first source object (as a ObjectRef instance}
  - getSourceObjects
```
java.util.Iterator<com.technia.tvc.reportgenerator.ObjectRef> getSourceObjects()
```
    Returns:
    
    An Iterator containing all source objects, if any,
  - removeSourceObject
```
com.technia.tvc.reportgenerator.ObjectRef removeSourceObject(java.lang.String id)
```
    Removes a source object with the given id.
    
    Parameters:
    
    id - The id of the object
    
    Returns:
    
    The ObjectRef or null if no such object is part of the source object collection.
    
    Since:
    
    2011.2.0
  - removeSourceObjects
```
void removeSourceObjects()
```
    Remove all source objects.
    
    Since:
    
    2011.2.0
  - getReportDef
```
com.technia.tvc.reportgenerator.ObjectRef getReportDef()
```
    Returns:
    
    The report definition (if such were used) as a ObjectRef
  - getContextProvider
```
com.technia.tvc.reportgenerator.ContextProvider getContextProvider()
```
    Returns:
    
    The ContextProvider. NOTE: This method is only used internally within the report generator and should normally not be used
  - getDataExtractor
```
DataExtractor getDataExtractor()
```
    Returns:
    
    The DataExtractor used by this report
  - getFileName
```
java.lang.String getFileName()
```
    Returns:
    
    The name of the generated file.
  - setFileName
```
void setFileName(java.lang.String fileName)
```
    This method can be used to explicitly set the file name of the generated report.
    
    Parameters:
    
    fileName - The name of the file
  - setContentType
```
void setContentType(java.lang.String contentType)
```
    This method can be used to explicitly specify the content type of the generated report
    
    Parameters:
    
    contentType - The content type
  - getContentType
```
java.lang.String getContentType()
```
    Returns:
    
    The content type of the generated report
  - getStyleSheet
```
java.lang.String getStyleSheet()
```
    Returns:
    
    The name of the stylesheet being used; if any.
  - setDisableConverter
```
void setDisableConverter(boolean disable)
```
    This method can be called explicitly to disable the conversion
    Typically, this method is called from a test class used during development in order to not have to create a specific report definition used for testing
    
    Parameters:
    
    disable - True to disable
  - getConverter
```
Converter getConverter()
```
    Returns:
    
    The Converter being used.
  - setDisableOutputHandlers
```
void setDisableOutputHandlers(boolean disable)
```
    This method can be called explicitly to disable any output handlers being specified on the report definition.
    Typically, this method is called from a test class used during development in order to not have to create a specific report definition used for testing
    
    Parameters:
    
    disable - True to disable
  - getOutputHandlers
```
OutputHandler[] getOutputHandlers()
```
    Returns:
    
    The output handlers defined for this report.
  - getPostProcessors
```
PostProcessor[] getPostProcessors()
```
    Returns:
    
    The post processors defined for this report
  - setDisablePostProcessors
```
void setDisablePostProcessors(boolean disable)
```
    This method can be used to explicitly disable all the post-processors defined on this report.
    Typically, this method is called from a test class used during development in order to not have to create a specific report definition used for testing
    
    Parameters:
    
    disable - True to disable
  - getPreProcessor
```
PreProcessor getPreProcessor()
```
    Returns:
    
    The PreProcessor attached to this report (if any)
  - handleParameters
```
void handleParameters(java.lang.String name,
                      java.lang.String[] values)
```
    All parameters submitted from a pre-process page are handled by this method. E.g. the parameter names/values within the request from a pre-process page is passed to this method.
    
    Parameters:
    
    name - The name of the parameter
    
    values - The values
  - isSerializable
```
boolean isSerializable()
```
    Returns:
    
    TRUE if the report is serializable; e.g. the report is able to execute in a so called report queue. Normally, this method returns true, however, subclasses can override this to force not being executed within an external report queue.
  - createReport
```
Handle createReport()
             throws TVCException
```
    Creates the report. Note that the report might be created asynchronously, hence, you must query the returned Handle for completion
    
    Returns:
    
    The Handle
    
    Throws:
    
    TVCException
    
    Since:
    
    2011.2.0
  - setEnqueuer
```
void setEnqueuer(com.technia.tvc.reportgenerator.Enqueuer enqueuer)
```
    Allows custom code to use a specialized Enqueuer, which knows how the report will be created
    
    Parameters:
    
    enqueuer - The Enqueuer instance.
    
    Since:
    
    2011.2.0
  - getDownloadURL
```
java.lang.String getDownloadURL()
```
    Returns the URL of the report download page. This allows report developers to customize which page the report is downloaded from. If this method returns null the standard download page will be used.
    
    Returns:
    
    The custom download URL.
    
    Since:
    
    2011.2.0

Interface Report

Method Summary

Method Detail

getId

getName

getSettings

getFormat

getLocale

getCreateDate

hasSourceObject

addSourceObject

addSourceObject

getSourceObjectCount

getSourceObject

getSourceObjects

removeSourceObject

removeSourceObjects

getReportDef

getContextProvider

getDataExtractor

getFileName

setFileName

setContentType

getContentType

getStyleSheet

setDisableConverter

getConverter

setDisableOutputHandlers

getOutputHandlers

getPostProcessors

setDisablePostProcessors

getPreProcessor

handleParameters

isSerializable

createReport

setEnqueuer

getDownloadURL