com.liferay.portlet.social.service.impl

Class SocialRequestInterpreterLocalServiceImpl

Object

com.liferay.portal.kernel.service.BaseLocalServiceImpl

com.liferay.portlet.social.service.base.SocialRequestInterpreterLocalServiceBaseImpl

com.liferay.portlet.social.service.impl.SocialRequestInterpreterLocalServiceImpl

All Implemented Interfaces:

com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService, com.liferay.portal.kernel.service.BaseLocalService, com.liferay.social.kernel.service.SocialRequestInterpreterLocalService

public class SocialRequestInterpreterLocalServiceImpl
extends SocialRequestInterpreterLocalServiceBaseImpl

The social request interpreter local service. Social request interpreters are responsible for translating social requests into human readable form as well as handling social request confirmations and rejections. This service holds a list of interpreters and provides methods to add or remove items from this list.

Social request interpreters use the language files to get text fragments based on the request's type. An interpreter is created for a specific request type and is only capable of handling requests of that type. As an example, there is an interpreter FriendsRequestInterpreter in the social networking portlet can only translate and handle interpretation, confirmation, and rejection of friend requests.

Author:

Brian Wing Shun Chan

Field Summary

Fields inherited from class com.liferay.portlet.social.service.base.SocialRequestInterpreterLocalServiceBaseImpl

counterLocalService, socialRequestInterpreterLocalService

Constructor Summary

Constructors

Constructor and Description
SocialRequestInterpreterLocalServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	addRequestInterpreter(com.liferay.social.kernel.model.SocialRequestInterpreter requestInterpreter) Adds the social request interpreter to the list of available interpreters.
void	afterPropertiesSet()
void	deleteRequestInterpreter(com.liferay.social.kernel.model.SocialRequestInterpreter requestInterpreter) Removes the social request interpreter from the list of available interpreters.
protected String	getSocialRequestPortletId(com.liferay.social.kernel.model.SocialRequest request)
com.liferay.social.kernel.model.SocialRequestFeedEntry	interpret(com.liferay.social.kernel.model.SocialRequest request, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) Creates a human readable request feed entry for the social request using an available compatible request interpreter.
protected boolean	matches(com.liferay.social.kernel.model.impl.SocialRequestInterpreterImpl requestInterpreter, String className, com.liferay.social.kernel.model.SocialRequest request)
void	processConfirmation(com.liferay.social.kernel.model.SocialRequest request, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) Processes the confirmation of the social request.
void	processRejection(com.liferay.social.kernel.model.SocialRequest request, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) Processes the rejection of the social request.

Methods inherited from class com.liferay.portlet.social.service.base.SocialRequestInterpreterLocalServiceBaseImpl

destroy, getCounterLocalService, getOSGiServiceIdentifier, getSocialRequestInterpreterLocalService, runSQL, setCounterLocalService, setSocialRequestInterpreterLocalService

Methods inherited from class com.liferay.portal.kernel.service.BaseLocalServiceImpl

getClassLoader, getLocalizationMap

Methods inherited from class Object

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

Constructor Detail

SocialRequestInterpreterLocalServiceImpl

public SocialRequestInterpreterLocalServiceImpl()

Method Detail

addRequestInterpreter

public void addRequestInterpreter(com.liferay.social.kernel.model.SocialRequestInterpreter requestInterpreter)

Adds the social request interpreter to the list of available interpreters.

Parameters:

requestInterpreter - the social request interpreter

afterPropertiesSet

public void afterPropertiesSet()

Overrides:

afterPropertiesSet in class SocialRequestInterpreterLocalServiceBaseImpl

deleteRequestInterpreter

public void deleteRequestInterpreter(com.liferay.social.kernel.model.SocialRequestInterpreter requestInterpreter)

Removes the social request interpreter from the list of available interpreters.

Parameters:

requestInterpreter - the social request interpreter

interpret

public com.liferay.social.kernel.model.SocialRequestFeedEntry interpret(com.liferay.social.kernel.model.SocialRequest request,
                                                                        com.liferay.portal.kernel.theme.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

public void processConfirmation(com.liferay.social.kernel.model.SocialRequest request,
                                com.liferay.portal.kernel.theme.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

public void processRejection(com.liferay.social.kernel.model.SocialRequest request,
                             com.liferay.portal.kernel.theme.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

getSocialRequestPortletId

protected String getSocialRequestPortletId(com.liferay.social.kernel.model.SocialRequest request)

matches

protected boolean matches(com.liferay.social.kernel.model.impl.SocialRequestInterpreterImpl requestInterpreter,
                          String className,
                          com.liferay.social.kernel.model.SocialRequest request)