001 /** 002 * Copyright (c) 2000-2013 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.exception.PortalException; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.kernel.transaction.Isolation; 020 import com.liferay.portal.kernel.transaction.Propagation; 021 import com.liferay.portal.kernel.transaction.Transactional; 022 import com.liferay.portal.service.BaseLocalService; 023 import com.liferay.portal.service.PersistedModelLocalService; 024 025 /** 026 * The interface for the message boards mailing list local service. 027 * 028 * <p> 029 * 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. 030 * </p> 031 * 032 * @author Brian Wing Shun Chan 033 * @see MBMailingListLocalServiceUtil 034 * @see com.liferay.portlet.messageboards.service.base.MBMailingListLocalServiceBaseImpl 035 * @see com.liferay.portlet.messageboards.service.impl.MBMailingListLocalServiceImpl 036 * @generated 037 */ 038 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 039 PortalException.class, SystemException.class}) 040 public interface MBMailingListLocalService extends BaseLocalService, 041 PersistedModelLocalService { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * 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. 046 */ 047 048 /** 049 * Adds the message boards mailing list to the database. Also notifies the appropriate model listeners. 050 * 051 * @param mbMailingList the message boards mailing list 052 * @return the message boards mailing list that was added 053 * @throws SystemException if a system exception occurred 054 */ 055 public com.liferay.portlet.messageboards.model.MBMailingList addMBMailingList( 056 com.liferay.portlet.messageboards.model.MBMailingList mbMailingList) 057 throws com.liferay.portal.kernel.exception.SystemException; 058 059 /** 060 * Creates a new message boards mailing list with the primary key. Does not add the message boards mailing list to the database. 061 * 062 * @param mailingListId the primary key for the new message boards mailing list 063 * @return the new message boards mailing list 064 */ 065 public com.liferay.portlet.messageboards.model.MBMailingList createMBMailingList( 066 long mailingListId); 067 068 /** 069 * Deletes the message boards mailing list with the primary key from the database. Also notifies the appropriate model listeners. 070 * 071 * @param mailingListId the primary key of the message boards mailing list 072 * @return the message boards mailing list that was removed 073 * @throws PortalException if a message boards mailing list with the primary key could not be found 074 * @throws SystemException if a system exception occurred 075 */ 076 public com.liferay.portlet.messageboards.model.MBMailingList deleteMBMailingList( 077 long mailingListId) 078 throws com.liferay.portal.kernel.exception.PortalException, 079 com.liferay.portal.kernel.exception.SystemException; 080 081 /** 082 * Deletes the message boards mailing list from the database. Also notifies the appropriate model listeners. 083 * 084 * @param mbMailingList the message boards mailing list 085 * @return the message boards mailing list that was removed 086 * @throws SystemException if a system exception occurred 087 */ 088 public com.liferay.portlet.messageboards.model.MBMailingList deleteMBMailingList( 089 com.liferay.portlet.messageboards.model.MBMailingList mbMailingList) 090 throws com.liferay.portal.kernel.exception.SystemException; 091 092 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 093 094 /** 095 * Performs a dynamic query on the database and returns the matching rows. 096 * 097 * @param dynamicQuery the dynamic query 098 * @return the matching rows 099 * @throws SystemException if a system exception occurred 100 */ 101 @SuppressWarnings("rawtypes") 102 public java.util.List dynamicQuery( 103 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 104 throws com.liferay.portal.kernel.exception.SystemException; 105 106 /** 107 * Performs a dynamic query on the database and returns a range of the matching rows. 108 * 109 * <p> 110 * 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. 111 * </p> 112 * 113 * @param dynamicQuery the dynamic query 114 * @param start the lower bound of the range of model instances 115 * @param end the upper bound of the range of model instances (not inclusive) 116 * @return the range of matching rows 117 * @throws SystemException if a system exception occurred 118 */ 119 @SuppressWarnings("rawtypes") 120 public java.util.List dynamicQuery( 121 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 122 int end) throws com.liferay.portal.kernel.exception.SystemException; 123 124 /** 125 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 126 * 127 * <p> 128 * 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. 129 * </p> 130 * 131 * @param dynamicQuery the dynamic query 132 * @param start the lower bound of the range of model instances 133 * @param end the upper bound of the range of model instances (not inclusive) 134 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 135 * @return the ordered range of matching rows 136 * @throws SystemException if a system exception occurred 137 */ 138 @SuppressWarnings("rawtypes") 139 public java.util.List dynamicQuery( 140 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 141 int end, 142 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 143 throws com.liferay.portal.kernel.exception.SystemException; 144 145 /** 146 * Returns the number of rows that match the dynamic query. 147 * 148 * @param dynamicQuery the dynamic query 149 * @return the number of rows that match the dynamic query 150 * @throws SystemException if a system exception occurred 151 */ 152 public long dynamicQueryCount( 153 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 154 throws com.liferay.portal.kernel.exception.SystemException; 155 156 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 157 public com.liferay.portlet.messageboards.model.MBMailingList fetchMBMailingList( 158 long mailingListId) 159 throws com.liferay.portal.kernel.exception.SystemException; 160 161 /** 162 * Returns the message boards mailing list with the primary key. 163 * 164 * @param mailingListId the primary key of the message boards mailing list 165 * @return the message boards mailing list 166 * @throws PortalException if a message boards mailing list with the primary key 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 getMBMailingList( 171 long mailingListId) 172 throws com.liferay.portal.kernel.exception.PortalException, 173 com.liferay.portal.kernel.exception.SystemException; 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public com.liferay.portal.model.PersistedModel getPersistedModel( 177 java.io.Serializable primaryKeyObj) 178 throws com.liferay.portal.kernel.exception.PortalException, 179 com.liferay.portal.kernel.exception.SystemException; 180 181 /** 182 * Returns the message boards mailing list matching the UUID and group. 183 * 184 * @param uuid the message boards mailing list's UUID 185 * @param groupId the primary key of the group 186 * @return the matching message boards mailing list 187 * @throws PortalException if a matching message boards mailing list could not be found 188 * @throws SystemException if a system exception occurred 189 */ 190 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 191 public com.liferay.portlet.messageboards.model.MBMailingList getMBMailingListByUuidAndGroupId( 192 java.lang.String uuid, long groupId) 193 throws com.liferay.portal.kernel.exception.PortalException, 194 com.liferay.portal.kernel.exception.SystemException; 195 196 /** 197 * Returns a range of all the message boards mailing lists. 198 * 199 * <p> 200 * 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. 201 * </p> 202 * 203 * @param start the lower bound of the range of message boards mailing lists 204 * @param end the upper bound of the range of message boards mailing lists (not inclusive) 205 * @return the range of message boards mailing lists 206 * @throws SystemException if a system exception occurred 207 */ 208 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 209 public java.util.List<com.liferay.portlet.messageboards.model.MBMailingList> getMBMailingLists( 210 int start, int end) 211 throws com.liferay.portal.kernel.exception.SystemException; 212 213 /** 214 * Returns the number of message boards mailing lists. 215 * 216 * @return the number of message boards mailing lists 217 * @throws SystemException if a system exception occurred 218 */ 219 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 220 public int getMBMailingListsCount() 221 throws com.liferay.portal.kernel.exception.SystemException; 222 223 /** 224 * Updates the message boards mailing list in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 225 * 226 * @param mbMailingList the message boards mailing list 227 * @return the message boards mailing list that was updated 228 * @throws SystemException if a system exception occurred 229 */ 230 public com.liferay.portlet.messageboards.model.MBMailingList updateMBMailingList( 231 com.liferay.portlet.messageboards.model.MBMailingList mbMailingList) 232 throws com.liferay.portal.kernel.exception.SystemException; 233 234 /** 235 * Returns the Spring bean ID for this bean. 236 * 237 * @return the Spring bean ID for this bean 238 */ 239 public java.lang.String getBeanIdentifier(); 240 241 /** 242 * Sets the Spring bean ID for this bean. 243 * 244 * @param beanIdentifier the Spring bean ID for this bean 245 */ 246 public void setBeanIdentifier(java.lang.String beanIdentifier); 247 248 public com.liferay.portlet.messageboards.model.MBMailingList addMailingList( 249 long userId, long groupId, long categoryId, 250 java.lang.String emailAddress, java.lang.String inProtocol, 251 java.lang.String inServerName, int inServerPort, boolean inUseSSL, 252 java.lang.String inUserName, java.lang.String inPassword, 253 int inReadInterval, java.lang.String outEmailAddress, 254 boolean outCustom, java.lang.String outServerName, int outServerPort, 255 boolean outUseSSL, java.lang.String outUserName, 256 java.lang.String outPassword, boolean allowAnonymous, boolean active, 257 com.liferay.portal.service.ServiceContext serviceContext) 258 throws com.liferay.portal.kernel.exception.PortalException, 259 com.liferay.portal.kernel.exception.SystemException; 260 261 public void deleteCategoryMailingList(long groupId, long categoryId) 262 throws com.liferay.portal.kernel.exception.PortalException, 263 com.liferay.portal.kernel.exception.SystemException; 264 265 public void deleteMailingList(long mailingListId) 266 throws com.liferay.portal.kernel.exception.PortalException, 267 com.liferay.portal.kernel.exception.SystemException; 268 269 public void deleteMailingList( 270 com.liferay.portlet.messageboards.model.MBMailingList mailingList) 271 throws com.liferay.portal.kernel.exception.PortalException, 272 com.liferay.portal.kernel.exception.SystemException; 273 274 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 275 public com.liferay.portlet.messageboards.model.MBMailingList getCategoryMailingList( 276 long groupId, long categoryId) 277 throws com.liferay.portal.kernel.exception.PortalException, 278 com.liferay.portal.kernel.exception.SystemException; 279 280 public com.liferay.portlet.messageboards.model.MBMailingList updateMailingList( 281 long mailingListId, java.lang.String emailAddress, 282 java.lang.String inProtocol, java.lang.String inServerName, 283 int inServerPort, boolean inUseSSL, java.lang.String inUserName, 284 java.lang.String inPassword, int inReadInterval, 285 java.lang.String outEmailAddress, boolean outCustom, 286 java.lang.String outServerName, int outServerPort, boolean outUseSSL, 287 java.lang.String outUserName, java.lang.String outPassword, 288 boolean allowAnonymous, boolean active, 289 com.liferay.portal.service.ServiceContext serviceContext) 290 throws com.liferay.portal.kernel.exception.PortalException, 291 com.liferay.portal.kernel.exception.SystemException; 292 }