com.liferay.invitation.invite.members.service

Interface MemberRequestLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

MemberRequestLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface MemberRequestLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for MemberRequest. 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:

MemberRequestLocalServiceUtil

Method Summary

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

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addMemberRequest

MemberRequest addMemberRequest(long userId,
                               long groupId,
                               long receiverUserId,
                               java.lang.String receiverEmailAddress,
                               long invitedRoleId,
                               long invitedTeamId,
                               ServiceContext serviceContext)
                        throws PortalException

Throws:

PortalException

addMemberRequest

@Indexable(type=REINDEX)
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

void addMemberRequests(long userId,
                       long groupId,
                       long[] receiverUserIds,
                       long invitedRoleId,
                       long invitedTeamId,
                       ServiceContext serviceContext)
                throws PortalException

Throws:

PortalException

addMemberRequests

void addMemberRequests(long userId,
                       long groupId,
                       java.lang.String[] emailAddresses,
                       long invitedRoleId,
                       long invitedTeamId,
                       ServiceContext serviceContext)
                throws PortalException

Throws:

PortalException

createMemberRequest

@Transactional(enabled=false)
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

PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                             throws PortalException

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteMemberRequest

@Indexable(type=DELETE)
MemberRequest deleteMemberRequest(long memberRequestId)
                                                   throws 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

@Indexable(type=DELETE)
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

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.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> java.util.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 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.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 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

@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 query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchMemberRequest

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MemberRequest fetchMemberRequest(long memberRequestId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getMemberRequest

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MemberRequest getMemberRequest(long memberRequestId)
                                                                                           throws 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MemberRequest getMemberRequest(long groupId,
                                                                                                  long receiverUserId,
                                                                                                  int status)
                                                                                           throws PortalException

Throws:

PortalException

getMemberRequests

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getMemberRequestsCount()

Returns the number of member requests.

Returns:

the number of member requests

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getReceiverMemberRequest

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<MemberRequest> getReceiverMemberRequest(long receiverUserId,
                                                                                                                          int start,
                                                                                                                          int end)

getReceiverMemberRequestCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getReceiverMemberRequestCount(long receiverUserId)

getReceiverStatusMemberRequest

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<MemberRequest> getReceiverStatusMemberRequest(long receiverUserId,
                                                                                                                                int status,
                                                                                                                                int start,
                                                                                                                                int end)

getReceiverStatusMemberRequestCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getReceiverStatusMemberRequestCount(long receiverUserId,
                                                                                                           int status)

hasPendingMemberRequest

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasPendingMemberRequest(long groupId,
                                                                                                   long receiverUserId)

updateMemberRequest

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

Throws:

java.lang.Exception

updateMemberRequest

@Indexable(type=REINDEX)
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

MemberRequest updateMemberRequest(java.lang.String key,
                                  long receiverUserId)
                           throws PortalException

Throws:

PortalException