com.liferay.portal.kernel.service

Interface MembershipRequestLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

MembershipRequestLocalServiceWrapper

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

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

MembershipRequestLocalServiceUtil, MembershipRequestLocalServiceBaseImpl, MembershipRequestLocalServiceImpl

{$generated.description}

Method Summary

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

Method Detail

addMembershipRequest

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

Throws:

PortalException

addMembershipRequest

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

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

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

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

void deleteMembershipRequests(long groupId)

deleteMembershipRequests

void deleteMembershipRequests(long groupId,
                              long statusId)

deleteMembershipRequestsByUserId

void deleteMembershipRequestsByUserId(long userId)

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dynamicQuery

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

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

@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

fetchMembershipRequest

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MembershipRequest fetchMembershipRequest(long membershipRequestId)

getActionableDynamicQuery

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

getIndexableActionableDynamicQuery

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

getMembershipRequest

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MembershipRequest> getMembershipRequests(long userId,
                                                                                                                 long groupId,
                                                                                                                 long statusId)

getMembershipRequestsCount

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

Returns the number of membership requests.

Returns:

the number of membership requests

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 interface PersistedModelLocalService

Throws:

PortalException

hasMembershipRequest

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasMembershipRequest(long userId,
                                                                                                long groupId,
                                                                                                long statusId)

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MembershipRequest> search(long groupId,
                                                                                                  int status,
                                                                                                  int start,
                                                                                                  int end)

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MembershipRequest> search(long groupId,
                                                                                                  int status,
                                                                                                  int start,
                                                                                                  int end,
                                                                                                  OrderByComparator<MembershipRequest> obc)

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long groupId,
                                                                                   int status)

updateMembershipRequest

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

void updateStatus(long replierUserId,
                  long membershipRequestId,
                  String replyComments,
                  long statusId,
                  boolean addUserToGroup,
                  ServiceContext serviceContext)
           throws PortalException

Throws:

PortalException