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 MBDiscussion. This utility wraps 024 * {@link com.liferay.portlet.messageboards.service.impl.MBDiscussionLocalServiceImpl} 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 MBDiscussionLocalService 032 * @see com.liferay.portlet.messageboards.service.base.MBDiscussionLocalServiceBaseImpl 033 * @see com.liferay.portlet.messageboards.service.impl.MBDiscussionLocalServiceImpl 034 * @generated 035 */ 036 @ProviderType 037 public class MBDiscussionLocalServiceUtil { 038 /* 039 * NOTE FOR DEVELOPERS: 040 * 041 * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.messageboards.service.impl.MBDiscussionLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 042 */ 043 044 /** 045 * Adds the message boards discussion to the database. Also notifies the appropriate model listeners. 046 * 047 * @param mbDiscussion the message boards discussion 048 * @return the message boards discussion that was added 049 * @throws SystemException if a system exception occurred 050 */ 051 public static com.liferay.portlet.messageboards.model.MBDiscussion addMBDiscussion( 052 com.liferay.portlet.messageboards.model.MBDiscussion mbDiscussion) 053 throws com.liferay.portal.kernel.exception.SystemException { 054 return getService().addMBDiscussion(mbDiscussion); 055 } 056 057 /** 058 * Creates a new message boards discussion with the primary key. Does not add the message boards discussion to the database. 059 * 060 * @param discussionId the primary key for the new message boards discussion 061 * @return the new message boards discussion 062 */ 063 public static com.liferay.portlet.messageboards.model.MBDiscussion createMBDiscussion( 064 long discussionId) { 065 return getService().createMBDiscussion(discussionId); 066 } 067 068 /** 069 * Deletes the message boards discussion with the primary key from the database. Also notifies the appropriate model listeners. 070 * 071 * @param discussionId the primary key of the message boards discussion 072 * @return the message boards discussion that was removed 073 * @throws PortalException if a message boards discussion 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.MBDiscussion deleteMBDiscussion( 077 long discussionId) 078 throws com.liferay.portal.kernel.exception.PortalException, 079 com.liferay.portal.kernel.exception.SystemException { 080 return getService().deleteMBDiscussion(discussionId); 081 } 082 083 /** 084 * Deletes the message boards discussion from the database. Also notifies the appropriate model listeners. 085 * 086 * @param mbDiscussion the message boards discussion 087 * @return the message boards discussion that was removed 088 * @throws SystemException if a system exception occurred 089 */ 090 public static com.liferay.portlet.messageboards.model.MBDiscussion deleteMBDiscussion( 091 com.liferay.portlet.messageboards.model.MBDiscussion mbDiscussion) 092 throws com.liferay.portal.kernel.exception.SystemException { 093 return getService().deleteMBDiscussion(mbDiscussion); 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.MBDiscussionModelImpl}. 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.MBDiscussionModelImpl}. 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.MBDiscussion fetchMBDiscussion( 187 long discussionId) 188 throws com.liferay.portal.kernel.exception.SystemException { 189 return getService().fetchMBDiscussion(discussionId); 190 } 191 192 /** 193 * Returns the message boards discussion with the matching UUID and company. 194 * 195 * @param uuid the message boards discussion's UUID 196 * @param companyId the primary key of the company 197 * @return the matching message boards discussion, or <code>null</code> if a matching message boards discussion could not be found 198 * @throws SystemException if a system exception occurred 199 */ 200 public static com.liferay.portlet.messageboards.model.MBDiscussion fetchMBDiscussionByUuidAndCompanyId( 201 java.lang.String uuid, long companyId) 202 throws com.liferay.portal.kernel.exception.SystemException { 203 return getService().fetchMBDiscussionByUuidAndCompanyId(uuid, companyId); 204 } 205 206 /** 207 * Returns the message boards discussion matching the UUID and group. 208 * 209 * @param uuid the message boards discussion's UUID 210 * @param groupId the primary key of the group 211 * @return the matching message boards discussion, or <code>null</code> if a matching message boards discussion could not be found 212 * @throws SystemException if a system exception occurred 213 */ 214 public static com.liferay.portlet.messageboards.model.MBDiscussion fetchMBDiscussionByUuidAndGroupId( 215 java.lang.String uuid, long groupId) 216 throws com.liferay.portal.kernel.exception.SystemException { 217 return getService().fetchMBDiscussionByUuidAndGroupId(uuid, groupId); 218 } 219 220 /** 221 * Returns the message boards discussion with the primary key. 222 * 223 * @param discussionId the primary key of the message boards discussion 224 * @return the message boards discussion 225 * @throws PortalException if a message boards discussion with the primary key could not be found 226 * @throws SystemException if a system exception occurred 227 */ 228 public static com.liferay.portlet.messageboards.model.MBDiscussion getMBDiscussion( 229 long discussionId) 230 throws com.liferay.portal.kernel.exception.PortalException, 231 com.liferay.portal.kernel.exception.SystemException { 232 return getService().getMBDiscussion(discussionId); 233 } 234 235 public static com.liferay.portal.model.PersistedModel getPersistedModel( 236 java.io.Serializable primaryKeyObj) 237 throws com.liferay.portal.kernel.exception.PortalException, 238 com.liferay.portal.kernel.exception.SystemException { 239 return getService().getPersistedModel(primaryKeyObj); 240 } 241 242 /** 243 * Returns the message boards discussion with the matching UUID and company. 244 * 245 * @param uuid the message boards discussion's UUID 246 * @param companyId the primary key of the company 247 * @return the matching message boards discussion 248 * @throws PortalException if a matching message boards discussion could not be found 249 * @throws SystemException if a system exception occurred 250 */ 251 public static com.liferay.portlet.messageboards.model.MBDiscussion getMBDiscussionByUuidAndCompanyId( 252 java.lang.String uuid, long companyId) 253 throws com.liferay.portal.kernel.exception.PortalException, 254 com.liferay.portal.kernel.exception.SystemException { 255 return getService().getMBDiscussionByUuidAndCompanyId(uuid, companyId); 256 } 257 258 /** 259 * Returns the message boards discussion matching the UUID and group. 260 * 261 * @param uuid the message boards discussion's UUID 262 * @param groupId the primary key of the group 263 * @return the matching message boards discussion 264 * @throws PortalException if a matching message boards discussion could not be found 265 * @throws SystemException if a system exception occurred 266 */ 267 public static com.liferay.portlet.messageboards.model.MBDiscussion getMBDiscussionByUuidAndGroupId( 268 java.lang.String uuid, long groupId) 269 throws com.liferay.portal.kernel.exception.PortalException, 270 com.liferay.portal.kernel.exception.SystemException { 271 return getService().getMBDiscussionByUuidAndGroupId(uuid, groupId); 272 } 273 274 /** 275 * Returns a range of all the message boards discussions. 276 * 277 * <p> 278 * 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.MBDiscussionModelImpl}. 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. 279 * </p> 280 * 281 * @param start the lower bound of the range of message boards discussions 282 * @param end the upper bound of the range of message boards discussions (not inclusive) 283 * @return the range of message boards discussions 284 * @throws SystemException if a system exception occurred 285 */ 286 public static java.util.List<com.liferay.portlet.messageboards.model.MBDiscussion> getMBDiscussions( 287 int start, int end) 288 throws com.liferay.portal.kernel.exception.SystemException { 289 return getService().getMBDiscussions(start, end); 290 } 291 292 /** 293 * Returns the number of message boards discussions. 294 * 295 * @return the number of message boards discussions 296 * @throws SystemException if a system exception occurred 297 */ 298 public static int getMBDiscussionsCount() 299 throws com.liferay.portal.kernel.exception.SystemException { 300 return getService().getMBDiscussionsCount(); 301 } 302 303 /** 304 * Updates the message boards discussion in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 305 * 306 * @param mbDiscussion the message boards discussion 307 * @return the message boards discussion that was updated 308 * @throws SystemException if a system exception occurred 309 */ 310 public static com.liferay.portlet.messageboards.model.MBDiscussion updateMBDiscussion( 311 com.liferay.portlet.messageboards.model.MBDiscussion mbDiscussion) 312 throws com.liferay.portal.kernel.exception.SystemException { 313 return getService().updateMBDiscussion(mbDiscussion); 314 } 315 316 /** 317 * Returns the Spring bean ID for this bean. 318 * 319 * @return the Spring bean ID for this bean 320 */ 321 public static java.lang.String getBeanIdentifier() { 322 return getService().getBeanIdentifier(); 323 } 324 325 /** 326 * Sets the Spring bean ID for this bean. 327 * 328 * @param beanIdentifier the Spring bean ID for this bean 329 */ 330 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 331 getService().setBeanIdentifier(beanIdentifier); 332 } 333 334 public static com.liferay.portlet.messageboards.model.MBDiscussion addDiscussion( 335 long userId, long classNameId, long classPK, long threadId, 336 com.liferay.portal.service.ServiceContext serviceContext) 337 throws com.liferay.portal.kernel.exception.PortalException, 338 com.liferay.portal.kernel.exception.SystemException { 339 return getService() 340 .addDiscussion(userId, classNameId, classPK, threadId, 341 serviceContext); 342 } 343 344 public static com.liferay.portlet.messageboards.model.MBDiscussion fetchDiscussion( 345 long discussionId) 346 throws com.liferay.portal.kernel.exception.SystemException { 347 return getService().fetchDiscussion(discussionId); 348 } 349 350 public static com.liferay.portlet.messageboards.model.MBDiscussion fetchDiscussion( 351 java.lang.String className, long classPK) 352 throws com.liferay.portal.kernel.exception.SystemException { 353 return getService().fetchDiscussion(className, classPK); 354 } 355 356 public static com.liferay.portlet.messageboards.model.MBDiscussion getDiscussion( 357 long discussionId) 358 throws com.liferay.portal.kernel.exception.PortalException, 359 com.liferay.portal.kernel.exception.SystemException { 360 return getService().getDiscussion(discussionId); 361 } 362 363 public static com.liferay.portlet.messageboards.model.MBDiscussion getDiscussion( 364 java.lang.String className, long classPK) 365 throws com.liferay.portal.kernel.exception.PortalException, 366 com.liferay.portal.kernel.exception.SystemException { 367 return getService().getDiscussion(className, classPK); 368 } 369 370 public static com.liferay.portlet.messageboards.model.MBDiscussion getThreadDiscussion( 371 long threadId) 372 throws com.liferay.portal.kernel.exception.PortalException, 373 com.liferay.portal.kernel.exception.SystemException { 374 return getService().getThreadDiscussion(threadId); 375 } 376 377 public static MBDiscussionLocalService getService() { 378 if (_service == null) { 379 _service = (MBDiscussionLocalService)PortalBeanLocatorUtil.locate(MBDiscussionLocalService.class.getName()); 380 381 ReferenceRegistry.registerReference(MBDiscussionLocalServiceUtil.class, 382 "_service"); 383 } 384 385 return _service; 386 } 387 388 /** 389 * @deprecated As of 6.2.0 390 */ 391 public void setService(MBDiscussionLocalService service) { 392 } 393 394 private static MBDiscussionLocalService _service; 395 }