com.liferay.portlet.social.service

Class SocialRequestLocalServiceUtil

java.lang.Object

com.liferay.portlet.social.service.SocialRequestLocalServiceUtil

@ProviderType
public class SocialRequestLocalServiceUtil
extends java.lang.Object

Provides the local service utility for SocialRequest. This utility wraps com.liferay.portlet.social.service.impl.SocialRequestLocalServiceImpl 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.

Author:

Brian Wing Shun Chan

See Also:

SocialRequestLocalService, com.liferay.portlet.social.service.base.SocialRequestLocalServiceBaseImpl, com.liferay.portlet.social.service.impl.SocialRequestLocalServiceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
SocialRequestLocalServiceUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static SocialRequest	addRequest(long userId, long groupId, java.lang.String className, long classPK, int type, java.lang.String extraData, long receiverUserId) Adds a social request to the database.
static SocialRequest	addSocialRequest(SocialRequest socialRequest) Adds the social request to the database.
static SocialRequest	createSocialRequest(long requestId) Creates a new social request with the primary key.
static void	deleteReceiverUserRequests(long receiverUserId) Removes all the social requests for the receiving user.
static void	deleteRequest(long requestId) Removes the social request identified by its primary key from the database.
static void	deleteRequest(SocialRequest request) Removes the social request from the database.
static SocialRequest	deleteSocialRequest(long requestId) Deletes the social request with the primary key from the database.
static SocialRequest	deleteSocialRequest(SocialRequest socialRequest) Deletes the social request from the database.
static void	deleteUserRequests(long userId) Removes all the social requests for the requesting user.
static DynamicQuery	dynamicQuery()
static java.util.List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
static SocialRequest	fetchSocialRequest(long requestId)
static SocialRequest	fetchSocialRequestByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the social request with the matching UUID and company.
static SocialRequest	fetchSocialRequestByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the social request matching the UUID and group.
static java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static java.util.List<SocialRequest>	getReceiverUserRequests(long receiverUserId, int start, int end) Returns a range of all the social requests for the receiving user.
static java.util.List<SocialRequest>	getReceiverUserRequests(long receiverUserId, int status, int start, int end) Returns a range of all the social requests with the given status for the receiving user.
static int	getReceiverUserRequestsCount(long receiverUserId) Returns the number of social requests for the receiving user.
static int	getReceiverUserRequestsCount(long receiverUserId, int status) Returns the number of social requests with the given status for the receiving user.
static SocialRequestLocalService	getService()
static SocialRequest	getSocialRequest(long requestId) Returns the social request with the primary key.
static SocialRequest	getSocialRequestByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the social request with the matching UUID and company.
static SocialRequest	getSocialRequestByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the social request matching the UUID and group.
static java.util.List<SocialRequest>	getSocialRequests(int start, int end) Returns a range of all the social requests.
static int	getSocialRequestsCount() Returns the number of social requests.
static java.util.List<SocialRequest>	getUserRequests(long userId, int start, int end) Returns a range of all the social requests for the requesting user.
static java.util.List<SocialRequest>	getUserRequests(long userId, int status, int start, int end) Returns a range of all the social requests with the given status for the requesting user.
static int	getUserRequestsCount(long userId) Returns the number of social requests for the requesting user.
static int	getUserRequestsCount(long userId, int status) Returns the number of social requests with the given status for the requesting user.
static boolean	hasRequest(long userId, java.lang.String className, long classPK, int type, int status) Returns true if a matching social requests exists in the database.
static boolean	hasRequest(long userId, java.lang.String className, long classPK, int type, long receiverUserId, int status) Returns true if a matching social request exists in the database.
static void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(SocialRequestLocalService service) Deprecated. As of 6.2.0
static SocialRequest	updateRequest(long requestId, int status, ThemeDisplay themeDisplay) Updates the social request replacing its status.
static SocialRequest	updateSocialRequest(SocialRequest socialRequest) Updates the social request in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

SocialRequestLocalServiceUtil

public SocialRequestLocalServiceUtil()

Method Detail

addSocialRequest

public static SocialRequest addSocialRequest(SocialRequest socialRequest)
                                      throws SystemException

Adds the social request to the database. Also notifies the appropriate model listeners.

Parameters:

socialRequest - the social request

Returns:

the social request that was added

Throws:

SystemException - if a system exception occurred

createSocialRequest

public static SocialRequest createSocialRequest(long requestId)

Creates a new social request with the primary key. Does not add the social request to the database.

Parameters:

requestId - the primary key for the new social request

Returns:

the new social request

deleteSocialRequest

public static SocialRequest deleteSocialRequest(long requestId)
                                         throws PortalException,
                                                SystemException

Deletes the social request with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

requestId - the primary key of the social request

Returns:

the social request that was removed

Throws:

PortalException - if a social request with the primary key could not be found

SystemException - if a system exception occurred

deleteSocialRequest

