Liferay 6.1.2-ce-ga3

com.liferay.portal.service
Interface MembershipRequestLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
MembershipRequestLocalServiceBaseImpl, MembershipRequestLocalServiceImpl, MembershipRequestLocalServiceWrapper

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

The interface for the membership request local service.

This is a local service. 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:
MembershipRequestLocalServiceUtil, MembershipRequestLocalServiceBaseImpl, MembershipRequestLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 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, int statusId)
           
 void deleteMembershipRequestsByUserId(long userId)
           
 DynamicQuery dynamicQuery()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
 MembershipRequest fetchMembershipRequest(long membershipRequestId)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 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, int statusId)
           
 int getMembershipRequestsCount()
          Returns the number of membership requests.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 boolean hasMembershipRequest(long userId, long groupId, int statusId)
           
 List<MembershipRequest> search(long groupId, int status, int start, int end)
           
 int searchCount(long groupId, int status)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 MembershipRequest updateMembershipRequest(MembershipRequest membershipRequest)
          Updates the membership request in the database or adds it if it does not yet exist.
 MembershipRequest updateMembershipRequest(MembershipRequest membershipRequest, boolean merge)
          Updates the membership request in the database or adds it if it does not yet exist.
 void updateStatus(long replierUserId, long membershipRequestId, String replyComments, int statusId, boolean addUserToGroup, ServiceContext serviceContext)
           
 

Method Detail

addMembershipRequest

MembershipRequest addMembershipRequest(MembershipRequest membershipRequest)
                                       throws SystemException
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
Throws:
SystemException - if a system exception occurred

createMembershipRequest

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

MembershipRequest deleteMembershipRequest(long membershipRequestId)
                                          throws PortalException,
                                                 SystemException
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
SystemException - if a system exception occurred

deleteMembershipRequest

MembershipRequest deleteMembershipRequest(MembershipRequest membershipRequest)
                                          throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
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.

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
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
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.

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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchMembershipRequest

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MembershipRequest fetchMembershipRequest(long membershipRequestId)
                                         throws SystemException
Throws:
SystemException

getMembershipRequest

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MembershipRequest getMembershipRequest(long membershipRequestId)
                                       throws PortalException,
                                              SystemException
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
SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getMembershipRequests

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MembershipRequest> getMembershipRequests(int start,
                                                                                       int end)
                                              throws SystemException
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.

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
Throws:
SystemException - if a system exception occurred

getMembershipRequestsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getMembershipRequestsCount()
                               throws SystemException
Returns the number of membership requests.

Returns:
the number of membership requests
Throws:
SystemException - if a system exception occurred

updateMembershipRequest

MembershipRequest updateMembershipRequest(MembershipRequest membershipRequest)
                                          throws SystemException
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
Throws:
SystemException - if a system exception occurred

updateMembershipRequest

MembershipRequest updateMembershipRequest(MembershipRequest membershipRequest,
                                          boolean merge)
                                          throws SystemException
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
merge - whether to merge the membership request with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the membership request that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addMembershipRequest

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

deleteMembershipRequests

void deleteMembershipRequests(long groupId)
                              throws SystemException
Throws:
SystemException

deleteMembershipRequests

void deleteMembershipRequests(long groupId,
                              int statusId)
                              throws SystemException
Throws:
SystemException

deleteMembershipRequestsByUserId

void deleteMembershipRequestsByUserId(long userId)
                                      throws SystemException
Throws:
SystemException

getMembershipRequests

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MembershipRequest> getMembershipRequests(long userId,
                                                                                       long groupId,
                                                                                       int statusId)
                                              throws SystemException
Throws:
SystemException

hasMembershipRequest

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasMembershipRequest(long userId,
                                                                      long groupId,
                                                                      int statusId)
                             throws SystemException
Throws:
SystemException

search

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

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long groupId,
                                                         int status)
                throws SystemException
Throws:
SystemException

updateStatus

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

Liferay 6.1.2-ce-ga3