Liferay 6.0.5

com.liferay.portlet.social.service
Class SocialRequestLocalServiceUtil

java.lang.Object
  extended by com.liferay.portlet.social.service.SocialRequestLocalServiceUtil

public class SocialRequestLocalServiceUtil
extends Object

The utility for the social request local service. This utility wraps SocialRequestLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

Never modify this class directly. Add custom service methods to SocialRequestLocalServiceImpl and rerun ServiceBuilder to regenerate this class.

This is a local service. 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:
SocialRequestLocalService, SocialRequestLocalServiceBaseImpl, SocialRequestLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary
SocialRequestLocalServiceUtil()
           
 
Method Summary
static SocialRequest addRequest(long userId, long groupId, String className, long classPK, int type, String extraData, long receiverUserId)
           
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)
           
static void deleteRequest(long requestId)
           
static void deleteSocialRequest(long requestId)
          Deletes the social request with the primary key from the database.
static void deleteSocialRequest(SocialRequest socialRequest)
          Deletes the social request from the database.
static void deleteUserRequests(long userId)
           
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static 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)
          Counts the number of rows that match the dynamic query.
static List<SocialRequest> getReceiverUserRequests(long receiverUserId, int start, int end)
           
static List<SocialRequest> getReceiverUserRequests(long receiverUserId, int status, int start, int end)
           
static int getReceiverUserRequestsCount(long receiverUserId)
           
static int getReceiverUserRequestsCount(long receiverUserId, int status)
           
static SocialRequestLocalService getService()
           
static SocialRequest getSocialRequest(long requestId)
          Gets the social request with the primary key.
static SocialRequest getSocialRequestByUuidAndGroupId(String uuid, long groupId)
          Gets the social request with the UUID and group id.
static List<SocialRequest> getSocialRequests(int start, int end)
          Gets a range of all the social requests.
static int getSocialRequestsCount()
          Gets the number of social requests.
static List<SocialRequest> getUserRequests(long userId, int start, int end)
           
static List<SocialRequest> getUserRequests(long userId, int status, int start, int end)
           
static int getUserRequestsCount(long userId)
           
static int getUserRequestsCount(long userId, int status)
           
static boolean hasRequest(long userId, String className, long classPK, int type, int status)
           
static boolean hasRequest(long userId, String className, long classPK, int type, long receiverUserId, int status)
           
 void setService(SocialRequestLocalService service)
           
static SocialRequest updateRequest(long requestId, int status, ThemeDisplay themeDisplay)
           
static SocialRequest updateSocialRequest(SocialRequest socialRequest)
          Updates the social request in the database.
static SocialRequest updateSocialRequest(SocialRequest socialRequest, boolean merge)
          Updates the social request in the database.
 
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 to add
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 void 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 to delete
Throws:
PortalException - if a social request with the primary key could not be found
SystemException - if a system exception occurred

deleteSocialRequest

public static void deleteSocialRequest(SocialRequest socialRequest)
                                throws SystemException
Deletes the social request from the database. Also notifies the appropriate model listeners.

Parameters:
socialRequest - the social request to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

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

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

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

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException
Counts the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

getSocialRequest

public static SocialRequest getSocialRequest(long requestId)
                                      throws PortalException,
                                             SystemException
Gets the social request with the primary key.

Parameters:
requestId - the primary key of the social request to get
Returns:
the social request
Throws:
PortalException - if a social request with the primary key could not be found
SystemException - if a system exception occurred

getSocialRequestByUuidAndGroupId

public static SocialRequest getSocialRequestByUuidAndGroupId(String uuid,
                                                             long groupId)
                                                      throws PortalException,
                                                             SystemException
Gets the social request with the UUID and group id.

Parameters:
uuid - the UUID of social request to get
groupId - the group id of the social request to get
Returns:
the social request
Throws:
PortalException - if a social request with the UUID and group id could not be found
SystemException - if a system exception occurred

getSocialRequests

public static List<SocialRequest> getSocialRequests(int start,
                                                    int end)
                                             throws SystemException
Gets 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.

Parameters:
start - the lower bound of the range of social requests to return
end - the upper bound of the range of social requests to return (not inclusive)
Returns:
the range of social requests
Throws:
SystemException - if a system exception occurred

getSocialRequestsCount

public static int getSocialRequestsCount()
                                  throws SystemException
Gets 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. Also notifies the appropriate model listeners.

Parameters:
socialRequest - the social request to update
Returns:
the social request that was updated
Throws:
SystemException - if a system exception occurred

updateSocialRequest

public static SocialRequest updateSocialRequest(SocialRequest socialRequest,
                                                boolean merge)
                                         throws SystemException
Updates the social request in the database. Also notifies the appropriate model listeners.

Parameters:
socialRequest - the social request to update
merge - whether to merge the social request with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the social request that was updated
Throws:
SystemException - if a system exception occurred

addRequest

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

deleteReceiverUserRequests

public static void deleteReceiverUserRequests(long receiverUserId)
                                       throws SystemException
Throws:
SystemException

deleteRequest

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

deleteUserRequests

public static void deleteUserRequests(long userId)
                               throws SystemException
Throws:
SystemException

getReceiverUserRequests

public static List<SocialRequest> getReceiverUserRequests(long receiverUserId,
                                                          int start,
                                                          int end)
                                                   throws SystemException
Throws:
SystemException

getReceiverUserRequests

public static List<SocialRequest> getReceiverUserRequests(long receiverUserId,
                                                          int status,
                                                          int start,
                                                          int end)
                                                   throws SystemException
Throws:
SystemException

getReceiverUserRequestsCount

public static int getReceiverUserRequestsCount(long receiverUserId)
                                        throws SystemException
Throws:
SystemException

getReceiverUserRequestsCount

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

getUserRequests

public static List<SocialRequest> getUserRequests(long userId,
                                                  int start,
                                                  int end)
                                           throws SystemException
Throws:
SystemException

getUserRequests

public static List<SocialRequest> getUserRequests(long userId,
                                                  int status,
                                                  int start,
                                                  int end)
                                           throws SystemException
Throws:
SystemException

getUserRequestsCount

public static int getUserRequestsCount(long userId)
                                throws SystemException
Throws:
SystemException

getUserRequestsCount

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

hasRequest

public static boolean hasRequest(long userId,
                                 String className,
                                 long classPK,
                                 int type,
                                 int status)
                          throws SystemException
Throws:
SystemException

hasRequest

public static boolean hasRequest(long userId,
                                 String className,
                                 long classPK,
                                 int type,
                                 long receiverUserId,
                                 int status)
                          throws SystemException
Throws:
SystemException

updateRequest

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

getService

public static SocialRequestLocalService getService()

setService

public void setService(SocialRequestLocalService service)

Liferay 6.0.5