Package com.storedobject.core

Interface ContentProducer

All Superinterfaces:

ContentType, Executable, Runnable

All Known Implementing Classes:

AbstractSpreadSheet, AccountStatement, CombinedPDFReport, Content, CSVReport, DataDownload, Excel, ExcelReport, FileCirculationStatus, FileExpiryReport, ImageProducer, ItemMovementReport, IteratorODTReport, JournalReport, ObjectGridReport, ObjectList, ObjectListExcel, ODS, ODSReport, ODT, ODTObjectReport, ODTReport, PDF, PDFContent, PDFObjectReport, PDFReport, StockAvailability, StockMovementReport, StockReport, StockReportExcel, StreamContentProducer, StreamDataContent, SVGContentGenerator, TextContentProducer, TextReport, TrialBalance

public interface ContentProducer
extends Executable, ContentType

Method Summary

Modifier and Type	Method	Description
default void	abort(Throwable error)	This method may be called when the content generation is aborted due to some error.
default void	execute()	The functional interface method specified by this interface.
default InputStream	extractContent()
InputStream	getContent()
default Entity	getEntity()
default Throwable	getError()	Get the current error (set via abort(Throwable)).
String	getFileExtension()
String	getFileName()
default StreamData	getStreamData()
default StreamDataProvider	getStreamDataProvider()
default SystemEntity	getSystemEntity()
default TransactionManager	getTransactionManager()
void	produce()
default FileData	saveTo(FileData fileData, Transaction transaction)
default FileData	saveTo(FileData fileData, TransactionManager tm)
default FileData	saveTo(String folderPath, Transaction transaction)
default FileData	saveTo(String folderPath, TransactionManager tm)
void	setTransactionManager(TransactionManager tm)

Methods inherited from interface com.storedobject.core.ContentType

getContentType, getLink, getMimeType, isAudio, isHTML, isImage, isLink, isMedia, isPDF, isText, isVideo

Methods inherited from interface com.storedobject.common.Executable

act, run

Method Details

produce

void produce()

getContent

InputStream getContent()
                throws Exception

Throws:

Exception

getFileExtension

String getFileExtension()

getFileName

String getFileName()

setTransactionManager

void setTransactionManager(TransactionManager tm)

getTransactionManager

default TransactionManager getTransactionManager()

getSystemEntity

default SystemEntity getSystemEntity()

getEntity

default Entity getEntity()

extractContent

default InputStream extractContent()
                            throws Exception

Throws:

Exception

getStreamDataProvider

default StreamDataProvider getStreamDataProvider()

getStreamData

default StreamData getStreamData()

execute

default void execute()

Description copied from interface: Executable

The functional interface method specified by this interface.

Specified by:

execute in interface Executable

saveTo

default FileData saveTo(String folderPath,
 Transaction transaction)
                 throws Exception

Throws:

Exception

saveTo

default FileData saveTo(FileData fileData,
 Transaction transaction)
                 throws Exception

Throws:

Exception

saveTo

default FileData saveTo(String folderPath,
 TransactionManager tm)
                 throws Exception

Throws:

Exception

saveTo

default FileData saveTo(FileData fileData,
 TransactionManager tm)
                 throws Exception

Throws:

Exception

abort

default void abort(Throwable error)

This method may be called when the content generation is aborted due to some error.

Note: This could be invoked multiple times.

Parameters:

error - Error.

getError

default Throwable getError()

Get the current error (set via abort(Throwable)).

Returns:

Current error if any.