public static SocialRequest deleteSocialRequest(SocialRequest socialRequest)
                                         throws SystemException

Deletes the social request from the database. Also notifies the appropriate model listeners.

Parameters:

socialRequest - the social request

Returns:

the social request that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static java.util.List dynamicQuery(DynamicQuery dynamicQuery)
                                   throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                          int start,
                          int end)
                                   throws SystemException

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from SocialRequestModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                          int start,
                          int end,
                          OrderByComparator orderByComparator)
                                   throws SystemException

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from SocialRequestModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                     Projection projection)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchSocialRequest

public static SocialRequest fetchSocialRequest(long requestId)
                                        throws SystemException

Throws:

SystemException

fetchSocialRequestByUuidAndCompanyId

public static SocialRequest fetchSocialRequestByUuidAndCompanyId(java.lang.String uuid,
                                                 long companyId)
                                                          throws SystemException

Returns the social request with the matching UUID and company.

Parameters:

uuid - the social request's UUID

companyId - the primary key of the company

Returns:

the matching social request, or null if a matching social request could not be found

Throws:

SystemException - if a system exception occurred

fetchSocialRequestByUuidAndGroupId

public static SocialRequest fetchSocialRequestByUuidAndGroupId(java.lang.String uuid,
                                               long groupId)
                                                        throws SystemException

Returns the social request matching the UUID and group.

Parameters:

uuid - the social request's UUID

groupId - the primary key of the group

Returns:

the matching social request, or null if a matching social request could not be found

Throws:

SystemException - if a system exception occurred

getSocialRequest

public static SocialRequest getSocialRequest(long requestId)
                                      throws PortalException,
                                             SystemException

Returns the social request with the primary key.

Parameters:

requestId - the primary key of the social request

Returns:

the social request

Throws:

PortalException - if a social request with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getSocialRequestByUuidAndCompanyId

public static SocialRequest getSocialRequestByUuidAndCompanyId(java.lang.String uuid,
                                               long companyId)
                                                        throws PortalException,
                                                               SystemException

Returns the social request with the matching UUID and company.

Parameters:

uuid - the social request's UUID

companyId - the primary key of the company

Returns:

the matching social request

Throws:

PortalException - if a matching social request could not be found

SystemException - if a system exception occurred

getSocialRequestByUuidAndGroupId

public static SocialRequest getSocialRequestByUuidAndGroupId(java.lang.String uuid,
                                             long groupId)
                                                      throws PortalException,
                                                             SystemException

Returns the social request matching the UUID and group.

Parameters:

uuid - the social request's UUID

groupId - the primary key of the group

Returns:

the matching social request

Throws:

PortalException - if a matching social request could not be found

SystemException - if a system exception occurred

getSocialRequests

public static java.util.List<SocialRequest> getSocialRequests(int start,
                                              int end)
                                                       throws SystemException

Returns a range of all the social requests.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from SocialRequestModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of social requests

end - the upper bound of the range of social requests (not inclusive)

Returns:

the range of social requests

Throws:

SystemException - if a system exception occurred

getSocialRequestsCount

public static int getSocialRequestsCount()
                                  throws SystemException

Returns the number of social requests.

Returns:

the number of social requests

Throws:

SystemException - if a system exception occurred

updateSocialRequest

public static SocialRequest updateSocialRequest(SocialRequest socialRequest)
                                         throws SystemException

Updates the social request in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

socialRequest - the social request

Returns:

the social request that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addRequest

public static SocialRequest addRequest(long userId,
                       long groupId,
                       java.lang.String className,
                       long classPK,
                       int type,
                       java.lang.String extraData,
                       long receiverUserId)
                                throws PortalException,
                                       SystemException

Adds a social request to the database.

In order to add a social request, both the requesting user and the receiving user must be from the same company and neither of them can be the default user.

Parameters:

userId - the primary key of the requesting user

groupId - the primary key of the group

className - the class name of the asset that is the subject of the request

classPK - the primary key of the asset that is the subject of the request

type - the request's type

extraData - the extra data regarding the request

receiverUserId - the primary key of the user receiving the request

Returns:

the social request

Throws:

PortalException - if the users could not be found, if the users were not from the same company, or if either of the users was the default user

SystemException - if a system exception occurred

deleteReceiverUserRequests

public static void deleteReceiverUserRequests(long receiverUserId)
                                       throws SystemException

Removes all the social requests for the receiving user.

Parameters:

receiverUserId - the primary key of the receiving user

Throws:

SystemException - if a system exception occurred

deleteRequest

public static void deleteRequest(long requestId)
                          throws PortalException,
                                 SystemException

Removes the social request identified by its primary key from the database.

Parameters:

requestId - the primary key of the social request

Throws:

PortalException - if the social request could not be found

SystemException - if a system exception occurred

deleteRequest

public static void deleteRequest(SocialRequest request)
                          throws SystemException

Removes the social request from the database.

