com.liferay.ratings.kernel.transformer

Interface RatingsDataTransformer

public interface RatingsDataTransformer

Provides an interface defining the transformations to be applied to the ratings data when the ratings type used by an entity is changed to use a different ratings type.

Implementations must be registered in the OSGI Registry. The portal invokes the highest ranking OSGI component implementing this interface when the ratings type of an entity is changed.

Author:

Roberto Díaz, Sergio González

Method Summary

Modifier and Type	Method and Description
ActionableDynamicQuery.PerformActionMethod<RatingsEntry>	transformRatingsData(RatingsType fromRatingsType, RatingsType toRatingsType) Defines the transformations to be applied on a ratings entry when the ratings type is changed from the previous ratings type to the new ratings type.

Method Detail

transformRatingsData

ActionableDynamicQuery.PerformActionMethod<RatingsEntry> transformRatingsData(RatingsType fromRatingsType,
                                                                              RatingsType toRatingsType)
                                                                       throws PortalException

Defines the transformations to be applied on a ratings entry when the ratings type is changed from the previous ratings type to the new ratings type.

This method returns an ActionableDynamicQuery.PerformActionMethod for operating on a RatingsEntry entity to transform its values based on when the ratings type is changed.

Parameters:

fromRatingsType - the previous ratings type

toRatingsType - the final ratings type

Returns:

an ActionableDynamicQuery.PerformActionMethod with the actions to be applied to the ratings entry when the ratings type changes.

Throws:

PortalException