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.portal.service; 016 017 import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil; 018 import com.liferay.portal.kernel.util.MethodCache; 019 import com.liferay.portal.kernel.util.ReferenceRegistry; 020 021 /** 022 * The utility for the layout prototype local service. This utility wraps {@link com.liferay.portal.service.impl.LayoutPrototypeLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server. 023 * 024 * <p> 025 * 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. 026 * </p> 027 * 028 * @author Brian Wing Shun Chan 029 * @see LayoutPrototypeLocalService 030 * @see com.liferay.portal.service.base.LayoutPrototypeLocalServiceBaseImpl 031 * @see com.liferay.portal.service.impl.LayoutPrototypeLocalServiceImpl 032 * @generated 033 */ 034 public class LayoutPrototypeLocalServiceUtil { 035 /* 036 * NOTE FOR DEVELOPERS: 037 * 038 * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutPrototypeLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 039 */ 040 041 /** 042 * Adds the layout prototype to the database. Also notifies the appropriate model listeners. 043 * 044 * @param layoutPrototype the layout prototype 045 * @return the layout prototype that was added 046 * @throws SystemException if a system exception occurred 047 */ 048 public static com.liferay.portal.model.LayoutPrototype addLayoutPrototype( 049 com.liferay.portal.model.LayoutPrototype layoutPrototype) 050 throws com.liferay.portal.kernel.exception.SystemException { 051 return getService().addLayoutPrototype(layoutPrototype); 052 } 053 054 /** 055 * Creates a new layout prototype with the primary key. Does not add the layout prototype to the database. 056 * 057 * @param layoutPrototypeId the primary key for the new layout prototype 058 * @return the new layout prototype 059 */ 060 public static com.liferay.portal.model.LayoutPrototype createLayoutPrototype( 061 long layoutPrototypeId) { 062 return getService().createLayoutPrototype(layoutPrototypeId); 063 } 064 065 /** 066 * Deletes the layout prototype with the primary key from the database. Also notifies the appropriate model listeners. 067 * 068 * @param layoutPrototypeId the primary key of the layout prototype 069 * @throws PortalException if a layout prototype with the primary key could not be found 070 * @throws SystemException if a system exception occurred 071 */ 072 public static void deleteLayoutPrototype(long layoutPrototypeId) 073 throws com.liferay.portal.kernel.exception.PortalException, 074 com.liferay.portal.kernel.exception.SystemException { 075 getService().deleteLayoutPrototype(layoutPrototypeId); 076 } 077 078 /** 079 * Deletes the layout prototype from the database. Also notifies the appropriate model listeners. 080 * 081 * @param layoutPrototype the layout prototype 082 * @throws PortalException 083 * @throws SystemException if a system exception occurred 084 */ 085 public static void deleteLayoutPrototype( 086 com.liferay.portal.model.LayoutPrototype layoutPrototype) 087 throws com.liferay.portal.kernel.exception.PortalException, 088 com.liferay.portal.kernel.exception.SystemException { 089 getService().deleteLayoutPrototype(layoutPrototype); 090 } 091 092 /** 093 * Performs a dynamic query on the database and returns the matching rows. 094 * 095 * @param dynamicQuery the dynamic query 096 * @return the matching rows 097 * @throws SystemException if a system exception occurred 098 */ 099 @SuppressWarnings("rawtypes") 100 public static java.util.List dynamicQuery( 101 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 102 throws com.liferay.portal.kernel.exception.SystemException { 103 return getService().dynamicQuery(dynamicQuery); 104 } 105 106 /** 107 * Performs a dynamic query on the database and returns a range of the matching rows. 108 * 109 * <p> 110 * 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. 111 * </p> 112 * 113 * @param dynamicQuery the dynamic query 114 * @param start the lower bound of the range of model instances 115 * @param end the upper bound of the range of model instances (not inclusive) 116 * @return the range of matching rows 117 * @throws SystemException if a system exception occurred 118 */ 119 @SuppressWarnings("rawtypes") 120 public static java.util.List dynamicQuery( 121 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 122 int end) throws com.liferay.portal.kernel.exception.SystemException { 123 return getService().dynamicQuery(dynamicQuery, start, end); 124 } 125 126 /** 127 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 128 * 129 * <p> 130 * 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. 131 * </p> 132 * 133 * @param dynamicQuery the dynamic query 134 * @param start the lower bound of the range of model instances 135 * @param end the upper bound of the range of model instances (not inclusive) 136 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 137 * @return the ordered range of matching rows 138 * @throws SystemException if a system exception occurred 139 */ 140 @SuppressWarnings("rawtypes") 141 public static java.util.List dynamicQuery( 142 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 143 int end, 144 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 145 throws com.liferay.portal.kernel.exception.SystemException { 146 return getService() 147 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 148 } 149 150 /** 151 * Returns the number of rows that match the dynamic query. 152 * 153 * @param dynamicQuery the dynamic query 154 * @return the number of rows that match the dynamic query 155 * @throws SystemException if a system exception occurred 156 */ 157 public static long dynamicQueryCount( 158 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 159 throws com.liferay.portal.kernel.exception.SystemException { 160 return getService().dynamicQueryCount(dynamicQuery); 161 } 162 163 public static com.liferay.portal.model.LayoutPrototype fetchLayoutPrototype( 164 long layoutPrototypeId) 165 throws com.liferay.portal.kernel.exception.SystemException { 166 return getService().fetchLayoutPrototype(layoutPrototypeId); 167 } 168 169 /** 170 * Returns the layout prototype with the primary key. 171 * 172 * @param layoutPrototypeId the primary key of the layout prototype 173 * @return the layout prototype 174 * @throws PortalException if a layout prototype with the primary key could not be found 175 * @throws SystemException if a system exception occurred 176 */ 177 public static com.liferay.portal.model.LayoutPrototype getLayoutPrototype( 178 long layoutPrototypeId) 179 throws com.liferay.portal.kernel.exception.PortalException, 180 com.liferay.portal.kernel.exception.SystemException { 181 return getService().getLayoutPrototype(layoutPrototypeId); 182 } 183 184 public static com.liferay.portal.model.PersistedModel getPersistedModel( 185 java.io.Serializable primaryKeyObj) 186 throws com.liferay.portal.kernel.exception.PortalException, 187 com.liferay.portal.kernel.exception.SystemException { 188 return getService().getPersistedModel(primaryKeyObj); 189 } 190 191 /** 192 * Returns a range of all the layout prototypes. 193 * 194 * <p> 195 * 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. 196 * </p> 197 * 198 * @param start the lower bound of the range of layout prototypes 199 * @param end the upper bound of the range of layout prototypes (not inclusive) 200 * @return the range of layout prototypes 201 * @throws SystemException if a system exception occurred 202 */ 203 public static java.util.List<com.liferay.portal.model.LayoutPrototype> getLayoutPrototypes( 204 int start, int end) 205 throws com.liferay.portal.kernel.exception.SystemException { 206 return getService().getLayoutPrototypes(start, end); 207 } 208 209 /** 210 * Returns the number of layout prototypes. 211 * 212 * @return the number of layout prototypes 213 * @throws SystemException if a system exception occurred 214 */ 215 public static int getLayoutPrototypesCount() 216 throws com.liferay.portal.kernel.exception.SystemException { 217 return getService().getLayoutPrototypesCount(); 218 } 219 220 /** 221 * Updates the layout prototype in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 222 * 223 * @param layoutPrototype the layout prototype 224 * @return the layout prototype that was updated 225 * @throws SystemException if a system exception occurred 226 */ 227 public static com.liferay.portal.model.LayoutPrototype updateLayoutPrototype( 228 com.liferay.portal.model.LayoutPrototype layoutPrototype) 229 throws com.liferay.portal.kernel.exception.SystemException { 230 return getService().updateLayoutPrototype(layoutPrototype); 231 } 232 233 /** 234 * Updates the layout prototype in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 235 * 236 * @param layoutPrototype the layout prototype 237 * @param merge whether to merge the layout prototype with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation. 238 * @return the layout prototype that was updated 239 * @throws SystemException if a system exception occurred 240 */ 241 public static com.liferay.portal.model.LayoutPrototype updateLayoutPrototype( 242 com.liferay.portal.model.LayoutPrototype layoutPrototype, boolean merge) 243 throws com.liferay.portal.kernel.exception.SystemException { 244 return getService().updateLayoutPrototype(layoutPrototype, merge); 245 } 246 247 /** 248 * Returns the Spring bean ID for this bean. 249 * 250 * @return the Spring bean ID for this bean 251 */ 252 public static java.lang.String getBeanIdentifier() { 253 return getService().getBeanIdentifier(); 254 } 255 256 /** 257 * Sets the Spring bean ID for this bean. 258 * 259 * @param beanIdentifier the Spring bean ID for this bean 260 */ 261 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 262 getService().setBeanIdentifier(beanIdentifier); 263 } 264 265 public static com.liferay.portal.model.LayoutPrototype addLayoutPrototype( 266 long userId, long companyId, 267 java.util.Map<java.util.Locale, java.lang.String> nameMap, 268 java.lang.String description, boolean active) 269 throws com.liferay.portal.kernel.exception.PortalException, 270 com.liferay.portal.kernel.exception.SystemException { 271 return getService() 272 .addLayoutPrototype(userId, companyId, nameMap, description, 273 active); 274 } 275 276 public static com.liferay.portal.model.LayoutPrototype getLayoutPrototypeByUuid( 277 java.lang.String uuid) 278 throws com.liferay.portal.kernel.exception.PortalException, 279 com.liferay.portal.kernel.exception.SystemException { 280 return getService().getLayoutPrototypeByUuid(uuid); 281 } 282 283 public static java.util.List<com.liferay.portal.model.LayoutPrototype> search( 284 long companyId, java.lang.Boolean active, int start, int end, 285 com.liferay.portal.kernel.util.OrderByComparator obc) 286 throws com.liferay.portal.kernel.exception.SystemException { 287 return getService().search(companyId, active, start, end, obc); 288 } 289 290 public static int searchCount(long companyId, java.lang.Boolean active) 291 throws com.liferay.portal.kernel.exception.SystemException { 292 return getService().searchCount(companyId, active); 293 } 294 295 public static com.liferay.portal.model.LayoutPrototype updateLayoutPrototype( 296 long layoutPrototypeId, 297 java.util.Map<java.util.Locale, java.lang.String> nameMap, 298 java.lang.String description, boolean active) 299 throws com.liferay.portal.kernel.exception.PortalException, 300 com.liferay.portal.kernel.exception.SystemException { 301 return getService() 302 .updateLayoutPrototype(layoutPrototypeId, nameMap, 303 description, active); 304 } 305 306 public static LayoutPrototypeLocalService getService() { 307 if (_service == null) { 308 _service = (LayoutPrototypeLocalService)PortalBeanLocatorUtil.locate(LayoutPrototypeLocalService.class.getName()); 309 310 ReferenceRegistry.registerReference(LayoutPrototypeLocalServiceUtil.class, 311 "_service"); 312 MethodCache.remove(LayoutPrototypeLocalService.class); 313 } 314 315 return _service; 316 } 317 318 public void setService(LayoutPrototypeLocalService service) { 319 MethodCache.remove(LayoutPrototypeLocalService.class); 320 321 _service = service; 322 323 ReferenceRegistry.registerReference(LayoutPrototypeLocalServiceUtil.class, 324 "_service"); 325 MethodCache.remove(LayoutPrototypeLocalService.class); 326 } 327 328 private static LayoutPrototypeLocalService _service; 329 }