|
Liferay 6.2.0-ce-rc3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portlet.social.service.SocialRequestLocalServiceUtil
public class SocialRequestLocalServiceUtil
Provides the local service utility for SocialRequest. This utility wraps
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.
SocialRequestLocalService,
SocialRequestLocalServiceBaseImpl,
SocialRequestLocalServiceImpl| Constructor Summary | |
|---|---|
SocialRequestLocalServiceUtil()
|
|
| Method Summary | |
|---|---|
static SocialRequest |
addRequest(long userId,
long groupId,
String className,
long classPK,
int type,
String extraData,
long receiverUserId)
Adds a social request to the database. |
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)
Removes all the social requests for the receiving user. |
static void |
deleteRequest(long requestId)
Removes the social request identified by its primary key from the database. |
static void |
deleteRequest(SocialRequest request)
Removes the social request from the database. |
static SocialRequest |
deleteSocialRequest(long requestId)
Deletes the social request with the primary key from the database. |
static SocialRequest |
deleteSocialRequest(SocialRequest socialRequest)
Deletes the social request from the database. |
static void |
deleteUserRequests(long userId)
Removes all the social requests for the requesting user. |
static DynamicQuery |
dynamicQuery()
|
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)
Returns the number of rows that match the dynamic query. |
static long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows that match the dynamic query. |
static SocialRequest |
fetchSocialRequest(long requestId)
|
static SocialRequest |
fetchSocialRequestByUuidAndCompanyId(String uuid,
long companyId)
Returns the social request with the matching UUID and company. |
static SocialRequest |
fetchSocialRequestByUuidAndGroupId(String uuid,
long groupId)
Returns the social request matching the UUID and group. |
static String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
static List<SocialRequest> |
getReceiverUserRequests(long receiverUserId,
int start,
int end)
Returns a range of all the social requests for the receiving user. |
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. |
static int |
getReceiverUserRequestsCount(long receiverUserId)
Returns the number of social requests for the receiving user. |
static int |
getReceiverUserRequestsCount(long receiverUserId,
int status)
Returns the number of social requests with the given status for the receiving user. |
static SocialRequestLocalService |
getService()
|
static SocialRequest |
getSocialRequest(long requestId)
Returns the social request with the primary key. |
static SocialRequest |
getSocialRequestByUuidAndCompanyId(String uuid,
long companyId)
Returns the social request with the matching UUID and company. |
static SocialRequest |
getSocialRequestByUuidAndGroupId(String uuid,
long groupId)
Returns the social request matching the UUID and group. |
static List<SocialRequest> |
getSocialRequests(int start,
int end)
Returns a range of all the social requests. |
static int |
getSocialRequestsCount()
Returns the number of social requests. |
static List<SocialRequest> |
getUserRequests(long userId,
int start,
int end)
Returns a range of all the social requests for the requesting user. |
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. |
static int |
getUserRequestsCount(long userId)
Returns the number of social requests for the requesting user. |
static int |
getUserRequestsCount(long userId,
int status)
Returns the number of social requests with the given status for the requesting user. |
static boolean |
hasRequest(long userId,
String className,
long classPK,
int type,
int status)
Returns true if a matching social requests exists in the
database. |
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. |
static void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
void |
setService(SocialRequestLocalService service)
Deprecated. As of 6.2.0 |
static SocialRequest |
updateRequest(long requestId,
int status,
ThemeDisplay themeDisplay)
Updates the social request replacing its status. |
static SocialRequest |
updateSocialRequest(SocialRequest socialRequest)
Updates the social request in the database or adds it if it does not yet exist. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public SocialRequestLocalServiceUtil()
| Method Detail |
|---|
public static SocialRequest addSocialRequest(SocialRequest socialRequest)
throws SystemException
socialRequest - the social request
SystemException - if a system exception occurredpublic static SocialRequest createSocialRequest(long requestId)
requestId - the primary key for the new social request
public static SocialRequest deleteSocialRequest(long requestId)
throws PortalException,
SystemException
requestId - the primary key of the social request
PortalException - if a social request with the primary key could not be found
SystemException - if a system exception occurred
public static SocialRequest deleteSocialRequest(SocialRequest socialRequest)
throws SystemException
socialRequest - the social request
SystemException - if a system exception occurredpublic static DynamicQuery dynamicQuery()
public static List dynamicQuery(DynamicQuery dynamicQuery)
throws SystemException
dynamicQuery - the dynamic query
SystemException - if a system exception occurred
public static List dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
throws SystemException
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. 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)
SystemException - if a system exception occurred
public static List dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator orderByComparator)
throws SystemException
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. 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)orderByComparator - the comparator to order the results by (optionally null)
SystemException - if a system exception occurred
public static long dynamicQueryCount(DynamicQuery dynamicQuery)
throws SystemException
dynamicQuery - the dynamic query
SystemException - if a system exception occurred
public static long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
throws SystemException
dynamicQuery - the dynamic queryprojection - the projection to apply to the query
SystemException - if a system exception occurred
public static SocialRequest fetchSocialRequest(long requestId)
throws SystemException
SystemException
public static SocialRequest fetchSocialRequestByUuidAndCompanyId(String uuid,
long companyId)
throws SystemException
uuid - the social request's UUIDcompanyId - the primary key of the company
null if a matching social request could not be found
SystemException - if a system exception occurred
public static SocialRequest fetchSocialRequestByUuidAndGroupId(String uuid,
long groupId)
throws SystemException
uuid - the social request's UUIDgroupId - the primary key of the group
null if a matching social request could not be found
SystemException - if a system exception occurred
public static SocialRequest getSocialRequest(long requestId)
throws PortalException,
SystemException
requestId - the primary key of the social request
PortalException - if a social request with the primary key could not be found
SystemException - if a system exception occurred
public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException,
SystemException
PortalException
SystemException
public static SocialRequest getSocialRequestByUuidAndCompanyId(String uuid,
long companyId)
throws PortalException,
SystemException
uuid - the social request's UUIDcompanyId - the primary key of the company
PortalException - if a matching social request could not be found
SystemException - if a system exception occurred
public static SocialRequest getSocialRequestByUuidAndGroupId(String uuid,
long groupId)
throws PortalException,
SystemException
uuid - the social request's UUIDgroupId - the primary key of the group
PortalException - if a matching social request could not be found
SystemException - if a system exception occurred
public static List<SocialRequest> getSocialRequests(int start,
int end)
throws SystemException
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. 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.
start - the lower bound of the range of social requestsend - the upper bound of the range of social requests (not inclusive)
SystemException - if a system exception occurred
public static int getSocialRequestsCount()
throws SystemException
SystemException - if a system exception occurred
public static SocialRequest updateSocialRequest(SocialRequest socialRequest)
throws SystemException
socialRequest - the social request
SystemException - if a system exception occurredpublic static String getBeanIdentifier()
public static void setBeanIdentifier(String beanIdentifier)
beanIdentifier - the Spring bean ID for this bean
public static SocialRequest addRequest(long userId,
long groupId,
String className,
long classPK,
int type,
String extraData,
long receiverUserId)
throws PortalException,
SystemException
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
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
public static void deleteReceiverUserRequests(long receiverUserId)
throws SystemException
receiverUserId - the primary key of the receiving user
SystemException - if a system exception occurred
public static void deleteRequest(long requestId)
throws PortalException,
SystemException
requestId - the primary key of the social request
PortalException - if the social request could not be found
SystemException - if a system exception occurred
public static void deleteRequest(SocialRequest request)
throws SystemException
request - the social request to be removed
SystemException - if a system exception occurred
public static void deleteUserRequests(long userId)
throws SystemException
userId - the primary key of the requesting user
SystemException - if a system exception occurred
public static List<SocialRequest> getReceiverUserRequests(long receiverUserId,
int start,
int end)
throws SystemException
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)
SystemException - if a system exception occurred
public static List<SocialRequest> getReceiverUserRequests(long receiverUserId,
int status,
int start,
int end)
throws SystemException
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)
SystemException - if a system exception occurred
public static int getReceiverUserRequestsCount(long receiverUserId)
throws SystemException
receiverUserId - the primary key of the receiving user
SystemException - if a system exception occurred
public static int getReceiverUserRequestsCount(long receiverUserId,
int status)
throws SystemException
receiverUserId - the primary key of the receiving userstatus - the social request's status
SystemException - if a system exception occurred
public static List<SocialRequest> getUserRequests(long userId,
int start,
int end)
throws SystemException
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)
SystemException - if a system exception occurred
public static List<SocialRequest> getUserRequests(long userId,
int status,
int start,
int end)
throws SystemException
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)
SystemException - if a system exception occurred
public static int getUserRequestsCount(long userId)
throws SystemException
userId - the primary key of the requesting user
SystemException - if a system exception occurred
public static int getUserRequestsCount(long userId,
int status)
throws SystemException
userId - the primary key of the requesting userstatus - the social request's status
SystemException - if a system exception occurred
public static boolean hasRequest(long userId,
String className,
long classPK,
int type,
int status)
throws SystemException
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
SystemException - if a system exception occurred
public static boolean hasRequest(long userId,
String className,
long classPK,
int type,
long receiverUserId,
int status)
throws SystemException
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
SystemException - if a system exception occurred
public static SocialRequest updateRequest(long requestId,
int status,
ThemeDisplay themeDisplay)
throws PortalException,
SystemException
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 - if the social request could not be found
SystemException - if a system exception occurredpublic static SocialRequestLocalService getService()
public void setService(SocialRequestLocalService service)
|
Liferay 6.2.0-ce-rc3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||