001 /** 002 * Copyright (c) 2000-2012 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 * The utility for the d d m content local service. This utility wraps {@link com.liferay.portlet.dynamicdatamapping.service.impl.DDMContentLocalServiceImpl} 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 DDMContentLocalService 029 * @see com.liferay.portlet.dynamicdatamapping.service.base.DDMContentLocalServiceBaseImpl 030 * @see com.liferay.portlet.dynamicdatamapping.service.impl.DDMContentLocalServiceImpl 031 * @generated 032 */ 033 public class DDMContentLocalServiceUtil { 034 /* 035 * NOTE FOR DEVELOPERS: 036 * 037 * 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. 038 */ 039 040 /** 041 * Adds the d d m content to the database. Also notifies the appropriate model listeners. 042 * 043 * @param ddmContent the d d m content 044 * @return the d d m content that was added 045 * @throws SystemException if a system exception occurred 046 */ 047 public static com.liferay.portlet.dynamicdatamapping.model.DDMContent addDDMContent( 048 com.liferay.portlet.dynamicdatamapping.model.DDMContent ddmContent) 049 throws com.liferay.portal.kernel.exception.SystemException { 050 return getService().addDDMContent(ddmContent); 051 } 052 053 /** 054 * Creates a new d d m content with the primary key. Does not add the d d m content to the database. 055 * 056 * @param contentId the primary key for the new d d m content 057 * @return the new d d m content 058 */ 059 public static com.liferay.portlet.dynamicdatamapping.model.DDMContent createDDMContent( 060 long contentId) { 061 return getService().createDDMContent(contentId); 062 } 063 064 /** 065 * Deletes the d d m content with the primary key from the database. Also notifies the appropriate model listeners. 066 * 067 * @param contentId the primary key of the d d m content 068 * @return the d d m content that was removed 069 * @throws PortalException if a d d m content with the primary key could not be found 070 * @throws SystemException if a system exception occurred 071 */ 072 public static com.liferay.portlet.dynamicdatamapping.model.DDMContent deleteDDMContent( 073 long contentId) 074 throws com.liferay.portal.kernel.exception.PortalException, 075 com.liferay.portal.kernel.exception.SystemException { 076 return getService().deleteDDMContent(contentId); 077 } 078 079 /** 080 * Deletes the d d m content from the database. Also notifies the appropriate model listeners. 081 * 082 * @param ddmContent the d d m content 083 * @return the d d m content that was removed 084 * @throws SystemException if a system exception occurred 085 */ 086 public static com.liferay.portlet.dynamicdatamapping.model.DDMContent deleteDDMContent( 087 com.liferay.portlet.dynamicdatamapping.model.DDMContent ddmContent) 088 throws com.liferay.portal.kernel.exception.SystemException { 089 return getService().deleteDDMContent(ddmContent); 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.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. 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.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. 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.dynamicdatamapping.model.DDMContent fetchDDMContent( 168 long contentId) 169 throws com.liferay.portal.kernel.exception.SystemException { 170 return getService().fetchDDMContent(contentId); 171 } 172 173 /** 174 * Returns the d d m content with the primary key. 175 * 176 * @param contentId the primary key of the d d m content 177 * @return the d d m content 178 * @throws PortalException if a d d m content with the primary key could not be found 179 * @throws SystemException if a system exception occurred 180 */ 181 public static com.liferay.portlet.dynamicdatamapping.model.DDMContent getDDMContent( 182 long contentId) 183 throws com.liferay.portal.kernel.exception.PortalException, 184 com.liferay.portal.kernel.exception.SystemException { 185 return getService().getDDMContent(contentId); 186 } 187 188 public static com.liferay.portal.model.PersistedModel getPersistedModel( 189 java.io.Serializable primaryKeyObj) 190 throws com.liferay.portal.kernel.exception.PortalException, 191 com.liferay.portal.kernel.exception.SystemException { 192 return getService().getPersistedModel(primaryKeyObj); 193 } 194 195 /** 196 * Returns the d d m content with the UUID in the group. 197 * 198 * @param uuid the UUID of d d m content 199 * @param groupId the group id of the d d m content 200 * @return the d d m content 201 * @throws PortalException if a d d m content with the UUID in the group could not be found 202 * @throws SystemException if a system exception occurred 203 */ 204 public static com.liferay.portlet.dynamicdatamapping.model.DDMContent getDDMContentByUuidAndGroupId( 205 java.lang.String uuid, long groupId) 206 throws com.liferay.portal.kernel.exception.PortalException, 207 com.liferay.portal.kernel.exception.SystemException { 208 return getService().getDDMContentByUuidAndGroupId(uuid, groupId); 209 } 210 211 /** 212 * Returns a range of all the d d m contents. 213 * 214 * <p> 215 * 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. 216 * </p> 217 * 218 * @param start the lower bound of the range of d d m contents 219 * @param end the upper bound of the range of d d m contents (not inclusive) 220 * @return the range of d d m contents 221 * @throws SystemException if a system exception occurred 222 */ 223 public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMContent> getDDMContents( 224 int start, int end) 225 throws com.liferay.portal.kernel.exception.SystemException { 226 return getService().getDDMContents(start, end); 227 } 228 229 /** 230 * Returns the number of d d m contents. 231 * 232 * @return the number of d d m contents 233 * @throws SystemException if a system exception occurred 234 */ 235 public static int getDDMContentsCount() 236 throws com.liferay.portal.kernel.exception.SystemException { 237 return getService().getDDMContentsCount(); 238 } 239 240 /** 241 * Updates the d d m content in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 242 * 243 * @param ddmContent the d d m content 244 * @return the d d m content that was updated 245 * @throws SystemException if a system exception occurred 246 */ 247 public static com.liferay.portlet.dynamicdatamapping.model.DDMContent updateDDMContent( 248 com.liferay.portlet.dynamicdatamapping.model.DDMContent ddmContent) 249 throws com.liferay.portal.kernel.exception.SystemException { 250 return getService().updateDDMContent(ddmContent); 251 } 252 253 /** 254 * Returns the Spring bean ID for this bean. 255 * 256 * @return the Spring bean ID for this bean 257 */ 258 public static java.lang.String getBeanIdentifier() { 259 return getService().getBeanIdentifier(); 260 } 261 262 /** 263 * Sets the Spring bean ID for this bean. 264 * 265 * @param beanIdentifier the Spring bean ID for this bean 266 */ 267 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 268 getService().setBeanIdentifier(beanIdentifier); 269 } 270 271 public static com.liferay.portlet.dynamicdatamapping.model.DDMContent addContent( 272 long userId, long groupId, java.lang.String name, 273 java.lang.String description, java.lang.String xml, 274 com.liferay.portal.service.ServiceContext serviceContext) 275 throws com.liferay.portal.kernel.exception.PortalException, 276 com.liferay.portal.kernel.exception.SystemException { 277 return getService() 278 .addContent(userId, groupId, name, description, xml, 279 serviceContext); 280 } 281 282 public static void deleteContent( 283 com.liferay.portlet.dynamicdatamapping.model.DDMContent content) 284 throws com.liferay.portal.kernel.exception.SystemException { 285 getService().deleteContent(content); 286 } 287 288 public static void deleteContents(long groupId) 289 throws com.liferay.portal.kernel.exception.SystemException { 290 getService().deleteContents(groupId); 291 } 292 293 public static com.liferay.portlet.dynamicdatamapping.model.DDMContent getContent( 294 long contentId) 295 throws com.liferay.portal.kernel.exception.PortalException, 296 com.liferay.portal.kernel.exception.SystemException { 297 return getService().getContent(contentId); 298 } 299 300 public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMContent> getContents() 301 throws com.liferay.portal.kernel.exception.SystemException { 302 return getService().getContents(); 303 } 304 305 public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMContent> getContents( 306 long groupId) 307 throws com.liferay.portal.kernel.exception.SystemException { 308 return getService().getContents(groupId); 309 } 310 311 public static java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMContent> getContents( 312 long groupId, int start, int end) 313 throws com.liferay.portal.kernel.exception.SystemException { 314 return getService().getContents(groupId, start, end); 315 } 316 317 public static int getContentsCount(long groupId) 318 throws com.liferay.portal.kernel.exception.SystemException { 319 return getService().getContentsCount(groupId); 320 } 321 322 public static com.liferay.portlet.dynamicdatamapping.model.DDMContent updateContent( 323 long contentId, java.lang.String name, java.lang.String description, 324 java.lang.String xml, 325 com.liferay.portal.service.ServiceContext serviceContext) 326 throws com.liferay.portal.kernel.exception.PortalException, 327 com.liferay.portal.kernel.exception.SystemException { 328 return getService() 329 .updateContent(contentId, name, description, xml, 330 serviceContext); 331 } 332 333 public static DDMContentLocalService getService() { 334 if (_service == null) { 335 _service = (DDMContentLocalService)PortalBeanLocatorUtil.locate(DDMContentLocalService.class.getName()); 336 337 ReferenceRegistry.registerReference(DDMContentLocalServiceUtil.class, 338 "_service"); 339 } 340 341 return _service; 342 } 343 344 /** 345 * @deprecated 346 */ 347 public void setService(DDMContentLocalService service) { 348 } 349 350 private static DDMContentLocalService _service; 351 }