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.portlet.messageboards.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    import com.liferay.portal.service.BaseLocalService;
026    import com.liferay.portal.service.PersistedModelLocalService;
027    
028    /**
029     * Provides the local service interface for MBMailingList. Methods of this
030     * service will not have security checks based on the propagated JAAS
031     * credentials because this service can only be accessed from within the same
032     * VM.
033     *
034     * @author Brian Wing Shun Chan
035     * @see MBMailingListLocalServiceUtil
036     * @see com.liferay.portlet.messageboards.service.base.MBMailingListLocalServiceBaseImpl
037     * @see com.liferay.portlet.messageboards.service.impl.MBMailingListLocalServiceImpl
038     * @generated
039     */
040    @ProviderType
041    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
042            PortalException.class, SystemException.class})
043    public interface MBMailingListLocalService extends BaseLocalService,
044            PersistedModelLocalService {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. Always use {@link MBMailingListLocalServiceUtil} to access the message boards mailing list local service. Add custom service methods to {@link com.liferay.portlet.messageboards.service.impl.MBMailingListLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
049             */
050    
051            /**
052            * Adds the message boards mailing list to the database. Also notifies the appropriate model listeners.
053            *
054            * @param mbMailingList the message boards mailing list
055            * @return the message boards mailing list that was added
056            */
057            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
058            public com.liferay.portlet.messageboards.model.MBMailingList addMBMailingList(
059                    com.liferay.portlet.messageboards.model.MBMailingList mbMailingList);
060    
061            public com.liferay.portlet.messageboards.model.MBMailingList addMailingList(
062                    long userId, long groupId, long categoryId,
063                    java.lang.String emailAddress, java.lang.String inProtocol,
064                    java.lang.String inServerName, int inServerPort, boolean inUseSSL,
065                    java.lang.String inUserName, java.lang.String inPassword,
066                    int inReadInterval, java.lang.String outEmailAddress,
067                    boolean outCustom, java.lang.String outServerName, int outServerPort,
068                    boolean outUseSSL, java.lang.String outUserName,
069                    java.lang.String outPassword, boolean allowAnonymous, boolean active,
070                    com.liferay.portal.service.ServiceContext serviceContext)
071                    throws PortalException;
072    
073            /**
074            * Creates a new message boards mailing list with the primary key. Does not add the message boards mailing list to the database.
075            *
076            * @param mailingListId the primary key for the new message boards mailing list
077            * @return the new message boards mailing list
078            */
079            public com.liferay.portlet.messageboards.model.MBMailingList createMBMailingList(
080                    long mailingListId);
081    
082            public void deleteCategoryMailingList(long groupId, long categoryId)
083                    throws PortalException;
084    
085            /**
086            * Deletes the message boards mailing list with the primary key from the database. Also notifies the appropriate model listeners.
087            *
088            * @param mailingListId the primary key of the message boards mailing list
089            * @return the message boards mailing list that was removed
090            * @throws PortalException if a message boards mailing list with the primary key could not be found
091            */
092            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
093            public com.liferay.portlet.messageboards.model.MBMailingList deleteMBMailingList(
094                    long mailingListId) throws PortalException;
095    
096            /**
097            * Deletes the message boards mailing list from the database. Also notifies the appropriate model listeners.
098            *
099            * @param mbMailingList the message boards mailing list
100            * @return the message boards mailing list that was removed
101            */
102            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
103            public com.liferay.portlet.messageboards.model.MBMailingList deleteMBMailingList(
104                    com.liferay.portlet.messageboards.model.MBMailingList mbMailingList);
105    
106            public void deleteMailingList(
107                    com.liferay.portlet.messageboards.model.MBMailingList mailingList)
108                    throws PortalException;
109    
110            public void deleteMailingList(long mailingListId) throws PortalException;
111    
112            /**
113            * @throws PortalException
114            */
115            @Override
116            public com.liferay.portal.model.PersistedModel deletePersistedModel(
117                    com.liferay.portal.model.PersistedModel persistedModel)
118                    throws PortalException;
119    
120            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
121    
122            /**
123            * Performs a dynamic query on the database and returns the matching rows.
124            *
125            * @param dynamicQuery the dynamic query
126            * @return the matching rows
127            */
128            public <T> java.util.List<T> dynamicQuery(
129                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
130    
131            /**
132            * Performs a dynamic query on the database and returns a range of the matching rows.
133            *
134            * <p>
135            * 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.portlet.messageboards.model.impl.MBMailingListModelImpl}. 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.
136            * </p>
137            *
138            * @param dynamicQuery the dynamic query
139            * @param start the lower bound of the range of model instances
140            * @param end the upper bound of the range of model instances (not inclusive)
141            * @return the range of matching rows
142            */
143            public <T> java.util.List<T> dynamicQuery(
144                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
145                    int end);
146    
147            /**
148            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
149            *
150            * <p>
151            * 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.portlet.messageboards.model.impl.MBMailingListModelImpl}. 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.
152            * </p>
153            *
154            * @param dynamicQuery the dynamic query
155            * @param start the lower bound of the range of model instances
156            * @param end the upper bound of the range of model instances (not inclusive)
157            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
158            * @return the ordered range of matching rows
159            */
160            public <T> java.util.List<T> dynamicQuery(
161                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
162                    int end,
163                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
164    
165            /**
166            * Returns the number of rows matching the dynamic query.
167            *
168            * @param dynamicQuery the dynamic query
169            * @return the number of rows matching the dynamic query
170            */
171            public long dynamicQueryCount(
172                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
173    
174            /**
175            * Returns the number of rows matching the dynamic query.
176            *
177            * @param dynamicQuery the dynamic query
178            * @param projection the projection to apply to the query
179            * @return the number of rows matching the dynamic query
180            */
181            public long dynamicQueryCount(
182                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
183                    com.liferay.portal.kernel.dao.orm.Projection projection);
184    
185            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
186            public com.liferay.portlet.messageboards.model.MBMailingList fetchCategoryMailingList(
187                    long groupId, long categoryId);
188    
189            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
190            public com.liferay.portlet.messageboards.model.MBMailingList fetchMBMailingList(
191                    long mailingListId);
192    
193            /**
194            * Returns the message boards mailing list matching the UUID and group.
195            *
196            * @param uuid the message boards mailing list's UUID
197            * @param groupId the primary key of the group
198            * @return the matching message boards mailing list, or <code>null</code> if a matching message boards mailing list could not be found
199            */
200            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
201            public com.liferay.portlet.messageboards.model.MBMailingList fetchMBMailingListByUuidAndGroupId(
202                    java.lang.String uuid, long groupId);
203    
204            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
205            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
206    
207            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
208            public com.liferay.portlet.messageboards.model.MBMailingList getCategoryMailingList(
209                    long groupId, long categoryId) throws PortalException;
210    
211            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
212            public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(
213                    com.liferay.portlet.exportimport.lar.PortletDataContext portletDataContext);
214    
215            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
216            public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
217    
218            /**
219            * Returns the message boards mailing list with the primary key.
220            *
221            * @param mailingListId the primary key of the message boards mailing list
222            * @return the message boards mailing list
223            * @throws PortalException if a message boards mailing list with the primary key could not be found
224            */
225            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
226            public com.liferay.portlet.messageboards.model.MBMailingList getMBMailingList(
227                    long mailingListId) throws PortalException;
228    
229            /**
230            * Returns the message boards mailing list matching the UUID and group.
231            *
232            * @param uuid the message boards mailing list's UUID
233            * @param groupId the primary key of the group
234            * @return the matching message boards mailing list
235            * @throws PortalException if a matching message boards mailing list could not be found
236            */
237            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
238            public com.liferay.portlet.messageboards.model.MBMailingList getMBMailingListByUuidAndGroupId(
239                    java.lang.String uuid, long groupId) throws PortalException;
240    
241            /**
242            * Returns a range of all the message boards mailing lists.
243            *
244            * <p>
245            * 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.portlet.messageboards.model.impl.MBMailingListModelImpl}. 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.
246            * </p>
247            *
248            * @param start the lower bound of the range of message boards mailing lists
249            * @param end the upper bound of the range of message boards mailing lists (not inclusive)
250            * @return the range of message boards mailing lists
251            */
252            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
253            public java.util.List<com.liferay.portlet.messageboards.model.MBMailingList> getMBMailingLists(
254                    int start, int end);
255    
256            /**
257            * Returns all the message boards mailing lists matching the UUID and company.
258            *
259            * @param uuid the UUID of the message boards mailing lists
260            * @param companyId the primary key of the company
261            * @return the matching message boards mailing lists, or an empty list if no matches were found
262            */
263            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
264            public java.util.List<com.liferay.portlet.messageboards.model.MBMailingList> getMBMailingListsByUuidAndCompanyId(
265                    java.lang.String uuid, long companyId);
266    
267            /**
268            * Returns a range of message boards mailing lists matching the UUID and company.
269            *
270            * @param uuid the UUID of the message boards mailing lists
271            * @param companyId the primary key of the company
272            * @param start the lower bound of the range of message boards mailing lists
273            * @param end the upper bound of the range of message boards mailing lists (not inclusive)
274            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
275            * @return the range of matching message boards mailing lists, or an empty list if no matches were found
276            */
277            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
278            public java.util.List<com.liferay.portlet.messageboards.model.MBMailingList> getMBMailingListsByUuidAndCompanyId(
279                    java.lang.String uuid, long companyId, int start, int end,
280                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.messageboards.model.MBMailingList> orderByComparator);
281    
282            /**
283            * Returns the number of message boards mailing lists.
284            *
285            * @return the number of message boards mailing lists
286            */
287            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
288            public int getMBMailingListsCount();
289    
290            /**
291            * Returns the OSGi service identifier.
292            *
293            * @return the OSGi service identifier
294            */
295            public java.lang.String getOSGiServiceIdentifier();
296    
297            @Override
298            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
299            public com.liferay.portal.model.PersistedModel getPersistedModel(
300                    java.io.Serializable primaryKeyObj) throws PortalException;
301    
302            /**
303            * Updates the message boards mailing list in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
304            *
305            * @param mbMailingList the message boards mailing list
306            * @return the message boards mailing list that was updated
307            */
308            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
309            public com.liferay.portlet.messageboards.model.MBMailingList updateMBMailingList(
310                    com.liferay.portlet.messageboards.model.MBMailingList mbMailingList);
311    
312            public com.liferay.portlet.messageboards.model.MBMailingList updateMailingList(
313                    long mailingListId, java.lang.String emailAddress,
314                    java.lang.String inProtocol, java.lang.String inServerName,
315                    int inServerPort, boolean inUseSSL, java.lang.String inUserName,
316                    java.lang.String inPassword, int inReadInterval,
317                    java.lang.String outEmailAddress, boolean outCustom,
318                    java.lang.String outServerName, int outServerPort, boolean outUseSSL,
319                    java.lang.String outUserName, java.lang.String outPassword,
320                    boolean allowAnonymous, boolean active,
321                    com.liferay.portal.service.ServiceContext serviceContext)
322                    throws PortalException;
323    }