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