com.liferay.portlet.social.service
Class SocialRequestInterpreterLocalServiceUtil

java.lang.Object
  com.liferay.portlet.social.service.SocialRequestInterpreterLocalServiceUtil

@ProviderType
public class SocialRequestInterpreterLocalServiceUtil
extends Object

Provides the local service utility for SocialRequestInterpreter. This utility wraps com.liferay.portlet.social.service.impl.SocialRequestInterpreterLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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.

See Also:

SocialRequestInterpreterLocalService, com.liferay.portlet.social.service.base.SocialRequestInterpreterLocalServiceBaseImpl, com.liferay.portlet.social.service.impl.SocialRequestInterpreterLocalServiceImpl

Constructor Summary

SocialRequestInterpreterLocalServiceUtil()

Method Summary

static void	addRequestInterpreter(SocialRequestInterpreter requestInterpreter) Adds the social request interpreter to the list of available interpreters.
static void	deleteRequestInterpreter(SocialRequestInterpreter requestInterpreter) Removes the social request interpreter from the list of available interpreters.
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static SocialRequestInterpreterLocalService	getService()
static SocialRequestFeedEntry	interpret(SocialRequest request, ThemeDisplay themeDisplay) Creates a human readable request feed entry for the social request using an available compatible request interpreter.
static void	processConfirmation(SocialRequest request, ThemeDisplay themeDisplay) Processes the confirmation of the social request.
static void	processRejection(SocialRequest request, ThemeDisplay themeDisplay) Processes the rejection of the social request.
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(SocialRequestInterpreterLocalService service) Deprecated. As of 6.2.0

Methods inherited from class java.lang.Object

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

Constructor Detail

SocialRequestInterpreterLocalServiceUtil

public SocialRequestInterpreterLocalServiceUtil()

Method Detail

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addRequestInterpreter

public static void addRequestInterpreter(SocialRequestInterpreter requestInterpreter)

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

Parameters:

requestInterpreter - the social request interpreter

deleteRequestInterpreter

public static void deleteRequestInterpreter(SocialRequestInterpreter requestInterpreter)

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

Parameters:

requestInterpreter - the social request interpreter

interpret

public static 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

public static 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

public static 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

getService

public static SocialRequestInterpreterLocalService getService()

setService

public void setService(SocialRequestInterpreterLocalService service)

Deprecated. As of 6.2.0