Class SocialRequestLocalServiceUtil

Object
com.liferay.social.kernel.service.SocialRequestLocalServiceUtil

public class SocialRequestLocalServiceUtil extends Object
Provides the local service utility for SocialRequest. This utility wraps com.liferay.portlet.social.service.impl.SocialRequestLocalServiceImpl and is an 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:
{$generated.description}
  • Constructor Details

    • SocialRequestLocalServiceUtil

      public SocialRequestLocalServiceUtil()
  • Method Details

    • addRequest

      public static SocialRequest addRequest(long userId, long groupId, String className, long classPK, int type, String extraData, long receiverUserId) throws PortalException
      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
    • addSocialRequest

      public static SocialRequest addSocialRequest(SocialRequest socialRequest)
      Adds the social request to the database. Also notifies the appropriate model listeners.

      Important: Inspect SocialRequestLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      socialRequest - the social request
      Returns:
      the social request that was added
    • createPersistedModel

      public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • 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
    • deletePersistedModel

      public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Throws:
      PortalException
    • deleteReceiverUserRequests

      public static void deleteReceiverUserRequests(long receiverUserId)
      Removes all the social requests for the receiving user.
      Parameters:
      receiverUserId - the primary key of the receiving user
    • deleteRequest

      public static void deleteRequest(long requestId) throws PortalException
      Removes the social request identified by its primary key from the database.
      Parameters:
      requestId - the primary key of the social request
      Throws:
      PortalException
    • deleteRequest

      public static void deleteRequest(SocialRequest request)
      Removes the social request from the database.
      Parameters:
      request - the social request to be removed
    • deleteRequests

      public static void deleteRequests(long className, long classPK)
    • deleteSocialRequest

      public static SocialRequest deleteSocialRequest(long requestId) throws PortalException
      Deletes the social request with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect SocialRequestLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      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
    • deleteSocialRequest

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

      Important: Inspect SocialRequestLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      socialRequest - the social request
      Returns:
      the social request that was removed
    • deleteUserRequests

      public static void deleteUserRequests(long userId)
      Removes all the social requests for the requesting user.
      Parameters:
      userId - the primary key of the requesting user
    • dslQuery

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

      public static DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

      public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portlet.social.model.impl.SocialRequestModelImpl.

      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
    • dynamicQuery

      public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portlet.social.model.impl.SocialRequestModelImpl.

      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
    • dynamicQueryCount

      public static long dynamicQueryCount(DynamicQuery dynamicQuery)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the number of rows matching the dynamic query
    • dynamicQueryCount

      public static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchSocialRequest

      public static SocialRequest fetchSocialRequest(long requestId)
    • fetchSocialRequestByUuidAndGroupId

      public static SocialRequest fetchSocialRequestByUuidAndGroupId(String uuid, long groupId)
      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
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getIndexableActionableDynamicQuery

      public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • getReceiverUserRequests

      public static List<SocialRequest> getReceiverUserRequests(long receiverUserId, int start, int end)
      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
    • getReceiverUserRequests

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

      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
    • getReceiverUserRequestsCount

      public static int getReceiverUserRequestsCount(long receiverUserId)
      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
    • getReceiverUserRequestsCount

      public static int getReceiverUserRequestsCount(long receiverUserId, int status)
      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
    • getSocialRequest

      public static SocialRequest getSocialRequest(long requestId) throws PortalException
      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
    • getSocialRequestByUuidAndGroupId

      public static SocialRequest getSocialRequestByUuidAndGroupId(String uuid, long groupId) throws PortalException
      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
    • getSocialRequests

      public static List<SocialRequest> getSocialRequests(int start, int end)
      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portlet.social.model.impl.SocialRequestModelImpl.

      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
    • getSocialRequestsByUuidAndCompanyId

      public static List<SocialRequest> getSocialRequestsByUuidAndCompanyId(String uuid, long companyId)
      Returns all the social requests matching the UUID and company.
      Parameters:
      uuid - the UUID of the social requests
      companyId - the primary key of the company
      Returns:
      the matching social requests, or an empty list if no matches were found
    • getSocialRequestsByUuidAndCompanyId

      public static List<SocialRequest> getSocialRequestsByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<SocialRequest> orderByComparator)
      Returns a range of social requests matching the UUID and company.
      Parameters:
      uuid - the UUID of the social requests
      companyId - the primary key of the company
      start - the lower bound of the range of social requests
      end - the upper bound of the range of social requests (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching social requests, or an empty list if no matches were found
    • getSocialRequestsCount

      public static int getSocialRequestsCount()
      Returns the number of social requests.
      Returns:
      the number of social requests
    • getUserRequests

      public static List<SocialRequest> getUserRequests(long userId, int start, int end)
      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
    • getUserRequests

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

      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
    • getUserRequestsCount

      public static int getUserRequestsCount(long userId)
      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
    • getUserRequestsCount

      public static int getUserRequestsCount(long userId, int status)
      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
    • hasRequest

      public static boolean hasRequest(long userId, String className, long classPK, int type, int status)
      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
    • hasRequest

      public static boolean hasRequest(long userId, String className, long classPK, int type, long receiverUserId, int status)
      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
    • updateRequest

      public static SocialRequest updateRequest(long requestId, int status, ThemeDisplay themeDisplay) throws PortalException
      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
    • updateSocialRequest

      public static SocialRequest updateSocialRequest(SocialRequest socialRequest)
      Updates the social request in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect SocialRequestLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      socialRequest - the social request
      Returns:
      the social request that was updated
    • getService

      public static SocialRequestLocalService getService()
    • setService

      public static void setService(SocialRequestLocalService service)