Parameters:

request - the social request to be removed

Throws:

SystemException - if a system exception occurred

deleteUserRequests

public static void deleteUserRequests(long userId)
                               throws SystemException

Removes all the social requests for the requesting user.

Parameters:

userId - the primary key of the requesting user

Throws:

SystemException - if a system exception occurred

getReceiverUserRequests

public static java.util.List<SocialRequest> getReceiverUserRequests(long receiverUserId,
                                                    int start,
                                                    int end)
                                                             throws SystemException

Returns a range of all the social requests for the receiving user.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

receiverUserId - the primary key of the receiving user

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching social requests

Throws:

SystemException - if a system exception occurred

getReceiverUserRequests

public static java.util.List<SocialRequest> getReceiverUserRequests(long receiverUserId,
                                                    int status,
                                                    int start,
                                                    int end)
                                                             throws SystemException

Returns a range of all the social requests with the given status for the receiving user.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

receiverUserId - the primary key of the receiving user

status - the social request's status

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching social requests

Throws:

SystemException - if a system exception occurred

getReceiverUserRequestsCount

public static int getReceiverUserRequestsCount(long receiverUserId)
                                        throws SystemException

Returns the number of social requests for the receiving user.

Parameters:

receiverUserId - the primary key of the receiving user

Returns:

the number of matching social requests

Throws:

SystemException - if a system exception occurred

getReceiverUserRequestsCount

public static int getReceiverUserRequestsCount(long receiverUserId,
                               int status)
                                        throws SystemException

Returns the number of social requests with the given status for the receiving user.

Parameters:

receiverUserId - the primary key of the receiving user

status - the social request's status

Returns:

the number of matching social requests

Throws:

SystemException - if a system exception occurred

getUserRequests

public static java.util.List<SocialRequest> getUserRequests(long userId,
                                            int start,
                                            int end)
                                                     throws SystemException

Returns a range of all the social requests for the requesting user.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

userId - the primary key of the requesting user

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching social requests

Throws:

SystemException - if a system exception occurred

getUserRequests

public static java.util.List<SocialRequest> getUserRequests(long userId,
                                            int status,
                                            int start,
                                            int end)
                                                     throws SystemException

Returns a range of all the social requests with the given status for the requesting user.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

userId - the primary key of the requesting user

status - the social request's status

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching social requests

Throws:

SystemException - if a system exception occurred

getUserRequestsCount

public static int getUserRequestsCount(long userId)
                                throws SystemException

Returns the number of social requests for the requesting user.

Parameters:

userId - the primary key of the requesting user

Returns:

the number of matching social requests

Throws:

SystemException - if a system exception occurred

getUserRequestsCount

public static int getUserRequestsCount(long userId,
                       int status)
                                throws SystemException

Returns the number of social requests with the given status for the requesting user.

Parameters:

userId - the primary key of the requesting user

status - the social request's status

Returns:

the number of matching social request

Throws:

SystemException - if a system exception occurred

hasRequest

public static boolean hasRequest(long userId,
                 java.lang.String className,
                 long classPK,
                 int type,
                 int status)
                          throws SystemException

Returns true if a matching social requests exists in the database.

Parameters:

userId - the primary key of the requesting user

className - the class name of the asset that is the subject of the request

classPK - the primary key of the asset that is the subject of the request

type - the request's type

status - the social request's status

Returns:

true if the request exists; false otherwise

Throws:

SystemException - if a system exception occurred

hasRequest

public static boolean hasRequest(long userId,
                 java.lang.String className,
                 long classPK,
                 int type,
                 long receiverUserId,
                 int status)
                          throws SystemException

Returns true if a matching social request exists in the database.

Parameters:

userId - the primary key of the requesting user

className - the class name of the asset that is the subject of the request

classPK - the primary key of the asset that is the subject of the request

type - the request's type

receiverUserId - the primary key of the receiving user

status - the social request's status

Returns:

true if the social request exists; false otherwise

Throws:

SystemException - if a system exception occurred

updateRequest

public static SocialRequest updateRequest(long requestId,
                          int status,
                          ThemeDisplay themeDisplay)
                                   throws PortalException,
                                          SystemException

Updates the social request replacing its status.

If the status is updated to SocialRequestConstants.STATUS_CONFIRM then SocialRequestInterpreterLocalService.processConfirmation( SocialRequest, ThemeDisplay) is called. If the status is updated to SocialRequestConstants.STATUS_IGNORE then SocialRequestInterpreterLocalService.processRejection( SocialRequest, ThemeDisplay) is called.

Parameters:

requestId - the primary key of the social request

status - the new status

themeDisplay - the theme display

Returns:

the updated social request

Throws:

PortalException - if the social request could not be found

SystemException - if a system exception occurred

getService

public static SocialRequestLocalService getService()

setService

public void setService(SocialRequestLocalService service)

Deprecated. As of 6.2.0