Interface SocialRequestLocalService
- All Superinterfaces:
BaseLocalService
,CTService<SocialRequest>
,PersistedModelLocalService
- All Known Implementing Classes:
SocialRequestLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddRequest
(long userId, long groupId, String className, long classPK, int type, String extraData, long receiverUserId) Adds a social request to the database.addSocialRequest
(SocialRequest socialRequest) Adds the social request to the database.createPersistedModel
(Serializable primaryKeyObj) createSocialRequest
(long requestId) Creates a new social request with the primary key.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) deleteSocialRequest
(long requestId) Deletes the social request with the primary key from the database.deleteSocialRequest
(SocialRequest socialRequest) Deletes the social request from the database.void
deleteUserRequests
(long userId) Removes all the social requests for the requesting user.<T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.<T> List<T>
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.fetchSocialRequest
(long requestId) fetchSocialRequestByUuidAndGroupId
(String uuid, long groupId) Returns the social request matching the UUID and group.Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getReceiverUserRequests
(long receiverUserId, int start, int end) Returns a range of all the social requests for the receiving user.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.getSocialRequest
(long requestId) Returns the social request with the primary key.getSocialRequestByUuidAndGroupId
(String uuid, long groupId) Returns the social request matching the UUID and group.getSocialRequests
(int start, int end) Returns a range of all the social requests.getSocialRequestsByUuidAndCompanyId
(String uuid, long companyId) Returns all the social requests matching the UUID and company.getSocialRequestsByUuidAndCompanyId
(String uuid, long companyId, int start, int end, OrderByComparator<SocialRequest> orderByComparator) Returns a range of social requests matching the UUID and company.int
Returns the number of social requests.getUserRequests
(long userId, int start, int end) Returns a range of all the social requests for the requesting user.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) Returnstrue
if a matching social requests exists in the database.boolean
hasRequest
(long userId, String className, long classPK, int type, long receiverUserId, int status) Returnstrue
if a matching social request exists in the database.updateRequest
(long requestId, int status, ThemeDisplay themeDisplay) Updates the social request replacing its status.updateSocialRequest
(SocialRequest socialRequest) Updates the social request in the database or adds it if it does not yet exist.<R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<SocialRequest>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addRequest
SocialRequest addRequest(long userId, long groupId, String className, long classPK, int type, String extraData, long receiverUserId) throws PortalException 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 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- Returns:
- the social request
- Throws:
PortalException
-
addSocialRequest
Adds the social request to the database. Also notifies the appropriate model listeners.Important: Inspect SocialRequestLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
socialRequest
- the social request- Returns:
- the social request that was added
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
createSocialRequest
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
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteReceiverUserRequests
void deleteReceiverUserRequests(long receiverUserId) Removes all the social requests for the receiving user.- Parameters:
receiverUserId
- the primary key of the receiving user
-
deleteRequest
Removes the social request identified by its primary key from the database.- Parameters:
requestId
- the primary key of the social request- Throws:
PortalException
-
deleteRequest
Removes the social request from the database.- Parameters:
request
- the social request to be removed
-
deleteRequests
void deleteRequests(long className, long classPK) -
deleteSocialRequest
Deletes the social request with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect SocialRequestLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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
-
deleteSocialRequest
Deletes the social request from the database. Also notifies the appropriate model listeners.Important: Inspect SocialRequestLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
socialRequest
- the social request- Returns:
- the social request that was removed
-
deleteUserRequests
void deleteUserRequests(long userId) Removes all the social requests for the requesting user.- Parameters:
userId
- the primary key of the requesting user
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.social.model.impl.SocialRequestModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> 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.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.social.model.impl.SocialRequestModelImpl
.- Parameters:
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 (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchSocialRequest
@Transactional(propagation=SUPPORTS, readOnly=true) SocialRequest fetchSocialRequest(long requestId) -
fetchSocialRequestByUuidAndGroupId
@Transactional(propagation=SUPPORTS, readOnly=true) SocialRequest fetchSocialRequestByUuidAndGroupId(String uuid, long groupId) Returns the social request matching the UUID and group.- Parameters:
uuid
- the social request's UUIDgroupId
- the primary key of the group- Returns:
- the matching social request, or
null
if a matching social request could not be found
-
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException - Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
getReceiverUserRequests
@Transactional(propagation=SUPPORTS, readOnly=true) List<SocialRequest> getReceiverUserRequests(long receiverUserId, int start, int end) Returns a range of all the social requests for the receiving user.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil.ALL_POS
will return the full result set.- Parameters:
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)- Returns:
- the range of matching social requests
-
getReceiverUserRequests
@Transactional(propagation=SUPPORTS, readOnly=true) 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.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil.ALL_POS
will return the full result set.- Parameters:
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)- Returns:
- the range of matching social requests
-
getReceiverUserRequestsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getReceiverUserRequestsCount(long receiverUserId) 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
-
getReceiverUserRequestsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getReceiverUserRequestsCount(long receiverUserId, int status) Returns the number of social requests with the given status for the receiving user.- Parameters:
receiverUserId
- the primary key of the receiving userstatus
- the social request's status- Returns:
- the number of matching social requests
-
getSocialRequest
@Transactional(propagation=SUPPORTS, readOnly=true) SocialRequest getSocialRequest(long requestId) throws PortalException 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
-
getSocialRequestByUuidAndGroupId
@Transactional(propagation=SUPPORTS, readOnly=true) SocialRequest getSocialRequestByUuidAndGroupId(String uuid, long groupId) throws PortalException Returns the social request matching the UUID and group.- Parameters:
uuid
- the social request's UUIDgroupId
- the primary key of the group- Returns:
- the matching social request
- Throws:
PortalException
- if a matching social request could not be found
-
getSocialRequests
@Transactional(propagation=SUPPORTS, readOnly=true) List<SocialRequest> getSocialRequests(int start, int end) Returns a range of all the social requests.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.social.model.impl.SocialRequestModelImpl
.- Parameters:
start
- the lower bound of the range of social requestsend
- the upper bound of the range of social requests (not inclusive)- Returns:
- the range of social requests
-
getSocialRequestsByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) List<SocialRequest> getSocialRequestsByUuidAndCompanyId(String uuid, long companyId) Returns all the social requests matching the UUID and company.- Parameters:
uuid
- the UUID of the social requestscompanyId
- the primary key of the company- Returns:
- the matching social requests, or an empty list if no matches were found
-
getSocialRequestsByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) 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.- Parameters:
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 (optionallynull
)- Returns:
- the range of matching social requests, or an empty list if no matches were found
-
getSocialRequestsCount
Returns the number of social requests.- Returns:
- the number of social requests
-
getUserRequests
@Transactional(propagation=SUPPORTS, readOnly=true) List<SocialRequest> getUserRequests(long userId, int start, int end) Returns a range of all the social requests for the requesting user.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil.ALL_POS
will return the full result set.- Parameters:
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)- Returns:
- the range of matching social requests
-
getUserRequests
@Transactional(propagation=SUPPORTS, readOnly=true) 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.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil.ALL_POS
will return the full result set.- Parameters:
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)- Returns:
- the range of matching social requests
-
getUserRequestsCount
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
-
getUserRequestsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getUserRequestsCount(long userId, int status) Returns the number of social requests with the given status for the requesting user.- Parameters:
userId
- the primary key of the requesting userstatus
- the social request's status- Returns:
- the number of matching social request
-
hasRequest
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasRequest(long userId, String className, long classPK, int type, int status) Returnstrue
if a matching social requests exists in the database.- Parameters:
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- Returns:
true
if the request exists;false
otherwise
-
hasRequest
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasRequest(long userId, String className, long classPK, int type, long receiverUserId, int status) Returnstrue
if a matching social request exists in the database.- Parameters:
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- Returns:
true
if the social request exists;false
otherwise
-
updateRequest
SocialRequest updateRequest(long requestId, int status, ThemeDisplay themeDisplay) throws PortalException Updates the social request replacing its status.If the status is updated to
SocialRequestConstants#STATUS_CONFIRM
thenSocialRequestInterpreterLocalService.processConfirmation(SocialRequest, ThemeDisplay)
is called. If the status is updated toSocialRequestConstants#STATUS_IGNORE
thenSocialRequestInterpreterLocalService.processRejection(SocialRequest, ThemeDisplay)
is called.- Parameters:
requestId
- the primary key of the social requeststatus
- the new statusthemeDisplay
- the theme display- Returns:
- the updated social request
- Throws:
PortalException
-
updateSocialRequest
Updates the social request in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect SocialRequestLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
socialRequest
- the social request- Returns:
- the social request that was updated
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<SocialRequest>
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<SocialRequest>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<SocialRequest>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<SocialRequest>
- Throws:
E extends Throwable
-