com.liferay.portlet.social.service.SocialRequestLocalServiceUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portlet.social.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
import com.liferay.portal.kernel.util.ReferenceRegistry;
/**
* Provides the local service utility for SocialRequest. This utility wraps
* {@link 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 SocialRequestLocalService
* @see com.liferay.portlet.social.service.base.SocialRequestLocalServiceBaseImpl
* @see com.liferay.portlet.social.service.impl.SocialRequestLocalServiceImpl
* @generated
*/
@ProviderType
public class SocialRequestLocalServiceUtil {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.social.service.impl.SocialRequestLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
*/
/**
* Adds the social request to the database. Also notifies the appropriate model listeners.
*
* @param socialRequest the social request
* @return the social request that was added
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.social.model.SocialRequest addSocialRequest(
com.liferay.portlet.social.model.SocialRequest socialRequest)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().addSocialRequest(socialRequest);
}
/**
* Creates a new social request with the primary key. Does not add the social request to the database.
*
* @param requestId the primary key for the new social request
* @return the new social request
*/
public static com.liferay.portlet.social.model.SocialRequest createSocialRequest(
long requestId) {
return getService().createSocialRequest(requestId);
}
/**
* Deletes the social request with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param requestId the primary key of the social request
* @return the social request that was removed
* @throws PortalException if a social request with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.social.model.SocialRequest deleteSocialRequest(
long requestId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().deleteSocialRequest(requestId);
}
/**
* Deletes the social request from the database. Also notifies the appropriate model listeners.
*
* @param socialRequest the social request
* @return the social request that was removed
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.social.model.SocialRequest deleteSocialRequest(
com.liferay.portlet.social.model.SocialRequest socialRequest)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().deleteSocialRequest(socialRequest);
}
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
return getService().dynamicQuery();
}
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().dynamicQuery(dynamicQuery);
}
/**
* 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 {@link 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 and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.social.model.impl.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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end) throws com.liferay.portal.kernel.exception.SystemException {
return getService().dynamicQuery(dynamicQuery, start, end);
}
/**
* 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 {@link 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 and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.social.model.impl.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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.dynamicQuery(dynamicQuery, start, end, orderByComparator);
}
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().dynamicQueryCount(dynamicQuery);
}
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().dynamicQueryCount(dynamicQuery, projection);
}
public static com.liferay.portlet.social.model.SocialRequest fetchSocialRequest(
long requestId)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().fetchSocialRequest(requestId);
}
/**
* Returns the social request with the matching UUID and company.
*
* @param uuid the social request's UUID
* @param companyId the primary key of the company
* @return the matching social request, or null if a matching social request could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.social.model.SocialRequest fetchSocialRequestByUuidAndCompanyId(
java.lang.String uuid, long companyId)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().fetchSocialRequestByUuidAndCompanyId(uuid, companyId);
}
/**
* Returns the social request matching the UUID and group.
*
* @param uuid the social request's UUID
* @param groupId the primary key of the group
* @return the matching social request, or null if a matching social request could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.social.model.SocialRequest fetchSocialRequestByUuidAndGroupId(
java.lang.String uuid, long groupId)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().fetchSocialRequestByUuidAndGroupId(uuid, groupId);
}
/**
* Returns the social request with the primary key.
*
* @param requestId the primary key of the social request
* @return the social request
* @throws PortalException if a social request with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.social.model.SocialRequest getSocialRequest(
long requestId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getSocialRequest(requestId);
}
public static com.liferay.portal.model.PersistedModel getPersistedModel(
java.io.Serializable primaryKeyObj)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getPersistedModel(primaryKeyObj);
}
/**
* Returns the social request with the matching UUID and company.
*
* @param uuid the social request's UUID
* @param companyId the primary key of the company
* @return the matching social request
* @throws PortalException if a matching social request could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.social.model.SocialRequest getSocialRequestByUuidAndCompanyId(
java.lang.String uuid, long companyId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getSocialRequestByUuidAndCompanyId(uuid, companyId);
}
/**
* Returns the social request matching the UUID and group.
*
* @param uuid the social request's UUID
* @param groupId the primary key of the group
* @return the matching social request
* @throws PortalException if a matching social request could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.social.model.SocialRequest getSocialRequestByUuidAndGroupId(
java.lang.String uuid, long groupId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getSocialRequestByUuidAndGroupId(uuid, groupId);
}
/**
* 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 {@link 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 and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.social.model.impl.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.
*
*
* @param start the lower bound of the range of social requests
* @param end the upper bound of the range of social requests (not inclusive)
* @return the range of social requests
* @throws SystemException if a system exception occurred
*/
public static java.util.List getSocialRequests(
int start, int end)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getSocialRequests(start, end);
}
/**
* Returns the number of social requests.
*
* @return the number of social requests
* @throws SystemException if a system exception occurred
*/
public static int getSocialRequestsCount()
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getSocialRequestsCount();
}
/**
* Updates the social request in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param socialRequest the social request
* @return the social request that was updated
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.social.model.SocialRequest updateSocialRequest(
com.liferay.portlet.social.model.SocialRequest socialRequest)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().updateSocialRequest(socialRequest);
}
/**
* Returns the Spring bean ID for this bean.
*
* @return the Spring bean ID for this bean
*/
public static java.lang.String getBeanIdentifier() {
return getService().getBeanIdentifier();
}
/**
* Sets the Spring bean ID for this bean.
*
* @param beanIdentifier the Spring bean ID for this bean
*/
public static void setBeanIdentifier(java.lang.String beanIdentifier) {
getService().setBeanIdentifier(beanIdentifier);
}
/**
* 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.
*
*
* @param userId the primary key of the requesting user
* @param groupId the primary key of the group
* @param className the class name of the asset that is the subject of the
request
* @param classPK the primary key of the asset that is the subject of the
request
* @param type the request's type
* @param extraData the extra data regarding the request
* @param receiverUserId the primary key of the user receiving the request
* @return 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.social.model.SocialRequest addRequest(
long userId, long groupId, java.lang.String className, long classPK,
int type, java.lang.String extraData, long receiverUserId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.addRequest(userId, groupId, className, classPK, type,
extraData, receiverUserId);
}
/**
* Removes all the social requests for the receiving user.
*
* @param receiverUserId the primary key of the receiving user
* @throws SystemException if a system exception occurred
*/
public static void deleteReceiverUserRequests(long receiverUserId)
throws com.liferay.portal.kernel.exception.SystemException {
getService().deleteReceiverUserRequests(receiverUserId);
}
/**
* Removes the social request identified by its primary key from the
* database.
*
* @param requestId the primary key of the social request
* @throws PortalException if the social request could not be found
* @throws SystemException if a system exception occurred
*/
public static void deleteRequest(long requestId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().deleteRequest(requestId);
}
/**
* Removes the social request from the database.
*
* @param request the social request to be removed
* @throws SystemException if a system exception occurred
*/
public static void deleteRequest(
com.liferay.portlet.social.model.SocialRequest request)
throws com.liferay.portal.kernel.exception.SystemException {
getService().deleteRequest(request);
}
/**
* Removes all the social requests for the requesting user.
*
* @param userId the primary key of the requesting user
* @throws SystemException if a system exception occurred
*/
public static void deleteUserRequests(long userId)
throws com.liferay.portal.kernel.exception.SystemException {
getService().deleteUserRequests(userId);
}
/**
* 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 {@link
* com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param receiverUserId the primary key of the receiving user
* @param start the lower bound of the range of results
* @param end the upper bound of the range of results (not inclusive)
* @return the range of matching social requests
* @throws SystemException if a system exception occurred
*/
public static java.util.List getReceiverUserRequests(
long receiverUserId, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getReceiverUserRequests(receiverUserId, start, 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 {@link
* com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param receiverUserId the primary key of the receiving user
* @param status the social request's status
* @param start the lower bound of the range of results
* @param end the upper bound of the range of results (not inclusive)
* @return the range of matching social requests
* @throws SystemException if a system exception occurred
*/
public static java.util.List getReceiverUserRequests(
long receiverUserId, int status, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.getReceiverUserRequests(receiverUserId, status, start, end);
}
/**
* Returns the number of social requests for the receiving user.
*
* @param receiverUserId the primary key of the receiving user
* @return the number of matching social requests
* @throws SystemException if a system exception occurred
*/
public static int getReceiverUserRequestsCount(long receiverUserId)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getReceiverUserRequestsCount(receiverUserId);
}
/**
* Returns the number of social requests with the given status for the
* receiving user.
*
* @param receiverUserId the primary key of the receiving user
* @param status the social request's status
* @return the number of matching social requests
* @throws SystemException if a system exception occurred
*/
public static int getReceiverUserRequestsCount(long receiverUserId,
int status) throws com.liferay.portal.kernel.exception.SystemException {
return getService().getReceiverUserRequestsCount(receiverUserId, status);
}
/**
* 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 {@link
* com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param userId the primary key of the requesting user
* @param start the lower bound of the range of results
* @param end the upper bound of the range of results (not inclusive)
* @return the range of matching social requests
* @throws SystemException if a system exception occurred
*/
public static java.util.List getUserRequests(
long userId, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getUserRequests(userId, start, 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 {@link
* com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
* result set.
*
*
* @param userId the primary key of the requesting user
* @param status the social request's status
* @param start the lower bound of the range of results
* @param end the upper bound of the range of results (not inclusive)
* @return the range of matching social requests
* @throws SystemException if a system exception occurred
*/
public static java.util.List getUserRequests(
long userId, int status, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getUserRequests(userId, status, start, end);
}
/**
* Returns the number of social requests for the requesting user.
*
* @param userId the primary key of the requesting user
* @return the number of matching social requests
* @throws SystemException if a system exception occurred
*/
public static int getUserRequestsCount(long userId)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getUserRequestsCount(userId);
}
/**
* Returns the number of social requests with the given status for the
* requesting user.
*
* @param userId the primary key of the requesting user
* @param status the social request's status
* @return the number of matching social request
* @throws SystemException if a system exception occurred
*/
public static int getUserRequestsCount(long userId, int status)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getUserRequestsCount(userId, status);
}
/**
* Returns true if a matching social requests exists in the
* database.
*
* @param userId the primary key of the requesting user
* @param className the class name of the asset that is the subject of the
request
* @param classPK the primary key of the asset that is the subject of the
request
* @param type the request's type
* @param status the social request's status
* @return true if the request exists; false
otherwise
* @throws SystemException if a system exception occurred
*/
public static boolean hasRequest(long userId, java.lang.String className,
long classPK, int type, int status)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().hasRequest(userId, className, classPK, type, status);
}
/**
* Returns true if a matching social request exists in the
* database.
*
* @param userId the primary key of the requesting user
* @param className the class name of the asset that is the subject of the
request
* @param classPK the primary key of the asset that is the subject of the
request
* @param type the request's type
* @param receiverUserId the primary key of the receiving user
* @param status the social request's status
* @return true if the social request exists;
false otherwise
* @throws SystemException if a system exception occurred
*/
public static boolean hasRequest(long userId, java.lang.String className,
long classPK, int type, long receiverUserId, int status)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.hasRequest(userId, className, classPK, type,
receiverUserId, status);
}
/**
* Updates the social request replacing its status.
*
*
* If the status is updated to {@link
* com.liferay.portlet.social.model.SocialRequestConstants#STATUS_CONFIRM}
* then {@link
* com.liferay.portlet.social.service.SocialRequestInterpreterLocalService#processConfirmation(
* SocialRequest, ThemeDisplay)} is called. If the status is updated to
* {@link
* com.liferay.portlet.social.model.SocialRequestConstants#STATUS_IGNORE}
* then {@link
* com.liferay.portlet.social.service.SocialRequestInterpreterLocalService#processRejection(
* SocialRequest, ThemeDisplay)} is called.
*
*
* @param requestId the primary key of the social request
* @param status the new status
* @param themeDisplay the theme display
* @return the updated social request
* @throws PortalException if the social request could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.social.model.SocialRequest updateRequest(
long requestId, int status,
com.liferay.portal.theme.ThemeDisplay themeDisplay)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().updateRequest(requestId, status, themeDisplay);
}
public static SocialRequestLocalService getService() {
if (_service == null) {
_service = (SocialRequestLocalService)PortalBeanLocatorUtil.locate(SocialRequestLocalService.class.getName());
ReferenceRegistry.registerReference(SocialRequestLocalServiceUtil.class,
"_service");
}
return _service;
}
/**
* @deprecated As of 6.2.0
*/
public void setService(SocialRequestLocalService service) {
}
private static SocialRequestLocalService _service;
}