|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface SocialRequestLocalServiceProvides the local service interface for SocialRequest. 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.
SocialRequestLocalServiceUtil,
SocialRequestLocalServiceBaseImpl,
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. |
|
PersistedModel |
deletePersistedModel(PersistedModel persistedModel)
|
|
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)
|
|
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()
|
|
|
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
|
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
|
|
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. |
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query. |
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query. |
|
SocialRequest |
fetchSocialRequest(long requestId)
|
|
SocialRequest |
fetchSocialRequestByUuidAndGroupId(String uuid,
long groupId)
Returns the social request matching the UUID and group. |
|
ActionableDynamicQuery |
getActionableDynamicQuery()
|
|
IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery()
|
|
String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier. |
|
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 matching the UUID and group. |
|
List<SocialRequest> |
getSocialRequests(int start,
int end)
Returns a range of all the social requests. |
|
List<SocialRequest> |
getSocialRequestsByUuidAndCompanyId(String uuid,
long companyId)
Returns all the social requests matching the UUID and company. |
|
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. |
|
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. |
|
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. |
|
| Method Detail |
|---|
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
PortalException@Indexable(type=REINDEX) SocialRequest addSocialRequest(SocialRequest socialRequest)
socialRequest - the social request
SocialRequest createSocialRequest(long requestId)
requestId - the primary key for the new social request
PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException
deletePersistedModel in interface PersistedModelLocalServicePortalExceptionvoid deleteReceiverUserRequests(long receiverUserId)
receiverUserId - the primary key of the receiving uservoid deleteRequest(SocialRequest request)
request - the social request to be removed
void deleteRequest(long requestId)
throws PortalException
requestId - the primary key of the social request
PortalException
void deleteRequests(long className,
long classPK)
@Indexable(type=DELETE)
SocialRequest deleteSocialRequest(long requestId)
throws PortalException
requestId - the primary key of the social request
PortalException - if a social request with the primary key could not be found@Indexable(type=DELETE) SocialRequest deleteSocialRequest(SocialRequest socialRequest)
socialRequest - the social request
void deleteUserRequests(long userId)
userId - the primary key of the requesting userDynamicQuery dynamicQuery()
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
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. 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)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> orderByComparator)
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)
long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
dynamicQuery - the dynamic queryprojection - the projection to apply to the query
@Transactional(propagation=SUPPORTS,
readOnly=true)
SocialRequest fetchSocialRequest(long requestId)
@Transactional(propagation=SUPPORTS,
readOnly=true)
SocialRequest fetchSocialRequestByUuidAndGroupId(String uuid,
long groupId)
uuid - the social request's UUIDgroupId - the primary key of the group
null if a matching social request could not be found
@Transactional(propagation=SUPPORTS,
readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()
@Transactional(propagation=SUPPORTS,
readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
String getOSGiServiceIdentifier()
@Transactional(propagation=SUPPORTS,
readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException
getPersistedModel in interface PersistedModelLocalServicePortalException
@Transactional(propagation=SUPPORTS,
readOnly=true)
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)
@Transactional(propagation=SUPPORTS,
readOnly=true)
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)
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getReceiverUserRequestsCount(long receiverUserId)
receiverUserId - the primary key of the receiving user
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getReceiverUserRequestsCount(long receiverUserId,
int status)
receiverUserId - the primary key of the receiving userstatus - the social request's status
@Transactional(propagation=SUPPORTS,
readOnly=true)
SocialRequest getSocialRequest(long requestId)
throws PortalException
requestId - the primary key of the social request
PortalException - if a social request with the primary key could not be found
@Transactional(propagation=SUPPORTS,
readOnly=true)
SocialRequest getSocialRequestByUuidAndGroupId(String uuid,
long groupId)
throws PortalException
uuid - the social request's UUIDgroupId - the primary key of the group
PortalException - if a matching social request could not be found
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<SocialRequest> getSocialRequests(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. 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)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<SocialRequest> getSocialRequestsByUuidAndCompanyId(String uuid,
long companyId)
uuid - the UUID of the social requestscompanyId - the primary key of the company
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<SocialRequest> getSocialRequestsByUuidAndCompanyId(String uuid,
long companyId,
int start,
int end,
OrderByComparator<SocialRequest> orderByComparator)
uuid - the UUID of the social requestscompanyId - the primary key of the companystart - the lower bound of the range of social requestsend - the upper bound of the range of social requests (not inclusive)orderByComparator - the comparator to order the results by (optionally null)
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getSocialRequestsCount()
@Transactional(propagation=SUPPORTS,
readOnly=true)
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)
@Transactional(propagation=SUPPORTS,
readOnly=true)
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)
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getUserRequestsCount(long userId)
userId - the primary key of the requesting user
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getUserRequestsCount(long userId,
int status)
userId - the primary key of the requesting userstatus - the social request's status
@Transactional(propagation=SUPPORTS,
readOnly=true)
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
@Transactional(propagation=SUPPORTS,
readOnly=true)
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
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@Indexable(type=REINDEX) SocialRequest updateSocialRequest(SocialRequest socialRequest)
socialRequest - the social request
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||