Liferay 6.1.2-ce-ga3

com.liferay.portlet.social.service
Interface SocialRequestLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
SocialRequestLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface SocialRequestLocalService
extends BaseLocalService, PersistedModelLocalService

The interface for the social request local service.

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:
SocialRequestLocalServiceUtil, com.liferay.portlet.social.service.base.SocialRequestLocalServiceBaseImpl, com.liferay.portlet.social.service.impl.SocialRequestLocalServiceImpl

Method Summary
 SocialRequest addRequest(long userId, long groupId, String className, long classPK, int type, String extraData, long receiverUserId)
          Adds a social request to the database.
 SocialRequest addSocialRequest(SocialRequest socialRequest)
          Adds the social request to the database.
 SocialRequest createSocialRequest(long requestId)
          Creates a new social request with the primary key.
 void deleteReceiverUserRequests(long receiverUserId)
          Removes all the social requests for the receiving user.
 void deleteRequest(long requestId)
          Removes the social request identified by its primary key from the database.
 void deleteRequest(SocialRequest request)
          Removes the social request from the database.
 SocialRequest deleteSocialRequest(long requestId)
          Deletes the social request with the primary key from the database.
 SocialRequest deleteSocialRequest(SocialRequest socialRequest)
          Deletes the social request from the database.
 void deleteUserRequests(long userId)
          Removes all the social requests for the requesting user.
 DynamicQuery dynamicQuery()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
 SocialRequest fetchSocialRequest(long requestId)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 List<SocialRequest> getReceiverUserRequests(long receiverUserId, int start, int end)
          Returns a range of all the social requests for the receiving user.
 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.
 int getReceiverUserRequestsCount(long receiverUserId)
          Returns the number of social requests for the receiving user.
 int getReceiverUserRequestsCount(long receiverUserId, int status)
          Returns the number of social requests with the given status for the receiving user.
 SocialRequest getSocialRequest(long requestId)
          Returns the social request with the primary key.
 SocialRequest getSocialRequestByUuidAndGroupId(String uuid, long groupId)
          Returns the social request with the UUID in the group.
 List<SocialRequest> getSocialRequests(int start, int end)
          Returns a range of all the social requests.
 int getSocialRequestsCount()
          Returns the number of social requests.
 List<SocialRequest> getUserRequests(long userId, int start, int end)
          Returns a range of all the social requests for the requesting user.
 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.
 int getUserRequestsCount(long userId)
          Returns the number of social requests for the requesting user.
 int getUserRequestsCount(long userId, int status)
          Returns the number of social requests with the given status for the requesting user.
 boolean hasRequest(long userId, String className, long classPK, int type, int status)
          Returns true if a matching social requests exists in the database.
 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.
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 SocialRequest updateRequest(long requestId, int status, ThemeDisplay themeDisplay)
          Updates the social request replacing its status.
 SocialRequest updateSocialRequest(SocialRequest socialRequest)
          Updates the social request in the database or adds it if it does not yet exist.
 SocialRequest updateSocialRequest(SocialRequest socialRequest, boolean merge)
          Updates the social request in the database or adds it if it does not yet exist.
 

Method Detail

addSocialRequest

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

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

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

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

DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

fetchSocialRequest

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialRequest fetchSocialRequest(long requestId)
                                 throws SystemException
Throws:
SystemException

getSocialRequest

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getSocialRequestByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialRequest getSocialRequestByUuidAndGroupId(String uuid,
                                                                                        long groupId)
                                               throws PortalException,
                                                      SystemException
Returns the social request with the UUID in the group.

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

getSocialRequests

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getSocialRequestsCount()
                           throws SystemException
Returns the number of social requests.

Returns:
the number of social requests
Throws:
SystemException - if a system exception occurred

updateSocialRequest

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

updateSocialRequest

SocialRequest updateSocialRequest(SocialRequest socialRequest,
                                  boolean merge)
                                  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
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

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addRequest

SocialRequest addRequest(long userId,
                         long groupId,
                         String className,
                         long classPK,
                         int type,
                         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

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

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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasRequest(long userId,
                                                            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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasRequest(long userId,
                                                            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

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

Liferay 6.1.2-ce-ga3