001    /**
002     * Copyright (c) 2000-2010 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 com.liferay.portal.kernel.annotation.Isolation;
018    import com.liferay.portal.kernel.annotation.Propagation;
019    import com.liferay.portal.kernel.annotation.Transactional;
020    import com.liferay.portal.kernel.exception.PortalException;
021    import com.liferay.portal.kernel.exception.SystemException;
022    
023    /**
024     * The interface for the message boards mailing list local service.
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * <p>
031     * 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.
032     * </p>
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    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface MBMailingListLocalService {
043            /**
044            * Adds the message boards mailing list to the database. Also notifies the appropriate model listeners.
045            *
046            * @param mbMailingList the message boards mailing list to add
047            * @return the message boards mailing list that was added
048            * @throws SystemException if a system exception occurred
049            */
050            public com.liferay.portlet.messageboards.model.MBMailingList addMBMailingList(
051                    com.liferay.portlet.messageboards.model.MBMailingList mbMailingList)
052                    throws com.liferay.portal.kernel.exception.SystemException;
053    
054            /**
055            * Creates a new message boards mailing list with the primary key. Does not add the message boards mailing list to the database.
056            *
057            * @param mailingListId the primary key for the new message boards mailing list
058            * @return the new message boards mailing list
059            */
060            public com.liferay.portlet.messageboards.model.MBMailingList createMBMailingList(
061                    long mailingListId);
062    
063            /**
064            * Deletes the message boards mailing list with the primary key from the database. Also notifies the appropriate model listeners.
065            *
066            * @param mailingListId the primary key of the message boards mailing list to delete
067            * @throws PortalException if a message boards mailing list with the primary key could not be found
068            * @throws SystemException if a system exception occurred
069            */
070            public void deleteMBMailingList(long mailingListId)
071                    throws com.liferay.portal.kernel.exception.PortalException,
072                            com.liferay.portal.kernel.exception.SystemException;
073    
074            /**
075            * Deletes the message boards mailing list from the database. Also notifies the appropriate model listeners.
076            *
077            * @param mbMailingList the message boards mailing list to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public void deleteMBMailingList(
081                    com.liferay.portlet.messageboards.model.MBMailingList mbMailingList)
082                    throws com.liferay.portal.kernel.exception.SystemException;
083    
084            /**
085            * Performs a dynamic query on the database and returns the matching rows.
086            *
087            * @param dynamicQuery the dynamic query to search with
088            * @return the matching rows
089            * @throws SystemException if a system exception occurred
090            */
091            @SuppressWarnings("rawtypes")
092            public java.util.List dynamicQuery(
093                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
094                    throws com.liferay.portal.kernel.exception.SystemException;
095    
096            /**
097            * Performs a dynamic query on the database and returns a range of the matching rows.
098            *
099            * <p>
100            * 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.
101            * </p>
102            *
103            * @param dynamicQuery the dynamic query to search with
104            * @param start the lower bound of the range of model instances to return
105            * @param end the upper bound of the range of model instances to return (not inclusive)
106            * @return the range of matching rows
107            * @throws SystemException if a system exception occurred
108            */
109            @SuppressWarnings("rawtypes")
110            public java.util.List dynamicQuery(
111                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
112                    int end) throws com.liferay.portal.kernel.exception.SystemException;
113    
114            /**
115            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
116            *
117            * <p>
118            * 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query to search with
122            * @param start the lower bound of the range of model instances to return
123            * @param end the upper bound of the range of model instances to return (not inclusive)
124            * @param orderByComparator the comparator to order the results by
125            * @return the ordered range of matching rows
126            * @throws SystemException if a system exception occurred
127            */
128            @SuppressWarnings("rawtypes")
129            public java.util.List dynamicQuery(
130                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
131                    int end,
132                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
133                    throws com.liferay.portal.kernel.exception.SystemException;
134    
135            /**
136            * Counts the number of rows that match the dynamic query.
137            *
138            * @param dynamicQuery the dynamic query to search with
139            * @return the number of rows that match the dynamic query
140            * @throws SystemException if a system exception occurred
141            */
142            public long dynamicQueryCount(
143                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
144                    throws com.liferay.portal.kernel.exception.SystemException;
145    
146            /**
147            * Gets the message boards mailing list with the primary key.
148            *
149            * @param mailingListId the primary key of the message boards mailing list to get
150            * @return the message boards mailing list
151            * @throws PortalException if a message boards mailing list with the primary key could not be found
152            * @throws SystemException if a system exception occurred
153            */
154            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155            public com.liferay.portlet.messageboards.model.MBMailingList getMBMailingList(
156                    long mailingListId)
157                    throws com.liferay.portal.kernel.exception.PortalException,
158                            com.liferay.portal.kernel.exception.SystemException;
159    
160            /**
161            * Gets the message boards mailing list with the UUID and group id.
162            *
163            * @param uuid the UUID of message boards mailing list to get
164            * @param groupId the group id of the message boards mailing list to get
165            * @return the message boards mailing list
166            * @throws PortalException if a message boards mailing list with the UUID and group id could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public com.liferay.portlet.messageboards.model.MBMailingList getMBMailingListByUuidAndGroupId(
171                    java.lang.String uuid, long groupId)
172                    throws com.liferay.portal.kernel.exception.PortalException,
173                            com.liferay.portal.kernel.exception.SystemException;
174    
175            /**
176            * Gets a range of all the message boards mailing lists.
177            *
178            * <p>
179            * 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.
180            * </p>
181            *
182            * @param start the lower bound of the range of message boards mailing lists to return
183            * @param end the upper bound of the range of message boards mailing lists to return (not inclusive)
184            * @return the range of message boards mailing lists
185            * @throws SystemException if a system exception occurred
186            */
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public java.util.List<com.liferay.portlet.messageboards.model.MBMailingList> getMBMailingLists(
189                    int start, int end)
190                    throws com.liferay.portal.kernel.exception.SystemException;
191    
192            /**
193            * Gets the number of message boards mailing lists.
194            *
195            * @return the number of message boards mailing lists
196            * @throws SystemException if a system exception occurred
197            */
198            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
199            public int getMBMailingListsCount()
200                    throws com.liferay.portal.kernel.exception.SystemException;
201    
202            /**
203            * Updates the message boards mailing list in the database. Also notifies the appropriate model listeners.
204            *
205            * @param mbMailingList the message boards mailing list to update
206            * @return the message boards mailing list that was updated
207            * @throws SystemException if a system exception occurred
208            */
209            public com.liferay.portlet.messageboards.model.MBMailingList updateMBMailingList(
210                    com.liferay.portlet.messageboards.model.MBMailingList mbMailingList)
211                    throws com.liferay.portal.kernel.exception.SystemException;
212    
213            /**
214            * Updates the message boards mailing list in the database. Also notifies the appropriate model listeners.
215            *
216            * @param mbMailingList the message boards mailing list to update
217            * @param merge whether to merge the message boards mailing list with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
218            * @return the message boards mailing list that was updated
219            * @throws SystemException if a system exception occurred
220            */
221            public com.liferay.portlet.messageboards.model.MBMailingList updateMBMailingList(
222                    com.liferay.portlet.messageboards.model.MBMailingList mbMailingList,
223                    boolean merge)
224                    throws com.liferay.portal.kernel.exception.SystemException;
225    
226            public com.liferay.portlet.messageboards.model.MBMailingList addMailingList(
227                    long userId, long groupId, long categoryId,
228                    java.lang.String emailAddress, java.lang.String inProtocol,
229                    java.lang.String inServerName, int inServerPort, boolean inUseSSL,
230                    java.lang.String inUserName, java.lang.String inPassword,
231                    int inReadInterval, java.lang.String outEmailAddress,
232                    boolean outCustom, java.lang.String outServerName, int outServerPort,
233                    boolean outUseSSL, java.lang.String outUserName,
234                    java.lang.String outPassword, boolean active,
235                    com.liferay.portal.service.ServiceContext serviceContext)
236                    throws com.liferay.portal.kernel.exception.PortalException,
237                            com.liferay.portal.kernel.exception.SystemException;
238    
239            public void deleteCategoryMailingList(long groupId, long categoryId)
240                    throws com.liferay.portal.kernel.exception.PortalException,
241                            com.liferay.portal.kernel.exception.SystemException;
242    
243            public void deleteMailingList(long mailingListId)
244                    throws com.liferay.portal.kernel.exception.PortalException,
245                            com.liferay.portal.kernel.exception.SystemException;
246    
247            public void deleteMailingList(
248                    com.liferay.portlet.messageboards.model.MBMailingList mailingList)
249                    throws com.liferay.portal.kernel.exception.PortalException,
250                            com.liferay.portal.kernel.exception.SystemException;
251    
252            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
253            public com.liferay.portlet.messageboards.model.MBMailingList getCategoryMailingList(
254                    long groupId, long categoryId)
255                    throws com.liferay.portal.kernel.exception.PortalException,
256                            com.liferay.portal.kernel.exception.SystemException;
257    
258            public com.liferay.portlet.messageboards.model.MBMailingList updateMailingList(
259                    long mailingListId, java.lang.String emailAddress,
260                    java.lang.String inProtocol, java.lang.String inServerName,
261                    int inServerPort, boolean inUseSSL, java.lang.String inUserName,
262                    java.lang.String inPassword, int inReadInterval,
263                    java.lang.String outEmailAddress, boolean outCustom,
264                    java.lang.String outServerName, int outServerPort, boolean outUseSSL,
265                    java.lang.String outUserName, java.lang.String outPassword,
266                    boolean active, com.liferay.portal.service.ServiceContext serviceContext)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException;
269    }