org.kuali.rice.kns.bo
Interface Exporter

All Known Implementing Classes:

DataExporter

public interface Exporter

An Exporter provides the ability to export a List of BusinessObjects to a supported ExportFormat.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

void	export(java.lang.Class<? extends org.kuali.rice.kns.bo.BusinessObject> businessObjectClass, java.util.List<org.kuali.rice.kns.bo.BusinessObject> data, java.lang.String exportFormat, java.io.OutputStream outputStream) Exports the List of BusinessObjects to the specified ExportFormat.
java.util.List<java.lang.String>	getSupportedFormats(java.lang.Class<? extends org.kuali.rice.kns.bo.BusinessObject> businessObjectClass) Returns a List of ExportFormats supported by this Exporter for the given BusinessOject class.

Method Detail

export

void export(java.lang.Class<? extends org.kuali.rice.kns.bo.BusinessObject> businessObjectClass,
            java.util.List<org.kuali.rice.kns.bo.BusinessObject> data,
            java.lang.String exportFormat,
            java.io.OutputStream outputStream)
            throws java.io.IOException,
                   ExportNotSupportedException

Exports the List of BusinessObjects to the specified ExportFormat. The resulting output of the export operation should be written to the given OutputStream.

Parameters:

businessObjectClass - the type of BusinessObjects being exported

data - a List of BusinessObjects to export

exportFormat - the export format in which to export the BusinessObjects

outputStream - the OutputStream to write the exported data to

Throws:

java.io.IOException - if the process encounters an I/O issue

ExportNotSupportedException - if the given ExportFormat is not supported

getSupportedFormats

java.util.List<java.lang.String> getSupportedFormats(java.lang.Class<? extends org.kuali.rice.kns.bo.BusinessObject> businessObjectClass)

Returns a List of ExportFormats supported by this Exporter for the given BusinessOject class. This method ...

Parameters:

businessObjectClass - the class of the BusinessObjects being exported

Returns:

a List of supported ExportFormats