com.liferay.exportimport.data.handler.base

Class BaseStagedModelDataHandler<T extends StagedModel>

java.lang.Object

com.liferay.exportimport.kernel.lar.BaseStagedModelDataHandler<T>

com.liferay.exportimport.data.handler.base.BaseStagedModelDataHandler<T>

All Implemented Interfaces:

StagedModelDataHandler<T>

Direct Known Subclasses:

DummyFolderStagedModelDataHandler, DummyReferenceStagedModelDataHandler, DummyStagedModelDataHandler

@ProviderType
public abstract class BaseStagedModelDataHandler<T extends StagedModel>
extends BaseStagedModelDataHandler<T>

Constructor Summary

Constructors

Constructor and Description
BaseStagedModelDataHandler()

Method Summary

Modifier and Type	Method and Description
void	deleteStagedModel(java.lang.String uuid, long groupId, java.lang.String className, java.lang.String extraData) Deletes the staged model matching the parameters.
void	deleteStagedModel(T stagedModel) Deletes the staged model.
void	exportStagedModel(PortletDataContext portletDataContext, T stagedModel) Exports the staged model and its references.
T	fetchMissingReference(java.lang.String uuid, long groupId) Returns a reference of the staged model.
T	fetchStagedModelByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the staged model with the UUID and group.
java.util.List<T>	fetchStagedModelsByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the staged models with the UUID and company.
protected ExportImportContentProcessor<java.lang.String>	getExportImportContentProcessor(java.lang.Class<T> clazz)
protected StagedModelRepository<T>	getStagedModelRepository()
void	restoreStagedModel(PortletDataContext portletDataContext, T stagedModel) Restores the staged model from the trash.

Methods inherited from class com.liferay.exportimport.kernel.lar.BaseStagedModelDataHandler

countStagedModel, doExportStagedModel, doImportMissingReference, doImportMissingReference, doImportStagedModel, doRestoreStagedModel, exportAssetCategories, exportAssetTags, exportComments, exportRatings, getClassNames, getDisplayName, getExportableStatuses, getProcessFlag, getReferenceAttributes, getSkipImportReferenceStagedModelNames, importAssetCategories, importAssetTags, importComments, importMissingGroupReference, importMissingReference, importMissingReference, importRatings, importReferenceStagedModels, importStagedModel, isSkipImportReferenceStagedModels, isStagedModelInTrash, validateExport, validateMissingGroupReference, validateMissingReference, validateReference

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseStagedModelDataHandler

public BaseStagedModelDataHandler()

Method Detail

deleteStagedModel

public void deleteStagedModel(java.lang.String uuid,
                              long groupId,
                              java.lang.String className,
                              java.lang.String extraData)
                       throws PortalException

Description copied from interface: StagedModelDataHandler

Deletes the staged model matching the parameters. This method is called when deletions are imported.

Specified by:

deleteStagedModel in interface StagedModelDataHandler<T extends StagedModel>

Specified by:

deleteStagedModel in class BaseStagedModelDataHandler<T extends StagedModel>

Parameters:

uuid - the staged model's UUID

groupId - the primary key of the entity's group

className - the staged model's class name

extraData - the extra data containing useful information about the staged model. This information makes the staged model easier to identify and fetch for deletion. It is populated when a deletion system event is added, usually in the *LocalServiceImpl class of the model.

Throws:

PortalException - if a portal exception occurred

deleteStagedModel

public void deleteStagedModel(T stagedModel)
                       throws PortalException

Description copied from interface: StagedModelDataHandler

Deletes the staged model. This method is called when deletions are imported.

Specified by:

deleteStagedModel in interface StagedModelDataHandler<T extends StagedModel>

Specified by:

deleteStagedModel in class BaseStagedModelDataHandler<T extends StagedModel>

Parameters:

stagedModel - the staged model to delete

Throws:

PortalException - if a portal exception occurred

exportStagedModel

public void exportStagedModel(PortletDataContext portletDataContext,
                              T stagedModel)
                       throws PortletDataException

Description copied from interface: StagedModelDataHandler

Exports the staged model and its references. See the BaseStagedModelDataHandler#exportStagedModel(PortletDataContext, T) method for a reference implementation. Refrain from overriding this method; instead, override the BaseStagedModelDataHandler#doExportStagedModel(PortletDataContext, T) method.

Specified by:

exportStagedModel in interface StagedModelDataHandler<T extends StagedModel>

Overrides:

exportStagedModel in class BaseStagedModelDataHandler<T extends StagedModel>

Parameters:

portletDataContext - the portlet data context of the current process

stagedModel - the staged model to export

Throws:

PortletDataException - if a portlet data exception occurred

fetchMissingReference

public T fetchMissingReference(java.lang.String uuid,
                               long groupId)

Description copied from interface: StagedModelDataHandler

Returns a reference of the staged model. This method is typically used in validation and import methods.

Specified by:

fetchMissingReference in interface StagedModelDataHandler<T extends StagedModel>

Overrides:

fetchMissingReference in class BaseStagedModelDataHandler<T extends StagedModel>

Parameters:

uuid - the reference's UUID

groupId - the primary key of the group

Returns:

a reference of the staged model

fetchStagedModelByUuidAndGroupId

public T fetchStagedModelByUuidAndGroupId(java.lang.String uuid,
                                          long groupId)

Description copied from interface: StagedModelDataHandler

Returns the staged model with the UUID and group. This method is used in cases with grouped models.

Specified by:

fetchStagedModelByUuidAndGroupId in interface StagedModelDataHandler<T extends StagedModel>

Overrides:

fetchStagedModelByUuidAndGroupId in class BaseStagedModelDataHandler<T extends StagedModel>

Parameters:

uuid - the staged model's UUID

groupId - the primary key of the group

Returns:

the staged model with the UUID and group

fetchStagedModelsByUuidAndCompanyId

public java.util.List<T> fetchStagedModelsByUuidAndCompanyId(java.lang.String uuid,
                                                             long companyId)

Description copied from interface: StagedModelDataHandler

Returns the staged models with the UUID and company.

Specified by:

fetchStagedModelsByUuidAndCompanyId in interface StagedModelDataHandler<T extends StagedModel>

Specified by:

fetchStagedModelsByUuidAndCompanyId in class BaseStagedModelDataHandler<T extends StagedModel>

Parameters:

uuid - the staged model's UUID

companyId - the primary key of the company

Returns:

the staged models with the UUID and company

restoreStagedModel

public void restoreStagedModel(PortletDataContext portletDataContext,
                               T stagedModel)
                        throws PortletDataException

Description copied from interface: StagedModelDataHandler

Restores the staged model from the trash. This method is called during the import process to ensure the imported staged model is not in the trash. See the BaseStagedModelDataHandler.restoreStagedModel(PortletDataContext, StagedModel) method for a reference implementation. Refrain from overriding this method; instead, override the BaseStagedModelDataHandler.doRestoreStagedModel(PortletDataContext, StagedModel) method.

Specified by:

restoreStagedModel in interface StagedModelDataHandler<T extends StagedModel>

Overrides:

restoreStagedModel in class BaseStagedModelDataHandler<T extends StagedModel>

Parameters:

portletDataContext - the portlet data context of the current process

stagedModel - the staged model to restore from the trash

Throws:

PortletDataException - if a portlet data exception occurred

getExportImportContentProcessor

protected ExportImportContentProcessor<java.lang.String> getExportImportContentProcessor(java.lang.Class<T> clazz)

getStagedModelRepository

protected StagedModelRepository<T> getStagedModelRepository()