Package org.cyclos.impl.system

Interface ExportFormatServiceLocal

All Superinterfaces:

CRUDService<ExportFormatDTO,ExportFormatData,Void>, CRUDServiceLocal<ExportFormat,ExportFormatDTO,ExportFormatData,Void>, ExportFormatService, Service

public interface ExportFormatServiceLocal
extends ExportFormatService, CRUDServiceLocal<ExportFormat,ExportFormatDTO,ExportFormatData,Void>

Local interface for exportFormat

Method Summary

Modifier and Type	Method	Description
FileInfo	exportMultiple(ExportFormat format, ExportFormatContext context, QueryParameters params, DataIterator<?> entities)	Exports a series of entities using the given format and context
FileInfo	exportMultiple(ExportFormat format, ExportFormatContext context, QueryParameters params, DataIterator<?> entities, Map<String,Object> additionalData)	Exports a series of entities using the given format and context, passing additional data to the export handler
FileInfo	exportSingle(ExportFormat format, ExportFormatContext context, Object entity)	Exports a single object using the given format and context
FileInfo	exportSingle(ExportFormat format, ExportFormatContext context, Object entity, Map<String,Object> additionalData)	Exports a single object using the given format and context, passing additional data to the export handler
ExportFormat	getCSV()	Returns CSV export format
ExportFormat	getPDF()	Returns the PDF export format
ExportFormat	getXLSX()	Returns the XLSX export format
List<ExportFormat>	listAll()	Returns all the export formats
List<ExportFormat>	listByContext(ExportFormatContext context)	Returns the enabled export formats associated with the given context
ExportFormat	load(String internalName)	Loads an export format by internal name

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, newEntity, remove, removeAll, saveEntity, saveSkippingEntityLog, toDTO, toEntity, validate

Methods inherited from interface org.cyclos.services.system.ExportFormatService

list

Method Detail

exportMultiple

FileInfo exportMultiple(ExportFormat format,
                        ExportFormatContext context,
                        QueryParameters params,
                        DataIterator<?> entities)

Exports a series of entities using the given format and context

exportMultiple

FileInfo exportMultiple(ExportFormat format,
                        ExportFormatContext context,
                        QueryParameters params,
                        DataIterator<?> entities,
                        Map<String,Object> additionalData)

Exports a series of entities using the given format and context, passing additional data to the export handler

exportSingle

FileInfo exportSingle(ExportFormat format,
                      ExportFormatContext context,
                      Object entity)

Exports a single object using the given format and context

exportSingle

FileInfo exportSingle(ExportFormat format,
                      ExportFormatContext context,
                      Object entity,
                      Map<String,Object> additionalData)

Exports a single object using the given format and context, passing additional data to the export handler

getCSV

ExportFormat getCSV()

Returns CSV export format

getPDF

ExportFormat getPDF()

Returns the PDF export format

getXLSX

ExportFormat getXLSX()

Returns the XLSX export format

listAll

List<ExportFormat> listAll()

Returns all the export formats

listByContext

List<ExportFormat> listByContext(ExportFormatContext context)

Returns the enabled export formats associated with the given context

load

ExportFormat load(String internalName)

Loads an export format by internal name