com.ibm.portal.portletconversion
Interface PortletConverter
-
public interface PortletConverter
This interface defines a SPI for explicit conversion of IBM API portlet
settings and portlet data.
- Since:
- 7.0.0
- Note:
This interface is designed to be implemented by clients. |
Method Summary
|
java.util.Map<java.lang.String,java.lang.String[]> |
convert(java.util.Map<java.lang.String,Data> sourceParameters,
java.util.Map<java.lang.String,java.lang.String[]> currentTargetPreferences,
boolean isPortletInstance,
java.lang.String[] arguments)
Convert IBM API portlet settings and portlet data to standard portlet
API preferences. |
convert
java.util.Map<java.lang.String,java.lang.String[]> convert(java.util.Map<java.lang.String,Data> sourceParameters,
java.util.Map<java.lang.String,java.lang.String[]> currentTargetPreferences,
boolean isPortletInstance,
java.lang.String[] arguments)
throws ConversionFailedException
- Convert IBM API portlet settings and portlet data to standard portlet
API preferences.
The portlet conversion task invokes the converter in defined sequence:
First for conversion of portlet settings of the source portlet,
then for conversion of portlet data associated with
the instances of the source portlet.
- Parameters:
- sourceParameters - A representation of the portlet settings or the
portlet data that is associated with the IBM API source portlet.
Maybe null or empty.
- currentTargetPreferences - A representation of currently available
preferences of the target standard API portlet. Maybe null or empty.
- isPortletInstance - true if sourceParameters represents portlet data
that belongs to a portlet instance, false if sourceParameters represents
portlet settings that belong to a portlet.
- arguments - an array of arguments that are specified during
invocation of the conversion task. Maybe null.
- Returns:
- A representation of the converted standard portlet API
preferences. Maybe null or empty.
- Throws:
- ConversionFailedException - - if an error occured during conversion.