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