com.silverpeas.export
Interface Exporter<T extends Serializable>

Type Parameters:

T - The type of the serializable resources to export.

All Known Implementing Classes:

ICalExporter

public interface Exporter<T extends Serializable>

This interface defines the features an exporter of serializable resources in Silverpeas have to satisfy. All exporter in Silverpeas should implement this interface. An exporter in Silverpeas is defined for a specific type of serializable resources and it has the responsability to know how to export them into a specific or a specified format.

Method Summary

void	export(ExportDescriptor descriptor, T serializable) Exports the specified serializable resource according to the export information carried by the specified export descriptor.

Method Detail

export

void export(ExportDescriptor descriptor,
            T serializable)
            throws ExportException

Exports the specified serializable resource according to the export information carried by the specified export descriptor. The serializable resource is exported by using either the writer or the output stream provided by the descriptor. According to the kind of the writer or of the output stream, the way the resource is actually exported can be customized (export in a file, in a string, through a web service, ...). Once the export is done (with success or failure), the writer and the output stream is closed.

Parameters:

descriptor - the export descriptor in which information about the export process is indicated.

serializable - the serializable resource to export.

Throws:

ExportException - when an unexpected error occurs while exporting the resource.