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 com.liferay.portal.kernel.exception.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 com.liferay.portal.kernel.exception.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) 095 throws com.liferay.portal.kernel.exception.PortalException; 096 097 /** 098 * Deletes the message boards mailing list from the database. Also notifies the appropriate model listeners. 099 * 100 * @param mbMailingList the message boards mailing list 101 * @return the message boards mailing list that was removed 102 */ 103 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 104 public com.liferay.portlet.messageboards.model.MBMailingList deleteMBMailingList( 105 com.liferay.portlet.messageboards.model.MBMailingList mbMailingList); 106 107 public void deleteMailingList( 108 com.liferay.portlet.messageboards.model.MBMailingList mailingList) 109 throws com.liferay.portal.kernel.exception.PortalException; 110 111 public void deleteMailingList(long mailingListId) 112 throws com.liferay.portal.kernel.exception.PortalException; 113 114 /** 115 * @throws PortalException 116 */ 117 @Override 118 public com.liferay.portal.model.PersistedModel deletePersistedModel( 119 com.liferay.portal.model.PersistedModel persistedModel) 120 throws com.liferay.portal.kernel.exception.PortalException; 121 122 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 123 124 /** 125 * Performs a dynamic query on the database and returns the matching rows. 126 * 127 * @param dynamicQuery the dynamic query 128 * @return the matching rows 129 */ 130 public <T> java.util.List<T> dynamicQuery( 131 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 132 133 /** 134 * Performs a dynamic query on the database and returns a range of the matching rows. 135 * 136 * <p> 137 * 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. 138 * </p> 139 * 140 * @param dynamicQuery the dynamic query 141 * @param start the lower bound of the range of model instances 142 * @param end the upper bound of the range of model instances (not inclusive) 143 * @return the range of matching rows 144 */ 145 public <T> java.util.List<T> dynamicQuery( 146 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 147 int end); 148 149 /** 150 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 151 * 152 * <p> 153 * 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. 154 * </p> 155 * 156 * @param dynamicQuery the dynamic query 157 * @param start the lower bound of the range of model instances 158 * @param end the upper bound of the range of model instances (not inclusive) 159 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 160 * @return the ordered range of matching rows 161 */ 162 public <T> java.util.List<T> dynamicQuery( 163 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 164 int end, 165 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 166 167 /** 168 * Returns the number of rows matching the dynamic query. 169 * 170 * @param dynamicQuery the dynamic query 171 * @return the number of rows matching the dynamic query 172 */ 173 public long dynamicQueryCount( 174 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 175 176 /** 177 * Returns the number of rows matching the dynamic query. 178 * 179 * @param dynamicQuery the dynamic query 180 * @param projection the projection to apply to the query 181 * @return the number of rows matching the dynamic query 182 */ 183 public long dynamicQueryCount( 184 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 185 com.liferay.portal.kernel.dao.orm.Projection projection); 186 187 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 188 public com.liferay.portlet.messageboards.model.MBMailingList fetchMBMailingList( 189 long mailingListId); 190 191 /** 192 * Returns the message boards mailing list matching the UUID and group. 193 * 194 * @param uuid the message boards mailing list's UUID 195 * @param groupId the primary key of the group 196 * @return the matching message boards mailing list, or <code>null</code> if a matching message boards mailing list could not be found 197 */ 198 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 199 public com.liferay.portlet.messageboards.model.MBMailingList fetchMBMailingListByUuidAndGroupId( 200 java.lang.String uuid, long groupId); 201 202 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 203 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 204 205 /** 206 * Returns the Spring bean ID for this bean. 207 * 208 * @return the Spring bean ID for this bean 209 */ 210 public java.lang.String getBeanIdentifier(); 211 212 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 213 public com.liferay.portlet.messageboards.model.MBMailingList getCategoryMailingList( 214 long groupId, long categoryId) 215 throws com.liferay.portal.kernel.exception.PortalException; 216 217 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 218 public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery( 219 com.liferay.portal.kernel.lar.PortletDataContext portletDataContext); 220 221 /** 222 * Returns the message boards mailing list with the primary key. 223 * 224 * @param mailingListId the primary key of the message boards mailing list 225 * @return the message boards mailing list 226 * @throws PortalException if a message boards mailing list with the primary key could not be found 227 */ 228 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 229 public com.liferay.portlet.messageboards.model.MBMailingList getMBMailingList( 230 long mailingListId) 231 throws com.liferay.portal.kernel.exception.PortalException; 232 233 /** 234 * Returns the message boards mailing list matching the UUID and group. 235 * 236 * @param uuid the message boards mailing list's UUID 237 * @param groupId the primary key of the group 238 * @return the matching message boards mailing list 239 * @throws PortalException if a matching message boards mailing list could not be found 240 */ 241 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 242 public com.liferay.portlet.messageboards.model.MBMailingList getMBMailingListByUuidAndGroupId( 243 java.lang.String uuid, long groupId) 244 throws com.liferay.portal.kernel.exception.PortalException; 245 246 /** 247 * Returns a range of all the message boards mailing lists. 248 * 249 * <p> 250 * 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. 251 * </p> 252 * 253 * @param start the lower bound of the range of message boards mailing lists 254 * @param end the upper bound of the range of message boards mailing lists (not inclusive) 255 * @return the range of message boards mailing lists 256 */ 257 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 258 public java.util.List<com.liferay.portlet.messageboards.model.MBMailingList> getMBMailingLists( 259 int start, int end); 260 261 /** 262 * Returns all the message boards mailing lists matching the UUID and company. 263 * 264 * @param uuid the UUID of the message boards mailing lists 265 * @param companyId the primary key of the company 266 * @return the matching message boards mailing lists, or an empty list if no matches were found 267 */ 268 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 269 public java.util.List<com.liferay.portlet.messageboards.model.MBMailingList> getMBMailingListsByUuidAndCompanyId( 270 java.lang.String uuid, long companyId); 271 272 /** 273 * Returns a range of message boards mailing lists matching the UUID and company. 274 * 275 * @param uuid the UUID of the message boards mailing lists 276 * @param companyId the primary key of the company 277 * @param start the lower bound of the range of message boards mailing lists 278 * @param end the upper bound of the range of message boards mailing lists (not inclusive) 279 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 280 * @return the range of matching message boards mailing lists, or an empty list if no matches were found 281 */ 282 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 283 public java.util.List<com.liferay.portlet.messageboards.model.MBMailingList> getMBMailingListsByUuidAndCompanyId( 284 java.lang.String uuid, long companyId, int start, int end, 285 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.messageboards.model.MBMailingList> orderByComparator); 286 287 /** 288 * Returns the number of message boards mailing lists. 289 * 290 * @return the number of message boards mailing lists 291 */ 292 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 293 public int getMBMailingListsCount(); 294 295 @Override 296 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 297 public com.liferay.portal.model.PersistedModel getPersistedModel( 298 java.io.Serializable primaryKeyObj) 299 throws com.liferay.portal.kernel.exception.PortalException; 300 301 /** 302 * Sets the Spring bean ID for this bean. 303 * 304 * @param beanIdentifier the Spring bean ID for this bean 305 */ 306 public void setBeanIdentifier(java.lang.String beanIdentifier); 307 308 /** 309 * Updates the message boards mailing list in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 310 * 311 * @param mbMailingList the message boards mailing list 312 * @return the message boards mailing list that was updated 313 */ 314 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 315 public com.liferay.portlet.messageboards.model.MBMailingList updateMBMailingList( 316 com.liferay.portlet.messageboards.model.MBMailingList mbMailingList); 317 318 public com.liferay.portlet.messageboards.model.MBMailingList updateMailingList( 319 long mailingListId, java.lang.String emailAddress, 320 java.lang.String inProtocol, java.lang.String inServerName, 321 int inServerPort, boolean inUseSSL, java.lang.String inUserName, 322 java.lang.String inPassword, int inReadInterval, 323 java.lang.String outEmailAddress, boolean outCustom, 324 java.lang.String outServerName, int outServerPort, boolean outUseSSL, 325 java.lang.String outUserName, java.lang.String outPassword, 326 boolean allowAnonymous, boolean active, 327 com.liferay.portal.service.ServiceContext serviceContext) 328 throws com.liferay.portal.kernel.exception.PortalException; 329 }