com.liferay.invitation.invite.members.service

Class MemberRequestLocalServiceUtil

java.lang.Object

com.liferay.invitation.invite.members.service.MemberRequestLocalServiceUtil

public class MemberRequestLocalServiceUtil
extends java.lang.Object

Provides the local service utility for MemberRequest. This utility wraps com.liferay.invitation.invite.members.service.impl.MemberRequestLocalServiceImpl 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.

See Also:

MemberRequestLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
MemberRequestLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static MemberRequest	addMemberRequest(long userId, long groupId, long receiverUserId, java.lang.String receiverEmailAddress, long invitedRoleId, long invitedTeamId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static MemberRequest	addMemberRequest(MemberRequest memberRequest) Adds the member request to the database.
static void	addMemberRequests(long userId, long groupId, long[] receiverUserIds, long invitedRoleId, long invitedTeamId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static void	addMemberRequests(long userId, long groupId, java.lang.String[] emailAddresses, long invitedRoleId, long invitedTeamId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static MemberRequest	createMemberRequest(long memberRequestId) Creates a new member request with the primary key.
static com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static MemberRequest	deleteMemberRequest(long memberRequestId) Deletes the member request with the primary key from the database.
static MemberRequest	deleteMemberRequest(MemberRequest memberRequest) Deletes the member request from the database.
static com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
static <T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.
static MemberRequest	fetchMemberRequest(long memberRequestId)
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static MemberRequest	getMemberRequest(long memberRequestId) Returns the member request with the primary key.
static MemberRequest	getMemberRequest(long groupId, long receiverUserId, int status)
static java.util.List<MemberRequest>	getMemberRequests(int start, int end) Returns a range of all the member requests.
static int	getMemberRequestsCount() Returns the number of member requests.
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static java.util.List<MemberRequest>	getReceiverMemberRequest(long receiverUserId, int start, int end)
static int	getReceiverMemberRequestCount(long receiverUserId)
static java.util.List<MemberRequest>	getReceiverStatusMemberRequest(long receiverUserId, int status, int start, int end)
static int	getReceiverStatusMemberRequestCount(long receiverUserId, int status)
static MemberRequestLocalService	getService()
static boolean	hasPendingMemberRequest(long groupId, long receiverUserId)
static MemberRequest	updateMemberRequest(long userId, long memberRequestId, int status)
static MemberRequest	updateMemberRequest(MemberRequest memberRequest) Updates the member request in the database or adds it if it does not yet exist.
static MemberRequest	updateMemberRequest(java.lang.String key, long receiverUserId)

Methods inherited from class java.lang.Object

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

Constructor Detail

MemberRequestLocalServiceUtil

public MemberRequestLocalServiceUtil()

Method Detail

addMemberRequest

public static MemberRequest addMemberRequest(long userId,
                                             long groupId,
                                             long receiverUserId,
                                             java.lang.String receiverEmailAddress,
                                             long invitedRoleId,
                                             long invitedTeamId,
                                             com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addMemberRequest

public static MemberRequest addMemberRequest(MemberRequest memberRequest)

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

Important: Inspect MemberRequestLocalServiceImpl 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:

memberRequest - the member request

Returns:

the member request that was added

addMemberRequests

public static void addMemberRequests(long userId,
                                     long groupId,
                                     long[] receiverUserIds,
                                     long invitedRoleId,
                                     long invitedTeamId,
                                     com.liferay.portal.kernel.service.ServiceContext serviceContext)
                              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addMemberRequests

public static void addMemberRequests(long userId,
                                     long groupId,
                                     java.lang.String[] emailAddresses,
                                     long invitedRoleId,
                                     long invitedTeamId,
                                     com.liferay.portal.kernel.service.ServiceContext serviceContext)
                              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createMemberRequest

public static MemberRequest createMemberRequest(long memberRequestId)

Creates a new member request with the primary key. Does not add the member request to the database.

Parameters:

memberRequestId - the primary key for the new member request

Returns:

the new member request

createPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

PortalException

deleteMemberRequest

public static MemberRequest deleteMemberRequest(long memberRequestId)
                                         throws com.liferay.portal.kernel.exception.PortalException

Deletes the member request with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect MemberRequestLocalServiceImpl 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:

memberRequestId - the primary key of the member request

Returns:

the member request that was removed

Throws:

PortalException - if a member request with the primary key could not be found

deleteMemberRequest

public static MemberRequest deleteMemberRequest(MemberRequest memberRequest)

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

Important: Inspect MemberRequestLocalServiceImpl 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:

memberRequest - the member request

Returns:

the member request that was removed

deletePersistedModel

public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

PortalException

dslQuery

public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.invitation.invite.members.model.impl.MemberRequestModelImpl.

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> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 com.liferay.portal.kernel.util.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.invitation.invite.members.model.impl.MemberRequestModelImpl.

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(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                     com.liferay.portal.kernel.dao.orm.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

fetchMemberRequest

public static MemberRequest fetchMemberRequest(long memberRequestId)

getActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getMemberRequest

public static MemberRequest getMemberRequest(long memberRequestId)
                                      throws com.liferay.portal.kernel.exception.PortalException

Returns the member request with the primary key.

Parameters:

memberRequestId - the primary key of the member request

Returns:

the member request

Throws:

PortalException - if a member request with the primary key could not be found

getMemberRequest

public static MemberRequest getMemberRequest(long groupId,
                                             long receiverUserId,
                                             int status)
                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getMemberRequests

public static java.util.List<MemberRequest> getMemberRequests(int start,
                                                              int end)

Returns a range of all the member 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.invitation.invite.members.model.impl.MemberRequestModelImpl.

Parameters:

start - the lower bound of the range of member requests

end - the upper bound of the range of member requests (not inclusive)

Returns:

the range of member requests

getMemberRequestsCount

public static int getMemberRequestsCount()

Returns the number of member requests.

Returns:

the number of member requests

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

PortalException

getReceiverMemberRequest

public static java.util.List<MemberRequest> getReceiverMemberRequest(long receiverUserId,
                                                                     int start,
                                                                     int end)

getReceiverMemberRequestCount

public static int getReceiverMemberRequestCount(long receiverUserId)

getReceiverStatusMemberRequest

public static java.util.List<MemberRequest> getReceiverStatusMemberRequest(long receiverUserId,
                                                                           int status,
                                                                           int start,
                                                                           int end)

getReceiverStatusMemberRequestCount

public static int getReceiverStatusMemberRequestCount(long receiverUserId,
                                                      int status)

hasPendingMemberRequest

public static boolean hasPendingMemberRequest(long groupId,
                                              long receiverUserId)

updateMemberRequest

public static MemberRequest updateMemberRequest(long userId,
                                                long memberRequestId,
                                                int status)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

updateMemberRequest

public static MemberRequest updateMemberRequest(MemberRequest memberRequest)

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

Important: Inspect MemberRequestLocalServiceImpl 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:

memberRequest - the member request

Returns:

the member request that was updated

updateMemberRequest

public static MemberRequest updateMemberRequest(java.lang.String key,
                                                long receiverUserId)
                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getService

public static MemberRequestLocalService getService()