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