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.portal.service; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.exception.PortalException; 020 import com.liferay.portal.kernel.exception.SystemException; 021 import com.liferay.portal.kernel.search.IndexableType; 022 import com.liferay.portal.kernel.transaction.Isolation; 023 import com.liferay.portal.kernel.transaction.Propagation; 024 import com.liferay.portal.kernel.transaction.Transactional; 025 026 /** 027 * Provides the local service interface for LayoutPrototype. Methods of this 028 * service will not have security checks based on the propagated JAAS 029 * credentials because this service can only be accessed from within the same 030 * VM. 031 * 032 * @author Brian Wing Shun Chan 033 * @see LayoutPrototypeLocalServiceUtil 034 * @see com.liferay.portal.service.base.LayoutPrototypeLocalServiceBaseImpl 035 * @see com.liferay.portal.service.impl.LayoutPrototypeLocalServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface LayoutPrototypeLocalService extends BaseLocalService, 042 PersistedModelLocalService { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * Never modify or reference this interface directly. Always use {@link LayoutPrototypeLocalServiceUtil} to access the layout prototype local service. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutPrototypeLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 047 */ 048 049 /** 050 * Adds the layout prototype to the database. Also notifies the appropriate model listeners. 051 * 052 * @param layoutPrototype the layout prototype 053 * @return the layout prototype that was added 054 * @throws SystemException if a system exception occurred 055 */ 056 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 057 public com.liferay.portal.model.LayoutPrototype addLayoutPrototype( 058 com.liferay.portal.model.LayoutPrototype layoutPrototype) 059 throws com.liferay.portal.kernel.exception.SystemException; 060 061 /** 062 * Creates a new layout prototype with the primary key. Does not add the layout prototype to the database. 063 * 064 * @param layoutPrototypeId the primary key for the new layout prototype 065 * @return the new layout prototype 066 */ 067 public com.liferay.portal.model.LayoutPrototype createLayoutPrototype( 068 long layoutPrototypeId); 069 070 /** 071 * Deletes the layout prototype with the primary key from the database. Also notifies the appropriate model listeners. 072 * 073 * @param layoutPrototypeId the primary key of the layout prototype 074 * @return the layout prototype that was removed 075 * @throws PortalException if a layout prototype with the primary key could not be found 076 * @throws SystemException if a system exception occurred 077 */ 078 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 079 public com.liferay.portal.model.LayoutPrototype deleteLayoutPrototype( 080 long layoutPrototypeId) 081 throws com.liferay.portal.kernel.exception.PortalException, 082 com.liferay.portal.kernel.exception.SystemException; 083 084 /** 085 * Deletes the layout prototype from the database. Also notifies the appropriate model listeners. 086 * 087 * @param layoutPrototype the layout prototype 088 * @return the layout prototype that was removed 089 * @throws PortalException 090 * @throws SystemException if a system exception occurred 091 */ 092 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 093 public com.liferay.portal.model.LayoutPrototype deleteLayoutPrototype( 094 com.liferay.portal.model.LayoutPrototype layoutPrototype) 095 throws com.liferay.portal.kernel.exception.PortalException, 096 com.liferay.portal.kernel.exception.SystemException; 097 098 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 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 java.util.List dynamicQuery( 109 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 110 throws com.liferay.portal.kernel.exception.SystemException; 111 112 /** 113 * Performs a dynamic query on the database and returns a range of the matching rows. 114 * 115 * <p> 116 * 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.portal.model.impl.LayoutPrototypeModelImpl}. 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. 117 * </p> 118 * 119 * @param dynamicQuery the dynamic query 120 * @param start the lower bound of the range of model instances 121 * @param end the upper bound of the range of model instances (not inclusive) 122 * @return the range of matching rows 123 * @throws SystemException if a system exception occurred 124 */ 125 @SuppressWarnings("rawtypes") 126 public java.util.List dynamicQuery( 127 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 128 int end) throws com.liferay.portal.kernel.exception.SystemException; 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.portal.model.impl.LayoutPrototypeModelImpl}. 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 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 151 /** 152 * Returns the number of rows that match the dynamic query. 153 * 154 * @param dynamicQuery the dynamic query 155 * @return the number of rows that match the dynamic query 156 * @throws SystemException if a system exception occurred 157 */ 158 public long dynamicQueryCount( 159 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 160 throws com.liferay.portal.kernel.exception.SystemException; 161 162 /** 163 * Returns the number of rows that match the dynamic query. 164 * 165 * @param dynamicQuery the dynamic query 166 * @param projection the projection to apply to the query 167 * @return the number of rows that match the dynamic query 168 * @throws SystemException if a system exception occurred 169 */ 170 public long dynamicQueryCount( 171 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 172 com.liferay.portal.kernel.dao.orm.Projection projection) 173 throws com.liferay.portal.kernel.exception.SystemException; 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public com.liferay.portal.model.LayoutPrototype fetchLayoutPrototype( 177 long layoutPrototypeId) 178 throws com.liferay.portal.kernel.exception.SystemException; 179 180 /** 181 * Returns the layout prototype with the matching UUID and company. 182 * 183 * @param uuid the layout prototype's UUID 184 * @param companyId the primary key of the company 185 * @return the matching layout prototype, or <code>null</code> if a matching layout prototype could not be found 186 * @throws SystemException if a system exception occurred 187 */ 188 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 189 public com.liferay.portal.model.LayoutPrototype fetchLayoutPrototypeByUuidAndCompanyId( 190 java.lang.String uuid, long companyId) 191 throws com.liferay.portal.kernel.exception.SystemException; 192 193 /** 194 * Returns the layout prototype with the primary key. 195 * 196 * @param layoutPrototypeId the primary key of the layout prototype 197 * @return the layout prototype 198 * @throws PortalException if a layout prototype with the primary key could not be found 199 * @throws SystemException if a system exception occurred 200 */ 201 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 202 public com.liferay.portal.model.LayoutPrototype getLayoutPrototype( 203 long layoutPrototypeId) 204 throws com.liferay.portal.kernel.exception.PortalException, 205 com.liferay.portal.kernel.exception.SystemException; 206 207 @Override 208 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 209 public com.liferay.portal.model.PersistedModel getPersistedModel( 210 java.io.Serializable primaryKeyObj) 211 throws com.liferay.portal.kernel.exception.PortalException, 212 com.liferay.portal.kernel.exception.SystemException; 213 214 /** 215 * Returns the layout prototype with the matching UUID and company. 216 * 217 * @param uuid the layout prototype's UUID 218 * @param companyId the primary key of the company 219 * @return the matching layout prototype 220 * @throws PortalException if a matching layout prototype could not be found 221 * @throws SystemException if a system exception occurred 222 */ 223 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 224 public com.liferay.portal.model.LayoutPrototype getLayoutPrototypeByUuidAndCompanyId( 225 java.lang.String uuid, long companyId) 226 throws com.liferay.portal.kernel.exception.PortalException, 227 com.liferay.portal.kernel.exception.SystemException; 228 229 /** 230 * Returns a range of all the layout prototypes. 231 * 232 * <p> 233 * 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.portal.model.impl.LayoutPrototypeModelImpl}. 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. 234 * </p> 235 * 236 * @param start the lower bound of the range of layout prototypes 237 * @param end the upper bound of the range of layout prototypes (not inclusive) 238 * @return the range of layout prototypes 239 * @throws SystemException if a system exception occurred 240 */ 241 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 242 public java.util.List<com.liferay.portal.model.LayoutPrototype> getLayoutPrototypes( 243 int start, int end) 244 throws com.liferay.portal.kernel.exception.SystemException; 245 246 /** 247 * Returns the number of layout prototypes. 248 * 249 * @return the number of layout prototypes 250 * @throws SystemException if a system exception occurred 251 */ 252 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 253 public int getLayoutPrototypesCount() 254 throws com.liferay.portal.kernel.exception.SystemException; 255 256 /** 257 * Updates the layout prototype in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 258 * 259 * @param layoutPrototype the layout prototype 260 * @return the layout prototype that was updated 261 * @throws SystemException if a system exception occurred 262 */ 263 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 264 public com.liferay.portal.model.LayoutPrototype updateLayoutPrototype( 265 com.liferay.portal.model.LayoutPrototype layoutPrototype) 266 throws com.liferay.portal.kernel.exception.SystemException; 267 268 /** 269 * Returns the Spring bean ID for this bean. 270 * 271 * @return the Spring bean ID for this bean 272 */ 273 public java.lang.String getBeanIdentifier(); 274 275 /** 276 * Sets the Spring bean ID for this bean. 277 * 278 * @param beanIdentifier the Spring bean ID for this bean 279 */ 280 public void setBeanIdentifier(java.lang.String beanIdentifier); 281 282 /** 283 * @deprecated As of 6.2.0, replaced by {@link #addLayoutPrototype(long, 284 long, Map, String, boolean, ServiceContext)} 285 */ 286 public com.liferay.portal.model.LayoutPrototype addLayoutPrototype( 287 long userId, long companyId, 288 java.util.Map<java.util.Locale, java.lang.String> nameMap, 289 java.lang.String description, boolean active) 290 throws com.liferay.portal.kernel.exception.PortalException, 291 com.liferay.portal.kernel.exception.SystemException; 292 293 public com.liferay.portal.model.LayoutPrototype addLayoutPrototype( 294 long userId, long companyId, 295 java.util.Map<java.util.Locale, java.lang.String> nameMap, 296 java.lang.String description, boolean active, 297 com.liferay.portal.service.ServiceContext serviceContext) 298 throws com.liferay.portal.kernel.exception.PortalException, 299 com.liferay.portal.kernel.exception.SystemException; 300 301 public void deleteNondefaultLayoutPrototypes(long companyId) 302 throws com.liferay.portal.kernel.exception.PortalException, 303 com.liferay.portal.kernel.exception.SystemException; 304 305 /** 306 * @deprecated As of 6.2.0, replaced by {@link 307 #getLayoutPrototypeByUuidAndCompanyId(String, long)} 308 */ 309 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 310 public com.liferay.portal.model.LayoutPrototype getLayoutPrototypeByUuid( 311 java.lang.String uuid) 312 throws com.liferay.portal.kernel.exception.PortalException, 313 com.liferay.portal.kernel.exception.SystemException; 314 315 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 316 public java.util.List<com.liferay.portal.model.LayoutPrototype> search( 317 long companyId, java.lang.Boolean active, int start, int end, 318 com.liferay.portal.kernel.util.OrderByComparator obc) 319 throws com.liferay.portal.kernel.exception.SystemException; 320 321 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 322 public int searchCount(long companyId, java.lang.Boolean active) 323 throws com.liferay.portal.kernel.exception.SystemException; 324 325 /** 326 * @deprecated As of 6.2.0, replaced by {@link #updateLayoutPrototype(long, 327 Map, String, boolean, ServiceContext)} 328 */ 329 public com.liferay.portal.model.LayoutPrototype updateLayoutPrototype( 330 long layoutPrototypeId, 331 java.util.Map<java.util.Locale, java.lang.String> nameMap, 332 java.lang.String description, boolean active) 333 throws com.liferay.portal.kernel.exception.PortalException, 334 com.liferay.portal.kernel.exception.SystemException; 335 336 public com.liferay.portal.model.LayoutPrototype updateLayoutPrototype( 337 long layoutPrototypeId, 338 java.util.Map<java.util.Locale, java.lang.String> nameMap, 339 java.lang.String description, boolean active, 340 com.liferay.portal.service.ServiceContext serviceContext) 341 throws com.liferay.portal.kernel.exception.PortalException, 342 com.liferay.portal.kernel.exception.SystemException; 343 }