com.liferay.social.kernel.service

Interface SocialRequestInterpreterLocalService

All Superinterfaces:

BaseLocalService

All Known Implementing Classes:

SocialRequestInterpreterLocalServiceWrapper

@CTAware
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface SocialRequestInterpreterLocalService
extends BaseLocalService

Provides the local service interface for SocialRequestInterpreter. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

Author:

Brian Wing Shun Chan

See Also:

SocialRequestInterpreterLocalServiceUtil

{$generated.description}

Method Summary

Modifier and Type	Method and Description
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
SocialRequestFeedEntry	interpret(SocialRequest request, ThemeDisplay themeDisplay) Creates a human readable request feed entry for the social request using an available compatible request interpreter.
void	processConfirmation(SocialRequest request, ThemeDisplay themeDisplay) Processes the confirmation of the social request.
void	processRejection(SocialRequest request, ThemeDisplay themeDisplay) Processes the rejection of the social request.

Method Detail

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

interpret

SocialRequestFeedEntry interpret(SocialRequest request,
                                 ThemeDisplay themeDisplay)

Creates a human readable request feed entry for the social request using an available compatible request interpreter.

This method finds the appropriate interpreter for the request by going through the available interpreters to find one that can handle the asset type of the request.

Parameters:

request - the social request to be translated to human readable form

themeDisplay - the theme display needed by interpreters to create links and get localized text fragments

Returns:

the social request feed entry

processConfirmation

void processConfirmation(SocialRequest request,
                         ThemeDisplay themeDisplay)

Processes the confirmation of the social request.

Confirmations are handled by finding the appropriate social request interpreter and calling its processConfirmation() method. To find the appropriate interpreter this method goes through the available interpreters to find one that can handle the asset type of the request.

Parameters:

request - the social request being confirmed

themeDisplay - the theme display needed by interpreters to create links and get localized text fragments

processRejection

void processRejection(SocialRequest request,
                      ThemeDisplay themeDisplay)

Processes the rejection of the social request.

Rejections are handled by finding the appropriate social request interpreters and calling their processRejection() methods. To find the appropriate interpreters this method goes through the available interpreters and asks them if they can handle the asset type of the request.

Parameters:

request - the social request being rejected

themeDisplay - the theme display needed by interpreters to create links and get localized text fragments