Liferay 6.2-ce-ga5

com.liferay.portal.service
Class MembershipRequestLocalServiceUtil

java.lang.Object
  extended by com.liferay.portal.service.MembershipRequestLocalServiceUtil

@ProviderType
public class MembershipRequestLocalServiceUtil
extends Object

Provides the local service utility for MembershipRequest. This utility wraps com.liferay.portal.service.impl.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.

See Also:
MembershipRequestLocalService, MembershipRequestLocalServiceBaseImpl, com.liferay.portal.service.impl.MembershipRequestLocalServiceImpl

Constructor Summary
MembershipRequestLocalServiceUtil()
           
 
Method Summary
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, int statusId)
           
static void deleteMembershipRequestsByUserId(long userId)
           
static DynamicQuery dynamicQuery()
           
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static 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.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
static MembershipRequest fetchMembershipRequest(long membershipRequestId)
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
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, int statusId)
           
static int getMembershipRequestsCount()
          Returns the number of membership requests.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static MembershipRequestLocalService getService()
           
static boolean hasMembershipRequest(long userId, long groupId, int statusId)
           
static List<MembershipRequest> search(long groupId, int status, int start, int end)
           
static int searchCount(long groupId, int status)
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(MembershipRequestLocalService service)
          Deprecated. As of 6.2.0
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, int statusId, boolean addUserToGroup, ServiceContext serviceContext)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MembershipRequestLocalServiceUtil

public MembershipRequestLocalServiceUtil()
Method Detail

addMembershipRequest

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

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

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

public static DynamicQuery dynamicQuery()

dynamicQuery

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

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

dynamicQuery

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

dynamicQueryCount

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

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException
Returns the number of rows that match the dynamic query.

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

fetchMembershipRequest

public static MembershipRequest fetchMembershipRequest(long membershipRequestId)
                                                throws SystemException
Throws:
SystemException

getMembershipRequest

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

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getMembershipRequests

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

getMembershipRequestsCount

public static int getMembershipRequestsCount()
                                      throws SystemException
Returns the number of membership requests.

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

updateMembershipRequest

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

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

addMembershipRequest

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

deleteMembershipRequests

public static void deleteMembershipRequests(long groupId)
                                     throws SystemException
Throws:
SystemException

deleteMembershipRequests

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

deleteMembershipRequestsByUserId

public static void deleteMembershipRequestsByUserId(long userId)
                                             throws SystemException
Throws:
SystemException

getMembershipRequests

public static List<MembershipRequest> getMembershipRequests(long userId,
                                                            long groupId,
                                                            int statusId)
                                                     throws SystemException
Throws:
SystemException

hasMembershipRequest

public static boolean hasMembershipRequest(long userId,
                                           long groupId,
                                           int statusId)
                                    throws SystemException
Throws:
SystemException

search

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

searchCount

public static int searchCount(long groupId,
                              int status)
                       throws SystemException
Throws:
SystemException

updateStatus

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

getService

public static MembershipRequestLocalService getService()

setService

public void setService(MembershipRequestLocalService service)
Deprecated. As of 6.2.0


Liferay 6.2-ce-ga5