org.silverpeas.process.annotation
Interface DummyHandledFileConverter<S extends SimulationElement<?>>

All Known Implementing Classes:

AbstractDummyHandledFileConverter, SimpleDocumentDummyHandledFileConverter, ThumbnailDummyHandledFileConverter

public interface DummyHandledFileConverter<S extends SimulationElement<?>>

This interface provides services to convert an element from any type to a dummy handled file.

User: Yohann Chastagnier Date: 25/10/13

Method Summary

List<DummyHandledFile>	convert(List<S> elements, WAPrimaryKey targetPK, ActionType actionType) Method that contains the treatment of the conversion.
Class<S>	getSourceElementType() Gets the class of the element that has to be converted to a dummy handled file.
void	register() This method have to be annoted by @PostConstruct.
void	unregister() This method have to be annoted by @PreDestroy.

Method Detail

register

void register()

This method have to be annoted by @PostConstruct. Just after Silverpeas server start, this method is called. The content of this method consists to register the class instance into DummyHandledFileConverterRegistration.

unregister

void unregister()

This method have to be annoted by @PreDestroy. Just before Silverpeas server stop, this method is called. The content of this method consists to unregister the class instance from DummyHandledFileConverterRegistration.

getSourceElementType

Class<S> getSourceElementType()

Gets the class of the element that has to be converted to a dummy handled file.

Returns:

convert

List<DummyHandledFile> convert(List<S> elements,
                               WAPrimaryKey targetPK,
                               ActionType actionType)

Method that contains the treatment of the conversion.

Parameters:

elements - elements to convert

targetPK - the targets

actionType - the action type used for the conversion

Returns: