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.kernel.service;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
020    import com.liferay.portal.kernel.dao.orm.DynamicQuery;
021    import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
022    import com.liferay.portal.kernel.dao.orm.Projection;
023    import com.liferay.portal.kernel.exception.PortalException;
024    import com.liferay.portal.kernel.exception.SystemException;
025    import com.liferay.portal.kernel.model.MembershipRequest;
026    import com.liferay.portal.kernel.model.PersistedModel;
027    import com.liferay.portal.kernel.search.Indexable;
028    import com.liferay.portal.kernel.search.IndexableType;
029    import com.liferay.portal.kernel.transaction.Isolation;
030    import com.liferay.portal.kernel.transaction.Propagation;
031    import com.liferay.portal.kernel.transaction.Transactional;
032    import com.liferay.portal.kernel.util.OrderByComparator;
033    
034    import java.io.Serializable;
035    
036    import java.util.List;
037    
038    /**
039     * Provides the local service interface for MembershipRequest. Methods of this
040     * service will not have security checks based on the propagated JAAS
041     * credentials because this service can only be accessed from within the same
042     * VM.
043     *
044     * @author Brian Wing Shun Chan
045     * @see MembershipRequestLocalServiceUtil
046     * @see com.liferay.portal.service.base.MembershipRequestLocalServiceBaseImpl
047     * @see com.liferay.portal.service.impl.MembershipRequestLocalServiceImpl
048     * @generated
049     */
050    @ProviderType
051    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
052            PortalException.class, SystemException.class})
053    public interface MembershipRequestLocalService extends BaseLocalService,
054            PersistedModelLocalService {
055            /*
056             * NOTE FOR DEVELOPERS:
057             *
058             * 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.
059             */
060    
061            /**
062            * Adds the membership request to the database. Also notifies the appropriate model listeners.
063            *
064            * @param membershipRequest the membership request
065            * @return the membership request that was added
066            */
067            @Indexable(type = IndexableType.REINDEX)
068            public MembershipRequest addMembershipRequest(
069                    MembershipRequest membershipRequest);
070    
071            public MembershipRequest addMembershipRequest(long userId, long groupId,
072                    java.lang.String comments,
073                    com.liferay.portal.kernel.service.ServiceContext serviceContext)
074                    throws PortalException;
075    
076            /**
077            * Creates a new membership request with the primary key. Does not add the membership request to the database.
078            *
079            * @param membershipRequestId the primary key for the new membership request
080            * @return the new membership request
081            */
082            public MembershipRequest createMembershipRequest(long membershipRequestId);
083    
084            /**
085            * Deletes the membership request from the database. Also notifies the appropriate model listeners.
086            *
087            * @param membershipRequest the membership request
088            * @return the membership request that was removed
089            */
090            @Indexable(type = IndexableType.DELETE)
091            public MembershipRequest deleteMembershipRequest(
092                    MembershipRequest membershipRequest);
093    
094            /**
095            * Deletes the membership request with the primary key from the database. Also notifies the appropriate model listeners.
096            *
097            * @param membershipRequestId the primary key of the membership request
098            * @return the membership request that was removed
099            * @throws PortalException if a membership request with the primary key could not be found
100            */
101            @Indexable(type = IndexableType.DELETE)
102            public MembershipRequest deleteMembershipRequest(long membershipRequestId)
103                    throws PortalException;
104    
105            public void deleteMembershipRequests(long groupId);
106    
107            public void deleteMembershipRequests(long groupId, long statusId);
108    
109            public void deleteMembershipRequestsByUserId(long userId);
110    
111            /**
112            * @throws PortalException
113            */
114            @Override
115            public PersistedModel deletePersistedModel(PersistedModel persistedModel)
116                    throws PortalException;
117    
118            public DynamicQuery dynamicQuery();
119    
120            /**
121            * Performs a dynamic query on the database and returns the matching rows.
122            *
123            * @param dynamicQuery the dynamic query
124            * @return the matching rows
125            */
126            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery);
127    
128            /**
129            * Performs a dynamic query on the database and returns a range of the matching rows.
130            *
131            * <p>
132            * 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.
133            * </p>
134            *
135            * @param dynamicQuery the dynamic query
136            * @param start the lower bound of the range of model instances
137            * @param end the upper bound of the range of model instances (not inclusive)
138            * @return the range of matching rows
139            */
140            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
141                    int end);
142    
143            /**
144            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
145            *
146            * <p>
147            * 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.
148            * </p>
149            *
150            * @param dynamicQuery the dynamic query
151            * @param start the lower bound of the range of model instances
152            * @param end the upper bound of the range of model instances (not inclusive)
153            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
154            * @return the ordered range of matching rows
155            */
156            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
157                    int end, OrderByComparator<T> orderByComparator);
158    
159            /**
160            * Returns the number of rows matching the dynamic query.
161            *
162            * @param dynamicQuery the dynamic query
163            * @return the number of rows matching the dynamic query
164            */
165            public long dynamicQueryCount(DynamicQuery dynamicQuery);
166    
167            /**
168            * Returns the number of rows matching the dynamic query.
169            *
170            * @param dynamicQuery the dynamic query
171            * @param projection the projection to apply to the query
172            * @return the number of rows matching the dynamic query
173            */
174            public long dynamicQueryCount(DynamicQuery dynamicQuery,
175                    Projection projection);
176    
177            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
178            public MembershipRequest fetchMembershipRequest(long membershipRequestId);
179    
180            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
181            public ActionableDynamicQuery getActionableDynamicQuery();
182    
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
185    
186            /**
187            * Returns the membership request with the primary key.
188            *
189            * @param membershipRequestId the primary key of the membership request
190            * @return the membership request
191            * @throws PortalException if a membership request with the primary key could not be found
192            */
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public MembershipRequest getMembershipRequest(long membershipRequestId)
195                    throws PortalException;
196    
197            /**
198            * Returns a range of all the membership requests.
199            *
200            * <p>
201            * 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.
202            * </p>
203            *
204            * @param start the lower bound of the range of membership requests
205            * @param end the upper bound of the range of membership requests (not inclusive)
206            * @return the range of membership requests
207            */
208            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
209            public List<MembershipRequest> getMembershipRequests(int start, int end);
210    
211            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
212            public List<MembershipRequest> getMembershipRequests(long userId,
213                    long groupId, long statusId);
214    
215            /**
216            * Returns the number of membership requests.
217            *
218            * @return the number of membership requests
219            */
220            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
221            public int getMembershipRequestsCount();
222    
223            /**
224            * Returns the OSGi service identifier.
225            *
226            * @return the OSGi service identifier
227            */
228            public java.lang.String getOSGiServiceIdentifier();
229    
230            @Override
231            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
232            public PersistedModel getPersistedModel(Serializable primaryKeyObj)
233                    throws PortalException;
234    
235            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
236            public boolean hasMembershipRequest(long userId, long groupId, long statusId);
237    
238            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
239            public List<MembershipRequest> search(long groupId, int status, int start,
240                    int end);
241    
242            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
243            public int searchCount(long groupId, int status);
244    
245            /**
246            * Updates the membership request in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
247            *
248            * @param membershipRequest the membership request
249            * @return the membership request that was updated
250            */
251            @Indexable(type = IndexableType.REINDEX)
252            public MembershipRequest updateMembershipRequest(
253                    MembershipRequest membershipRequest);
254    
255            public void updateStatus(long replierUserId, long membershipRequestId,
256                    java.lang.String replyComments, long statusId, boolean addUserToGroup,
257                    com.liferay.portal.kernel.service.ServiceContext serviceContext)
258                    throws PortalException;
259    }