001 /** 002 * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved. 003 * 004 * The contents of this file are subject to the terms of the Liferay Enterprise 005 * Subscription License ("License"). You may not use this file except in 006 * compliance with the License. You can obtain a copy of the License by 007 * contacting Liferay, Inc. See the License for the specific language governing 008 * permissions and limitations under the License, including but not limited to 009 * distribution rights of the Software. 010 * 011 * 012 * 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 /** 164 * Returns the layout prototype with the primary key. 165 * 166 * @param layoutPrototypeId the primary key of the layout prototype 167 * @return the layout prototype 168 * @throws PortalException if a layout prototype with the primary key could not be found 169 * @throws SystemException if a system exception occurred 170 */ 171 public static com.liferay.portal.model.LayoutPrototype getLayoutPrototype( 172 long layoutPrototypeId) 173 throws com.liferay.portal.kernel.exception.PortalException, 174 com.liferay.portal.kernel.exception.SystemException { 175 return getService().getLayoutPrototype(layoutPrototypeId); 176 } 177 178 public static com.liferay.portal.model.PersistedModel getPersistedModel( 179 java.io.Serializable primaryKeyObj) 180 throws com.liferay.portal.kernel.exception.PortalException, 181 com.liferay.portal.kernel.exception.SystemException { 182 return getService().getPersistedModel(primaryKeyObj); 183 } 184 185 /** 186 * Returns a range of all the layout prototypes. 187 * 188 * <p> 189 * 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. 190 * </p> 191 * 192 * @param start the lower bound of the range of layout prototypes 193 * @param end the upper bound of the range of layout prototypes (not inclusive) 194 * @return the range of layout prototypes 195 * @throws SystemException if a system exception occurred 196 */ 197 public static java.util.List<com.liferay.portal.model.LayoutPrototype> getLayoutPrototypes( 198 int start, int end) 199 throws com.liferay.portal.kernel.exception.SystemException { 200 return getService().getLayoutPrototypes(start, end); 201 } 202 203 /** 204 * Returns the number of layout prototypes. 205 * 206 * @return the number of layout prototypes 207 * @throws SystemException if a system exception occurred 208 */ 209 public static int getLayoutPrototypesCount() 210 throws com.liferay.portal.kernel.exception.SystemException { 211 return getService().getLayoutPrototypesCount(); 212 } 213 214 /** 215 * Updates the layout prototype in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 216 * 217 * @param layoutPrototype the layout prototype 218 * @return the layout prototype that was updated 219 * @throws SystemException if a system exception occurred 220 */ 221 public static com.liferay.portal.model.LayoutPrototype updateLayoutPrototype( 222 com.liferay.portal.model.LayoutPrototype layoutPrototype) 223 throws com.liferay.portal.kernel.exception.SystemException { 224 return getService().updateLayoutPrototype(layoutPrototype); 225 } 226 227 /** 228 * Updates the layout prototype in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 229 * 230 * @param layoutPrototype the layout prototype 231 * @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. 232 * @return the layout prototype that was updated 233 * @throws SystemException if a system exception occurred 234 */ 235 public static com.liferay.portal.model.LayoutPrototype updateLayoutPrototype( 236 com.liferay.portal.model.LayoutPrototype layoutPrototype, boolean merge) 237 throws com.liferay.portal.kernel.exception.SystemException { 238 return getService().updateLayoutPrototype(layoutPrototype, merge); 239 } 240 241 /** 242 * Returns the Spring bean ID for this bean. 243 * 244 * @return the Spring bean ID for this bean 245 */ 246 public static java.lang.String getBeanIdentifier() { 247 return getService().getBeanIdentifier(); 248 } 249 250 /** 251 * Sets the Spring bean ID for this bean. 252 * 253 * @param beanIdentifier the Spring bean ID for this bean 254 */ 255 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 256 getService().setBeanIdentifier(beanIdentifier); 257 } 258 259 public static com.liferay.portal.model.LayoutPrototype addLayoutPrototype( 260 long userId, long companyId, 261 java.util.Map<java.util.Locale, java.lang.String> nameMap, 262 java.lang.String description, boolean active) 263 throws com.liferay.portal.kernel.exception.PortalException, 264 com.liferay.portal.kernel.exception.SystemException { 265 return getService() 266 .addLayoutPrototype(userId, companyId, nameMap, description, 267 active); 268 } 269 270 public static java.util.List<com.liferay.portal.model.LayoutPrototype> search( 271 long companyId, java.lang.Boolean active, int start, int end, 272 com.liferay.portal.kernel.util.OrderByComparator obc) 273 throws com.liferay.portal.kernel.exception.SystemException { 274 return getService().search(companyId, active, start, end, obc); 275 } 276 277 public static int searchCount(long companyId, java.lang.Boolean active) 278 throws com.liferay.portal.kernel.exception.SystemException { 279 return getService().searchCount(companyId, active); 280 } 281 282 public static com.liferay.portal.model.LayoutPrototype updateLayoutPrototype( 283 long layoutPrototypeId, 284 java.util.Map<java.util.Locale, java.lang.String> nameMap, 285 java.lang.String description, boolean active) 286 throws com.liferay.portal.kernel.exception.PortalException, 287 com.liferay.portal.kernel.exception.SystemException { 288 return getService() 289 .updateLayoutPrototype(layoutPrototypeId, nameMap, 290 description, active); 291 } 292 293 public static LayoutPrototypeLocalService getService() { 294 if (_service == null) { 295 _service = (LayoutPrototypeLocalService)PortalBeanLocatorUtil.locate(LayoutPrototypeLocalService.class.getName()); 296 297 ReferenceRegistry.registerReference(LayoutPrototypeLocalServiceUtil.class, 298 "_service"); 299 MethodCache.remove(LayoutPrototypeLocalService.class); 300 } 301 302 return _service; 303 } 304 305 public void setService(LayoutPrototypeLocalService service) { 306 MethodCache.remove(LayoutPrototypeLocalService.class); 307 308 _service = service; 309 310 ReferenceRegistry.registerReference(LayoutPrototypeLocalServiceUtil.class, 311 "_service"); 312 MethodCache.remove(LayoutPrototypeLocalService.class); 313 } 314 315 private static LayoutPrototypeLocalService _service; 316 }