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