com.liferay.portal.kernel.service

Class MembershipRequestLocalServiceUtil

Object

com.liferay.portal.kernel.service.MembershipRequestLocalServiceUtil

@ProviderType
public class MembershipRequestLocalServiceUtil
extends Object

Provides the local service utility for MembershipRequest. This utility wraps MembershipRequestLocalServiceImpl 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.

Author:

Brian Wing Shun Chan

See Also:

MembershipRequestLocalService, MembershipRequestLocalServiceBaseImpl, MembershipRequestLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
MembershipRequestLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static MembershipRequest	addMembershipRequest(long userId, long groupId, String comments, ServiceContext serviceContext)
static MembershipRequest	addMembershipRequest(MembershipRequest membershipRequest) Adds the membership request to the database.
static MembershipRequest	createMembershipRequest(long membershipRequestId) Creates a new membership request with the primary key.
static MembershipRequest	deleteMembershipRequest(long membershipRequestId) Deletes the membership request with the primary key from the database.
static MembershipRequest	deleteMembershipRequest(MembershipRequest membershipRequest) Deletes the membership request from the database.
static void	deleteMembershipRequests(long groupId)
static void	deleteMembershipRequests(long groupId, long statusId)
static void	deleteMembershipRequestsByUserId(long userId)
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static DynamicQuery	dynamicQuery()
static <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 long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static MembershipRequest	fetchMembershipRequest(long membershipRequestId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static MembershipRequest	getMembershipRequest(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 int	getMembershipRequestsCount() Returns the number of membership requests.
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static MembershipRequestLocalService	getService()
static boolean	hasMembershipRequest(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> obc)
static int	searchCount(long groupId, int status)
static MembershipRequest	updateMembershipRequest(MembershipRequest membershipRequest) Updates the membership request in the database or adds it if it does not yet exist.
static void	updateStatus(long replierUserId, long membershipRequestId, String replyComments, long statusId, boolean addUserToGroup, ServiceContext serviceContext)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MembershipRequestLocalServiceUtil

public MembershipRequestLocalServiceUtil()

Method Detail

addMembershipRequest

public static MembershipRequest addMembershipRequest(long userId,
                                                     long groupId,
                                                     String comments,
                                                     ServiceContext serviceContext)
                                              throws PortalException

Throws:

PortalException

addMembershipRequest

public static MembershipRequest addMembershipRequest(MembershipRequest membershipRequest)

Adds the membership request to the database. Also notifies the appropriate model listeners.

Parameters:

membershipRequest - the membership request

Returns:

the membership request that was added

createMembershipRequest

public static MembershipRequest createMembershipRequest(long membershipRequestId)

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

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.

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

public static MembershipRequest deleteMembershipRequest(MembershipRequest membershipRequest)

Deletes the membership request from the database. Also notifies the appropriate model listeners.

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

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <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

public 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.

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 MembershipRequestModelImpl. 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.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - 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 - 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 MembershipRequestModelImpl. 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.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

public static 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

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchMembershipRequest

public static MembershipRequest fetchMembershipRequest(long membershipRequestId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery 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

public static List<MembershipRequest> getMembershipRequests(int start,
                                                            int end)

Returns a range of all the membership requests.

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 MembershipRequestModelImpl. 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.

Parameters:

start - the lower bound of the range of membership requests

end - 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

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

hasMembershipRequest

public static boolean hasMembershipRequest(long userId,
                                           long groupId,
                                           long statusId)

search

public static List<MembershipRequest> search(long groupId,
                                             int status,
                                             int start,
                                             int end)

search

public static List<MembershipRequest> search(long groupId,
                                             int status,
                                             int start,
                                             int end,
                                             OrderByComparator<MembershipRequest> obc)

searchCount

public static int searchCount(long groupId,
                              int status)

updateMembershipRequest

public static MembershipRequest updateMembershipRequest(MembershipRequest membershipRequest)

Updates the membership request in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

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

public static MembershipRequestLocalService getService()