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.bean.PortalBeanLocatorUtil; 018 import com.liferay.portal.kernel.util.ReferenceRegistry; 019 020 /** 021 * The utility for the message boards ban local service. This utility wraps {@link com.liferay.portlet.messageboards.service.impl.MBBanLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server. 022 * 023 * <p> 024 * 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. 025 * </p> 026 * 027 * @author Brian Wing Shun Chan 028 * @see MBBanLocalService 029 * @see com.liferay.portlet.messageboards.service.base.MBBanLocalServiceBaseImpl 030 * @see com.liferay.portlet.messageboards.service.impl.MBBanLocalServiceImpl 031 * @generated 032 */ 033 public class MBBanLocalServiceUtil { 034 /* 035 * NOTE FOR DEVELOPERS: 036 * 037 * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.messageboards.service.impl.MBBanLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 038 */ 039 040 /** 041 * Adds the message boards ban to the database. Also notifies the appropriate model listeners. 042 * 043 * @param mbBan the message boards ban 044 * @return the message boards ban that was added 045 * @throws SystemException if a system exception occurred 046 */ 047 public static com.liferay.portlet.messageboards.model.MBBan addMBBan( 048 com.liferay.portlet.messageboards.model.MBBan mbBan) 049 throws com.liferay.portal.kernel.exception.SystemException { 050 return getService().addMBBan(mbBan); 051 } 052 053 /** 054 * Creates a new message boards ban with the primary key. Does not add the message boards ban to the database. 055 * 056 * @param banId the primary key for the new message boards ban 057 * @return the new message boards ban 058 */ 059 public static com.liferay.portlet.messageboards.model.MBBan createMBBan( 060 long banId) { 061 return getService().createMBBan(banId); 062 } 063 064 /** 065 * Deletes the message boards ban with the primary key from the database. Also notifies the appropriate model listeners. 066 * 067 * @param banId the primary key of the message boards ban 068 * @return the message boards ban that was removed 069 * @throws PortalException if a message boards ban with the primary key could not be found 070 * @throws SystemException if a system exception occurred 071 */ 072 public static com.liferay.portlet.messageboards.model.MBBan deleteMBBan( 073 long banId) 074 throws com.liferay.portal.kernel.exception.PortalException, 075 com.liferay.portal.kernel.exception.SystemException { 076 return getService().deleteMBBan(banId); 077 } 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 static com.liferay.portlet.messageboards.model.MBBan deleteMBBan( 087 com.liferay.portlet.messageboards.model.MBBan mbBan) 088 throws com.liferay.portal.kernel.exception.SystemException { 089 return getService().deleteMBBan(mbBan); 090 } 091 092 public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 093 return getService().dynamicQuery(); 094 } 095 096 /** 097 * Performs a dynamic query on the database and returns the matching rows. 098 * 099 * @param dynamicQuery the dynamic query 100 * @return the matching rows 101 * @throws SystemException if a system exception occurred 102 */ 103 @SuppressWarnings("rawtypes") 104 public static java.util.List dynamicQuery( 105 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 106 throws com.liferay.portal.kernel.exception.SystemException { 107 return getService().dynamicQuery(dynamicQuery); 108 } 109 110 /** 111 * Performs a dynamic query on the database and returns a range of the matching rows. 112 * 113 * <p> 114 * 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.MBBanModelImpl}. 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. 115 * </p> 116 * 117 * @param dynamicQuery the dynamic query 118 * @param start the lower bound of the range of model instances 119 * @param end the upper bound of the range of model instances (not inclusive) 120 * @return the range of matching rows 121 * @throws SystemException if a system exception occurred 122 */ 123 @SuppressWarnings("rawtypes") 124 public static java.util.List dynamicQuery( 125 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 126 int end) throws com.liferay.portal.kernel.exception.SystemException { 127 return getService().dynamicQuery(dynamicQuery, start, end); 128 } 129 130 /** 131 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 132 * 133 * <p> 134 * 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.MBBanModelImpl}. 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. 135 * </p> 136 * 137 * @param dynamicQuery the dynamic query 138 * @param start the lower bound of the range of model instances 139 * @param end the upper bound of the range of model instances (not inclusive) 140 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 141 * @return the ordered range of matching rows 142 * @throws SystemException if a system exception occurred 143 */ 144 @SuppressWarnings("rawtypes") 145 public static java.util.List dynamicQuery( 146 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 147 int end, 148 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 149 throws com.liferay.portal.kernel.exception.SystemException { 150 return getService() 151 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 152 } 153 154 /** 155 * Returns the number of rows that match the dynamic query. 156 * 157 * @param dynamicQuery the dynamic query 158 * @return the number of rows that match the dynamic query 159 * @throws SystemException if a system exception occurred 160 */ 161 public static long dynamicQueryCount( 162 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 163 throws com.liferay.portal.kernel.exception.SystemException { 164 return getService().dynamicQueryCount(dynamicQuery); 165 } 166 167 public static com.liferay.portlet.messageboards.model.MBBan fetchMBBan( 168 long banId) throws com.liferay.portal.kernel.exception.SystemException { 169 return getService().fetchMBBan(banId); 170 } 171 172 /** 173 * Returns the message boards ban with the primary key. 174 * 175 * @param banId the primary key of the message boards ban 176 * @return the message boards ban 177 * @throws PortalException if a message boards ban with the primary key could not be found 178 * @throws SystemException if a system exception occurred 179 */ 180 public static com.liferay.portlet.messageboards.model.MBBan getMBBan( 181 long banId) 182 throws com.liferay.portal.kernel.exception.PortalException, 183 com.liferay.portal.kernel.exception.SystemException { 184 return getService().getMBBan(banId); 185 } 186 187 public static com.liferay.portal.model.PersistedModel getPersistedModel( 188 java.io.Serializable primaryKeyObj) 189 throws com.liferay.portal.kernel.exception.PortalException, 190 com.liferay.portal.kernel.exception.SystemException { 191 return getService().getPersistedModel(primaryKeyObj); 192 } 193 194 /** 195 * Returns the message boards ban matching the UUID and group. 196 * 197 * @param uuid the message boards ban's UUID 198 * @param groupId the primary key of the group 199 * @return the matching message boards ban 200 * @throws PortalException if a matching message boards ban could not be found 201 * @throws SystemException if a system exception occurred 202 */ 203 public static com.liferay.portlet.messageboards.model.MBBan getMBBanByUuidAndGroupId( 204 java.lang.String uuid, long groupId) 205 throws com.liferay.portal.kernel.exception.PortalException, 206 com.liferay.portal.kernel.exception.SystemException { 207 return getService().getMBBanByUuidAndGroupId(uuid, groupId); 208 } 209 210 /** 211 * Returns a range of all the message boards bans. 212 * 213 * <p> 214 * 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.MBBanModelImpl}. 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. 215 * </p> 216 * 217 * @param start the lower bound of the range of message boards bans 218 * @param end the upper bound of the range of message boards bans (not inclusive) 219 * @return the range of message boards bans 220 * @throws SystemException if a system exception occurred 221 */ 222 public static java.util.List<com.liferay.portlet.messageboards.model.MBBan> getMBBans( 223 int start, int end) 224 throws com.liferay.portal.kernel.exception.SystemException { 225 return getService().getMBBans(start, end); 226 } 227 228 /** 229 * Returns the number of message boards bans. 230 * 231 * @return the number of message boards bans 232 * @throws SystemException if a system exception occurred 233 */ 234 public static int getMBBansCount() 235 throws com.liferay.portal.kernel.exception.SystemException { 236 return getService().getMBBansCount(); 237 } 238 239 /** 240 * Updates the message boards ban in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 241 * 242 * @param mbBan the message boards ban 243 * @return the message boards ban that was updated 244 * @throws SystemException if a system exception occurred 245 */ 246 public static com.liferay.portlet.messageboards.model.MBBan updateMBBan( 247 com.liferay.portlet.messageboards.model.MBBan mbBan) 248 throws com.liferay.portal.kernel.exception.SystemException { 249 return getService().updateMBBan(mbBan); 250 } 251 252 /** 253 * Returns the Spring bean ID for this bean. 254 * 255 * @return the Spring bean ID for this bean 256 */ 257 public static java.lang.String getBeanIdentifier() { 258 return getService().getBeanIdentifier(); 259 } 260 261 /** 262 * Sets the Spring bean ID for this bean. 263 * 264 * @param beanIdentifier the Spring bean ID for this bean 265 */ 266 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 267 getService().setBeanIdentifier(beanIdentifier); 268 } 269 270 public static com.liferay.portlet.messageboards.model.MBBan addBan( 271 long userId, long banUserId, 272 com.liferay.portal.service.ServiceContext serviceContext) 273 throws com.liferay.portal.kernel.exception.PortalException, 274 com.liferay.portal.kernel.exception.SystemException { 275 return getService().addBan(userId, banUserId, serviceContext); 276 } 277 278 public static void checkBan(long groupId, long banUserId) 279 throws com.liferay.portal.kernel.exception.PortalException, 280 com.liferay.portal.kernel.exception.SystemException { 281 getService().checkBan(groupId, banUserId); 282 } 283 284 public static void deleteBan(long banId) 285 throws com.liferay.portal.kernel.exception.PortalException, 286 com.liferay.portal.kernel.exception.SystemException { 287 getService().deleteBan(banId); 288 } 289 290 public static void deleteBan(long banUserId, 291 com.liferay.portal.service.ServiceContext serviceContext) 292 throws com.liferay.portal.kernel.exception.SystemException { 293 getService().deleteBan(banUserId, serviceContext); 294 } 295 296 public static void deleteBan( 297 com.liferay.portlet.messageboards.model.MBBan ban) 298 throws com.liferay.portal.kernel.exception.SystemException { 299 getService().deleteBan(ban); 300 } 301 302 public static void deleteBansByBanUserId(long banUserId) 303 throws com.liferay.portal.kernel.exception.SystemException { 304 getService().deleteBansByBanUserId(banUserId); 305 } 306 307 public static void deleteBansByGroupId(long groupId) 308 throws com.liferay.portal.kernel.exception.SystemException { 309 getService().deleteBansByGroupId(groupId); 310 } 311 312 public static void expireBans() 313 throws com.liferay.portal.kernel.exception.SystemException { 314 getService().expireBans(); 315 } 316 317 public static java.util.List<com.liferay.portlet.messageboards.model.MBBan> getBans( 318 long groupId, int start, int end) 319 throws com.liferay.portal.kernel.exception.SystemException { 320 return getService().getBans(groupId, start, end); 321 } 322 323 public static int getBansCount(long groupId) 324 throws com.liferay.portal.kernel.exception.SystemException { 325 return getService().getBansCount(groupId); 326 } 327 328 public static boolean hasBan(long groupId, long banUserId) 329 throws com.liferay.portal.kernel.exception.SystemException { 330 return getService().hasBan(groupId, banUserId); 331 } 332 333 public static MBBanLocalService getService() { 334 if (_service == null) { 335 _service = (MBBanLocalService)PortalBeanLocatorUtil.locate(MBBanLocalService.class.getName()); 336 337 ReferenceRegistry.registerReference(MBBanLocalServiceUtil.class, 338 "_service"); 339 } 340 341 return _service; 342 } 343 344 /** 345 * @deprecated As of 6.2.0 346 */ 347 public void setService(MBBanLocalService service) { 348 } 349 350 private static MBBanLocalService _service; 351 }