|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.service.BaseLocalServiceImpl
com.liferay.portlet.social.service.base.SocialRequestLocalServiceBaseImpl
com.liferay.portlet.social.service.impl.SocialRequestLocalServiceImpl
public class SocialRequestLocalServiceImpl
The social request local service responsible for handling social requests (e.g. friend requests).
| Field Summary |
|---|
| Fields inherited from class com.liferay.portlet.social.service.base.SocialRequestLocalServiceBaseImpl |
|---|
classNameLocalService, classNamePersistence, counterLocalService, persistedModelLocalServiceRegistry, socialRequestInterpreterLocalService, socialRequestLocalService, socialRequestPersistence, userFinder, userLocalService, userPersistence |
| Constructor Summary | |
|---|---|
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. |
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. |
void |
deleteRequests(long className,
long classPK)
|
void |
deleteUserRequests(long userId)
Removes all the social requests for the requesting user. |
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. |
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. |
SocialRequest |
updateRequest(long requestId,
int status,
ThemeDisplay themeDisplay)
Updates the social request replacing its status. |
| Methods inherited from class com.liferay.portal.service.BaseLocalServiceImpl |
|---|
getClassLoader, getLocalizationMap |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public SocialRequestLocalServiceImpl()
| Method Detail |
|---|
public SocialRequest addRequest(long userId,
long groupId,
String className,
long classPK,
int type,
String extraData,
long receiverUserId)
throws PortalException
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.
userId - the primary key of the requesting usergroupId - the primary key of the groupclassName - the class name of the asset that is the subject of the
requestclassPK - the primary key of the asset that is the subject of the
requesttype - the request's typeextraData - the extra data regarding the requestreceiverUserId - the primary key of the user receiving the request
PortalExceptionpublic void deleteReceiverUserRequests(long receiverUserId)
receiverUserId - the primary key of the receiving user
public void deleteRequest(long requestId)
throws PortalException
requestId - the primary key of the social request
PortalExceptionpublic void deleteRequest(SocialRequest request)
request - the social request to be removed
public void deleteRequests(long className,
long classPK)
public void deleteUserRequests(long userId)
userId - the primary key of the requesting user
public List<SocialRequest> getReceiverUserRequests(long receiverUserId,
int start,
int end)
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.
receiverUserId - the primary key of the receiving userstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)
public List<SocialRequest> getReceiverUserRequests(long receiverUserId,
int status,
int start,
int end)
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.
receiverUserId - the primary key of the receiving userstatus - the social request's statusstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)
public int getReceiverUserRequestsCount(long receiverUserId)
receiverUserId - the primary key of the receiving user
public int getReceiverUserRequestsCount(long receiverUserId,
int status)
receiverUserId - the primary key of the receiving userstatus - the social request's status
public List<SocialRequest> getUserRequests(long userId,
int start,
int end)
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.
userId - the primary key of the requesting userstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)
public List<SocialRequest> getUserRequests(long userId,
int status,
int start,
int end)
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.
userId - the primary key of the requesting userstatus - the social request's statusstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)
public int getUserRequestsCount(long userId)
userId - the primary key of the requesting user
public int getUserRequestsCount(long userId,
int status)
userId - the primary key of the requesting userstatus - the social request's status
public boolean hasRequest(long userId,
String className,
long classPK,
int type,
int status)
true if a matching social requests exists in the
database.
userId - the primary key of the requesting userclassName - the class name of the asset that is the subject of the
requestclassPK - the primary key of the asset that is the subject of the
requesttype - the request's typestatus - the social request's status
true if the request exists; false
otherwise
public boolean hasRequest(long userId,
String className,
long classPK,
int type,
long receiverUserId,
int status)
true if a matching social request exists in the
database.
userId - the primary key of the requesting userclassName - the class name of the asset that is the subject of the
requestclassPK - the primary key of the asset that is the subject of the
requesttype - the request's typereceiverUserId - the primary key of the receiving userstatus - the social request's status
true if the social request exists;
false otherwise
public SocialRequest updateRequest(long requestId,
int status,
ThemeDisplay themeDisplay)
throws PortalException
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.
requestId - the primary key of the social requeststatus - the new statusthemeDisplay - the theme display
PortalException
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||