001    /**
002     * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.service;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.exception.PortalException;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.kernel.search.IndexableType;
022    import com.liferay.portal.kernel.transaction.Isolation;
023    import com.liferay.portal.kernel.transaction.Propagation;
024    import com.liferay.portal.kernel.transaction.Transactional;
025    
026    /**
027     * Provides the local service interface for MembershipRequest. Methods of this
028     * service will not have security checks based on the propagated JAAS
029     * credentials because this service can only be accessed from within the same
030     * VM.
031     *
032     * @author Brian Wing Shun Chan
033     * @see MembershipRequestLocalServiceUtil
034     * @see com.liferay.portal.service.base.MembershipRequestLocalServiceBaseImpl
035     * @see com.liferay.portal.service.impl.MembershipRequestLocalServiceImpl
036     * @generated
037     */
038    @ProviderType
039    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
040            PortalException.class, SystemException.class})
041    public interface MembershipRequestLocalService extends BaseLocalService,
042            PersistedModelLocalService {
043            /*
044             * NOTE FOR DEVELOPERS:
045             *
046             * Never modify or reference this interface directly. Always use {@link MembershipRequestLocalServiceUtil} to access the membership request local service. Add custom service methods to {@link com.liferay.portal.service.impl.MembershipRequestLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
047             */
048    
049            /**
050            * Adds the membership request to the database. Also notifies the appropriate model listeners.
051            *
052            * @param membershipRequest the membership request
053            * @return the membership request that was added
054            */
055            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
056            public com.liferay.portal.model.MembershipRequest addMembershipRequest(
057                    com.liferay.portal.model.MembershipRequest membershipRequest);
058    
059            public com.liferay.portal.model.MembershipRequest addMembershipRequest(
060                    long userId, long groupId, java.lang.String comments,
061                    com.liferay.portal.service.ServiceContext serviceContext)
062                    throws PortalException;
063    
064            /**
065            * Creates a new membership request with the primary key. Does not add the membership request to the database.
066            *
067            * @param membershipRequestId the primary key for the new membership request
068            * @return the new membership request
069            */
070            public com.liferay.portal.model.MembershipRequest createMembershipRequest(
071                    long membershipRequestId);
072    
073            /**
074            * Deletes the membership request from the database. Also notifies the appropriate model listeners.
075            *
076            * @param membershipRequest the membership request
077            * @return the membership request that was removed
078            */
079            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
080            public com.liferay.portal.model.MembershipRequest deleteMembershipRequest(
081                    com.liferay.portal.model.MembershipRequest membershipRequest);
082    
083            /**
084            * Deletes the membership request with the primary key from the database. Also notifies the appropriate model listeners.
085            *
086            * @param membershipRequestId the primary key of the membership request
087            * @return the membership request that was removed
088            * @throws PortalException if a membership request with the primary key could not be found
089            */
090            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
091            public com.liferay.portal.model.MembershipRequest deleteMembershipRequest(
092                    long membershipRequestId) throws PortalException;
093    
094            public void deleteMembershipRequests(long groupId);
095    
096            public void deleteMembershipRequests(long groupId, long statusId);
097    
098            public void deleteMembershipRequestsByUserId(long userId);
099    
100            /**
101            * @throws PortalException
102            */
103            @Override
104            public com.liferay.portal.model.PersistedModel deletePersistedModel(
105                    com.liferay.portal.model.PersistedModel persistedModel)
106                    throws PortalException;
107    
108            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
109    
110            /**
111            * Performs a dynamic query on the database and returns the matching rows.
112            *
113            * @param dynamicQuery the dynamic query
114            * @return the matching rows
115            */
116            public <T> java.util.List<T> dynamicQuery(
117                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
118    
119            /**
120            * Performs a dynamic query on the database and returns a range of the matching rows.
121            *
122            * <p>
123            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.MembershipRequestModelImpl}. If both <code>orderByComparator</code> 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.
124            * </p>
125            *
126            * @param dynamicQuery the dynamic query
127            * @param start the lower bound of the range of model instances
128            * @param end the upper bound of the range of model instances (not inclusive)
129            * @return the range of matching rows
130            */
131            public <T> java.util.List<T> dynamicQuery(
132                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
133                    int end);
134    
135            /**
136            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
137            *
138            * <p>
139            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.MembershipRequestModelImpl}. If both <code>orderByComparator</code> 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.
140            * </p>
141            *
142            * @param dynamicQuery the dynamic query
143            * @param start the lower bound of the range of model instances
144            * @param end the upper bound of the range of model instances (not inclusive)
145            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
146            * @return the ordered range of matching rows
147            */
148            public <T> java.util.List<T> dynamicQuery(
149                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
150                    int end,
151                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
152    
153            /**
154            * Returns the number of rows matching the dynamic query.
155            *
156            * @param dynamicQuery the dynamic query
157            * @return the number of rows matching the dynamic query
158            */
159            public long dynamicQueryCount(
160                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
161    
162            /**
163            * Returns the number of rows matching the dynamic query.
164            *
165            * @param dynamicQuery the dynamic query
166            * @param projection the projection to apply to the query
167            * @return the number of rows matching the dynamic query
168            */
169            public long dynamicQueryCount(
170                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
171                    com.liferay.portal.kernel.dao.orm.Projection projection);
172    
173            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
174            public com.liferay.portal.model.MembershipRequest fetchMembershipRequest(
175                    long membershipRequestId);
176    
177            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
178            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
179    
180            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
181            public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
182    
183            /**
184            * Returns the membership request with the primary key.
185            *
186            * @param membershipRequestId the primary key of the membership request
187            * @return the membership request
188            * @throws PortalException if a membership request with the primary key could not be found
189            */
190            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
191            public com.liferay.portal.model.MembershipRequest getMembershipRequest(
192                    long membershipRequestId) throws PortalException;
193    
194            /**
195            * Returns a range of all the membership requests.
196            *
197            * <p>
198            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.MembershipRequestModelImpl}. If both <code>orderByComparator</code> 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.
199            * </p>
200            *
201            * @param start the lower bound of the range of membership requests
202            * @param end the upper bound of the range of membership requests (not inclusive)
203            * @return the range of membership requests
204            */
205            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
206            public java.util.List<com.liferay.portal.model.MembershipRequest> getMembershipRequests(
207                    int start, int end);
208    
209            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
210            public java.util.List<com.liferay.portal.model.MembershipRequest> getMembershipRequests(
211                    long userId, long groupId, long statusId);
212    
213            /**
214            * Returns the number of membership requests.
215            *
216            * @return the number of membership requests
217            */
218            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
219            public int getMembershipRequestsCount();
220    
221            /**
222            * Returns the OSGi service identifier.
223            *
224            * @return the OSGi service identifier
225            */
226            public java.lang.String getOSGiServiceIdentifier();
227    
228            @Override
229            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
230            public com.liferay.portal.model.PersistedModel getPersistedModel(
231                    java.io.Serializable primaryKeyObj) throws PortalException;
232    
233            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
234            public boolean hasMembershipRequest(long userId, long groupId, long statusId);
235    
236            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
237            public java.util.List<com.liferay.portal.model.MembershipRequest> search(
238                    long groupId, int status, int start, int end);
239    
240            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
241            public int searchCount(long groupId, int status);
242    
243            /**
244            * Updates the membership request in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
245            *
246            * @param membershipRequest the membership request
247            * @return the membership request that was updated
248            */
249            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
250            public com.liferay.portal.model.MembershipRequest updateMembershipRequest(
251                    com.liferay.portal.model.MembershipRequest membershipRequest);
252    
253            public void updateStatus(long replierUserId, long membershipRequestId,
254                    java.lang.String replyComments, long statusId, boolean addUserToGroup,
255                    com.liferay.portal.service.ServiceContext serviceContext)
256                    throws PortalException;
257    }