Class MembershipRequestLocalServiceUtil
com.liferay.portal.service.impl.MembershipRequestLocalServiceImpl and
is an 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.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic MembershipRequestaddMembershipRequest(long userId, long groupId, String comments, ServiceContext serviceContext) static MembershipRequestaddMembershipRequest(MembershipRequest membershipRequest) Adds the membership request to the database.static MembershipRequestcreateMembershipRequest(long membershipRequestId) Creates a new membership request with the primary key.static PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static MembershipRequestdeleteMembershipRequest(long membershipRequestId) Deletes the membership request with the primary key from the database.static MembershipRequestdeleteMembershipRequest(MembershipRequest membershipRequest) Deletes the membership request from the database.static voiddeleteMembershipRequests(long groupId) static voiddeleteMembershipRequests(long groupId, long statusId) static voiddeleteMembershipRequestsByUserId(long userId) static PersistedModeldeletePersistedModel(PersistedModel persistedModel) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuerystatic <T> List<T>dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <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.static <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.static longdynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static MembershipRequestfetchMembershipRequest(long membershipRequestId) static ActionableDynamicQuerystatic MembershipRequestgetMembershipRequest(long membershipRequestId) Returns the membership request with the primary key.static List<MembershipRequest>getMembershipRequests(int start, int end) Returns a range of all the membership requests.static List<MembershipRequest>getMembershipRequests(long userId, long groupId, long statusId) static intReturns the number of membership requests.static StringReturns the OSGi service identifier.static PersistedModelgetPersistedModel(Serializable primaryKeyObj) static booleanhasMembershipRequest(long userId, long groupId, long statusId) static List<MembershipRequest>search(long groupId, int status, int start, int end) static List<MembershipRequest>search(long groupId, int status, int start, int end, OrderByComparator<MembershipRequest> orderByComparator) static intsearchCount(long groupId, int status) static voidsetService(MembershipRequestLocalService service) static MembershipRequestupdateMembershipRequest(MembershipRequest membershipRequest) Updates the membership request in the database or adds it if it does not yet exist.static voidupdateStatus(long replierUserId, long membershipRequestId, String replyComments, long statusId, boolean addUserToGroup, ServiceContext serviceContext)
-
Constructor Details
-
MembershipRequestLocalServiceUtil
public MembershipRequestLocalServiceUtil()
-
-
Method Details
-
addMembershipRequest
public static MembershipRequest addMembershipRequest(long userId, long groupId, String comments, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
addMembershipRequest
Adds the membership request to the database. Also notifies the appropriate model listeners.Important: Inspect MembershipRequestLocalServiceImpl 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:
membershipRequest- the membership request- Returns:
- the membership request that was added
-
createMembershipRequest
Creates a new membership request with the primary key. Does not add the membership request to the database.- Parameters:
membershipRequestId- the primary key for the new membership request- Returns:
- the new membership request
-
createPersistedModel
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
deleteMembershipRequest
public static MembershipRequest deleteMembershipRequest(long membershipRequestId) throws PortalException Deletes the membership request with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect MembershipRequestLocalServiceImpl 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:
membershipRequestId- the primary key of the membership request- Returns:
- the membership request that was removed
- Throws:
PortalException- if a membership request with the primary key could not be found
-
deleteMembershipRequest
Deletes the membership request from the database. Also notifies the appropriate model listeners.Important: Inspect MembershipRequestLocalServiceImpl 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:
membershipRequest- the membership request- Returns:
- the membership request that was removed
-
deleteMembershipRequests
public static void deleteMembershipRequests(long groupId) -
deleteMembershipRequests
public static void deleteMembershipRequests(long groupId, long statusId) -
deleteMembershipRequestsByUserId
public static void deleteMembershipRequestsByUserId(long userId) -
deletePersistedModel
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
PortalException
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
Performs a dynamic query on the database and returns a range of the matching rows.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.MembershipRequestModelImpl.- 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
public static <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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.MembershipRequestModelImpl.- 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
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
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
-
fetchMembershipRequest
-
getActionableDynamicQuery
-
getIndexableActionableDynamicQuery
-
getMembershipRequest
public static MembershipRequest getMembershipRequest(long membershipRequestId) throws PortalException Returns the membership request with the primary key.- Parameters:
membershipRequestId- the primary key of the membership request- Returns:
- the membership request
- Throws:
PortalException- if a membership request with the primary key could not be found
-
getMembershipRequests
Returns a range of all the membership requests.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.MembershipRequestModelImpl.- Parameters:
start- the lower bound of the range of membership requestsend- the upper bound of the range of membership requests (not inclusive)- Returns:
- the range of membership requests
-
getMembershipRequests
public static List<MembershipRequest> getMembershipRequests(long userId, long groupId, long statusId) -
getMembershipRequestsCount
public static int getMembershipRequestsCount()Returns the number of membership requests.- Returns:
- the number of membership requests
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
hasMembershipRequest
public static boolean hasMembershipRequest(long userId, long groupId, long statusId) -
search
-
search
public static List<MembershipRequest> search(long groupId, int status, int start, int end, OrderByComparator<MembershipRequest> orderByComparator) -
searchCount
public static int searchCount(long groupId, int status) -
updateMembershipRequest
Updates the membership request in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect MembershipRequestLocalServiceImpl 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:
membershipRequest- the membership request- Returns:
- the membership request that was updated
-
updateStatus
public static void updateStatus(long replierUserId, long membershipRequestId, String replyComments, long statusId, boolean addUserToGroup, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
getService
-
setService
-