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 ban 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 MBBanLocalServiceUtil 034 * @see com.liferay.portlet.messageboards.service.base.MBBanLocalServiceBaseImpl 035 * @see com.liferay.portlet.messageboards.service.impl.MBBanLocalServiceImpl 036 * @generated 037 */ 038 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 039 PortalException.class, SystemException.class}) 040 public interface MBBanLocalService extends BaseLocalService, 041 PersistedModelLocalService { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * Never modify or reference this interface directly. Always use {@link MBBanLocalServiceUtil} to access the message boards ban local service. Add custom service methods to {@link com.liferay.portlet.messageboards.service.impl.MBBanLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 046 */ 047 048 /** 049 * Adds the message boards ban to the database. Also notifies the appropriate model listeners. 050 * 051 * @param mbBan the message boards ban 052 * @return the message boards ban that was added 053 * @throws SystemException if a system exception occurred 054 */ 055 public com.liferay.portlet.messageboards.model.MBBan addMBBan( 056 com.liferay.portlet.messageboards.model.MBBan mbBan) 057 throws com.liferay.portal.kernel.exception.SystemException; 058 059 /** 060 * Creates a new message boards ban with the primary key. Does not add the message boards ban to the database. 061 * 062 * @param banId the primary key for the new message boards ban 063 * @return the new message boards ban 064 */ 065 public com.liferay.portlet.messageboards.model.MBBan createMBBan(long banId); 066 067 /** 068 * Deletes the message boards ban with the primary key from the database. Also notifies the appropriate model listeners. 069 * 070 * @param banId the primary key of the message boards ban 071 * @return the message boards ban that was removed 072 * @throws PortalException if a message boards ban with the primary key could not be found 073 * @throws SystemException if a system exception occurred 074 */ 075 public com.liferay.portlet.messageboards.model.MBBan deleteMBBan(long banId) 076 throws com.liferay.portal.kernel.exception.PortalException, 077 com.liferay.portal.kernel.exception.SystemException; 078 079 /** 080 * Deletes the message boards ban from the database. Also notifies the appropriate model listeners. 081 * 082 * @param mbBan the message boards ban 083 * @return the message boards ban that was removed 084 * @throws SystemException if a system exception occurred 085 */ 086 public com.liferay.portlet.messageboards.model.MBBan deleteMBBan( 087 com.liferay.portlet.messageboards.model.MBBan mbBan) 088 throws com.liferay.portal.kernel.exception.SystemException; 089 090 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 091 092 /** 093 * Performs a dynamic query on the database and returns the matching rows. 094 * 095 * @param dynamicQuery the dynamic query 096 * @return the matching rows 097 * @throws SystemException if a system exception occurred 098 */ 099 @SuppressWarnings("rawtypes") 100 public java.util.List dynamicQuery( 101 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 102 throws com.liferay.portal.kernel.exception.SystemException; 103 104 /** 105 * Performs a dynamic query on the database and returns a range of the matching rows. 106 * 107 * <p> 108 * 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. 109 * </p> 110 * 111 * @param dynamicQuery the dynamic query 112 * @param start the lower bound of the range of model instances 113 * @param end the upper bound of the range of model instances (not inclusive) 114 * @return the range of matching rows 115 * @throws SystemException if a system exception occurred 116 */ 117 @SuppressWarnings("rawtypes") 118 public java.util.List dynamicQuery( 119 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 120 int end) throws com.liferay.portal.kernel.exception.SystemException; 121 122 /** 123 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 124 * 125 * <p> 126 * 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. 127 * </p> 128 * 129 * @param dynamicQuery the dynamic query 130 * @param start the lower bound of the range of model instances 131 * @param end the upper bound of the range of model instances (not inclusive) 132 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 133 * @return the ordered range of matching rows 134 * @throws SystemException if a system exception occurred 135 */ 136 @SuppressWarnings("rawtypes") 137 public java.util.List dynamicQuery( 138 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 139 int end, 140 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 141 throws com.liferay.portal.kernel.exception.SystemException; 142 143 /** 144 * Returns the number of rows that match the dynamic query. 145 * 146 * @param dynamicQuery the dynamic query 147 * @return the number of rows that match the dynamic query 148 * @throws SystemException if a system exception occurred 149 */ 150 public long dynamicQueryCount( 151 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 152 throws com.liferay.portal.kernel.exception.SystemException; 153 154 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 155 public com.liferay.portlet.messageboards.model.MBBan fetchMBBan(long banId) 156 throws com.liferay.portal.kernel.exception.SystemException; 157 158 /** 159 * Returns the message boards ban with the primary key. 160 * 161 * @param banId the primary key of the message boards ban 162 * @return the message boards ban 163 * @throws PortalException if a message boards ban with the primary key could not be found 164 * @throws SystemException if a system exception occurred 165 */ 166 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 167 public com.liferay.portlet.messageboards.model.MBBan getMBBan(long banId) 168 throws com.liferay.portal.kernel.exception.PortalException, 169 com.liferay.portal.kernel.exception.SystemException; 170 171 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 172 public com.liferay.portal.model.PersistedModel getPersistedModel( 173 java.io.Serializable primaryKeyObj) 174 throws com.liferay.portal.kernel.exception.PortalException, 175 com.liferay.portal.kernel.exception.SystemException; 176 177 /** 178 * Returns a range of all the message boards bans. 179 * 180 * <p> 181 * 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. 182 * </p> 183 * 184 * @param start the lower bound of the range of message boards bans 185 * @param end the upper bound of the range of message boards bans (not inclusive) 186 * @return the range of message boards bans 187 * @throws SystemException if a system exception occurred 188 */ 189 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 190 public java.util.List<com.liferay.portlet.messageboards.model.MBBan> getMBBans( 191 int start, int end) 192 throws com.liferay.portal.kernel.exception.SystemException; 193 194 /** 195 * Returns the number of message boards bans. 196 * 197 * @return the number of message boards bans 198 * @throws SystemException if a system exception occurred 199 */ 200 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 201 public int getMBBansCount() 202 throws com.liferay.portal.kernel.exception.SystemException; 203 204 /** 205 * Updates the message boards ban in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 206 * 207 * @param mbBan the message boards ban 208 * @return the message boards ban that was updated 209 * @throws SystemException if a system exception occurred 210 */ 211 public com.liferay.portlet.messageboards.model.MBBan updateMBBan( 212 com.liferay.portlet.messageboards.model.MBBan mbBan) 213 throws com.liferay.portal.kernel.exception.SystemException; 214 215 /** 216 * Updates the message boards ban in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 217 * 218 * @param mbBan the message boards ban 219 * @param merge whether to merge the message boards ban 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. 220 * @return the message boards ban that was updated 221 * @throws SystemException if a system exception occurred 222 */ 223 public com.liferay.portlet.messageboards.model.MBBan updateMBBan( 224 com.liferay.portlet.messageboards.model.MBBan mbBan, boolean merge) 225 throws com.liferay.portal.kernel.exception.SystemException; 226 227 /** 228 * Returns the Spring bean ID for this bean. 229 * 230 * @return the Spring bean ID for this bean 231 */ 232 public java.lang.String getBeanIdentifier(); 233 234 /** 235 * Sets the Spring bean ID for this bean. 236 * 237 * @param beanIdentifier the Spring bean ID for this bean 238 */ 239 public void setBeanIdentifier(java.lang.String beanIdentifier); 240 241 public com.liferay.portlet.messageboards.model.MBBan addBan(long userId, 242 long banUserId, com.liferay.portal.service.ServiceContext serviceContext) 243 throws com.liferay.portal.kernel.exception.PortalException, 244 com.liferay.portal.kernel.exception.SystemException; 245 246 public void checkBan(long groupId, long banUserId) 247 throws com.liferay.portal.kernel.exception.PortalException, 248 com.liferay.portal.kernel.exception.SystemException; 249 250 public void deleteBan(long banId) 251 throws com.liferay.portal.kernel.exception.PortalException, 252 com.liferay.portal.kernel.exception.SystemException; 253 254 public void deleteBan(long banUserId, 255 com.liferay.portal.service.ServiceContext serviceContext) 256 throws com.liferay.portal.kernel.exception.SystemException; 257 258 public void deleteBan(com.liferay.portlet.messageboards.model.MBBan ban) 259 throws com.liferay.portal.kernel.exception.SystemException; 260 261 public void deleteBansByBanUserId(long banUserId) 262 throws com.liferay.portal.kernel.exception.SystemException; 263 264 public void deleteBansByGroupId(long groupId) 265 throws com.liferay.portal.kernel.exception.SystemException; 266 267 public void expireBans() 268 throws com.liferay.portal.kernel.exception.SystemException; 269 270 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 271 public java.util.List<com.liferay.portlet.messageboards.model.MBBan> getBans( 272 long groupId, int start, int end) 273 throws com.liferay.portal.kernel.exception.SystemException; 274 275 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 276 public int getBansCount(long groupId) 277 throws com.liferay.portal.kernel.exception.SystemException; 278 279 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 280 public boolean hasBan(long groupId, long banUserId) 281 throws com.liferay.portal.kernel.exception.SystemException; 282 }