com.appiancorp.suiteapi.ix.data.portlet

Class DefaultPortletIxHelper

java.lang.Object

com.appiancorp.suiteapi.ix.data.portlet.PortletIxHelper

com.appiancorp.suiteapi.ix.data.portlet.DefaultPortletIxHelper

public final class DefaultPortletIxHelper
extends PortletIxHelper

Nested Class Summary

Nested classes/interfaces inherited from class com.appiancorp.suiteapi.ix.data.portlet.PortletIxHelper

PortletIxHelper.ExportBinder, PortletIxHelper.ImportBinder, PortletIxHelper.ResourceExporter, PortletIxHelper.ResourceImporter

Constructor Summary

Constructors

Constructor and Description
DefaultPortletIxHelper()

Method Summary

Modifier and Type	Method and Description
void	replaceIdsWithUuids(java.util.Map<java.lang.String,java.lang.Object> portletParamsMap, PortletIxHelper.ExportBinder b) Replaces all local ids within the portlet parameters with UUIDs.
void	replaceUuidsWithIds(java.util.Map<java.lang.String,java.lang.Object> portletParamsMap, PortletIxHelper.ImportBinder b) Replaces all UUIDs within the portlet parameters with local ids.

Methods inherited from class com.appiancorp.suiteapi.ix.data.portlet.PortletIxHelper

addDiagnosticMessage, exportExtraData, exportResources, getInstance, getInstance, getServiceContext, getTypedId, importExtraDataAndResources

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultPortletIxHelper

public DefaultPortletIxHelper()

Method Detail

replaceIdsWithUuids

public void replaceIdsWithUuids(java.util.Map<java.lang.String,java.lang.Object> portletParamsMap,
                                PortletIxHelper.ExportBinder b)
                         throws AppianException

Description copied from class: PortletIxHelper

Replaces all local ids within the portlet parameters with UUIDs. This method is invoked during the export of a portlet. The UUID bound to each local id should be retrieved using the provided PortletIxHelper.ExportBinder.

Specified by:

replaceIdsWithUuids in class PortletIxHelper

Parameters:

portletParamsMap - The map of portlet parameters (see Portlet.getParameters()).

b - API for mapping local ids to uuids.

Throws:

AppianException - If the export of this portlet should be failed (the export driver will automatically handle the exception: it will add the portlet to the failed list and proceed with the export of other objects).

replaceUuidsWithIds

public void replaceUuidsWithIds(java.util.Map<java.lang.String,java.lang.Object> portletParamsMap,
                                PortletIxHelper.ImportBinder b)
                         throws AppianException

Description copied from class: PortletIxHelper

Replaces all UUIDs within the portlet parameters with local ids. This method is invoked during the import of a portlet, and performs the reverse of the conversions made by PortletIxHelper.replaceIdsWithUuids(Map, ExportBinder). The local id corresponding to each UUID should be retrieved using the provided PortletIxHelper.ImportBinder.

Specified by:

replaceUuidsWithIds in class PortletIxHelper

Parameters:

portletParamsMap - The map of portlet parameters (see Portlet.getParameters()).

b - API for mapping uuids to local ids.

Throws:

AppianException - If the import of this portlet should be failed (the import driver will automatically handle the exception: it will add the portlet to the failed list and proceed with the import of other objects).