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 LayoutSetPrototype. 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 LayoutSetPrototypeLocalServiceUtil 034 * @see com.liferay.portal.service.base.LayoutSetPrototypeLocalServiceBaseImpl 035 * @see com.liferay.portal.service.impl.LayoutSetPrototypeLocalServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface LayoutSetPrototypeLocalService extends BaseLocalService, 042 PersistedModelLocalService { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * Never modify or reference this interface directly. Always use {@link LayoutSetPrototypeLocalServiceUtil} to access the layout set prototype local service. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutSetPrototypeLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 047 */ 048 049 /** 050 * Adds the layout set prototype to the database. Also notifies the appropriate model listeners. 051 * 052 * @param layoutSetPrototype the layout set prototype 053 * @return the layout set 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.LayoutSetPrototype addLayoutSetPrototype( 058 com.liferay.portal.model.LayoutSetPrototype layoutSetPrototype) 059 throws com.liferay.portal.kernel.exception.SystemException; 060 061 /** 062 * Creates a new layout set prototype with the primary key. Does not add the layout set prototype to the database. 063 * 064 * @param layoutSetPrototypeId the primary key for the new layout set prototype 065 * @return the new layout set prototype 066 */ 067 public com.liferay.portal.model.LayoutSetPrototype createLayoutSetPrototype( 068 long layoutSetPrototypeId); 069 070 /** 071 * Deletes the layout set prototype with the primary key from the database. Also notifies the appropriate model listeners. 072 * 073 * @param layoutSetPrototypeId the primary key of the layout set prototype 074 * @return the layout set prototype that was removed 075 * @throws PortalException if a layout set 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.LayoutSetPrototype deleteLayoutSetPrototype( 080 long layoutSetPrototypeId) 081 throws com.liferay.portal.kernel.exception.PortalException, 082 com.liferay.portal.kernel.exception.SystemException; 083 084 /** 085 * Deletes the layout set prototype from the database. Also notifies the appropriate model listeners. 086 * 087 * @param layoutSetPrototype the layout set prototype 088 * @return the layout set 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.LayoutSetPrototype deleteLayoutSetPrototype( 094 com.liferay.portal.model.LayoutSetPrototype layoutSetPrototype) 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.LayoutSetPrototypeModelImpl}. 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.LayoutSetPrototypeModelImpl}. 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.LayoutSetPrototype fetchLayoutSetPrototype( 177 long layoutSetPrototypeId) 178 throws com.liferay.portal.kernel.exception.SystemException; 179 180 /** 181 * Returns the layout set prototype with the matching UUID and company. 182 * 183 * @param uuid the layout set prototype's UUID 184 * @param companyId the primary key of the company 185 * @return the matching layout set prototype, or <code>null</code> if a matching layout set 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.LayoutSetPrototype fetchLayoutSetPrototypeByUuidAndCompanyId( 190 java.lang.String uuid, long companyId) 191 throws com.liferay.portal.kernel.exception.SystemException; 192 193 /** 194 * Returns the layout set prototype with the primary key. 195 * 196 * @param layoutSetPrototypeId the primary key of the layout set prototype 197 * @return the layout set prototype 198 * @throws PortalException if a layout set 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.LayoutSetPrototype getLayoutSetPrototype( 203 long layoutSetPrototypeId) 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 set prototype with the matching UUID and company. 216 * 217 * @param uuid the layout set prototype's UUID 218 * @param companyId the primary key of the company 219 * @return the matching layout set prototype 220 * @throws PortalException if a matching layout set 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.LayoutSetPrototype getLayoutSetPrototypeByUuidAndCompanyId( 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 set 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.LayoutSetPrototypeModelImpl}. 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 set prototypes 237 * @param end the upper bound of the range of layout set prototypes (not inclusive) 238 * @return the range of layout set 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.LayoutSetPrototype> getLayoutSetPrototypes( 243 int start, int end) 244 throws com.liferay.portal.kernel.exception.SystemException; 245 246 /** 247 * Returns the number of layout set prototypes. 248 * 249 * @return the number of layout set prototypes 250 * @throws SystemException if a system exception occurred 251 */ 252 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 253 public int getLayoutSetPrototypesCount() 254 throws com.liferay.portal.kernel.exception.SystemException; 255 256 /** 257 * Updates the layout set prototype in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 258 * 259 * @param layoutSetPrototype the layout set prototype 260 * @return the layout set 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.LayoutSetPrototype updateLayoutSetPrototype( 265 com.liferay.portal.model.LayoutSetPrototype layoutSetPrototype) 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 public com.liferay.portal.model.LayoutSetPrototype addLayoutSetPrototype( 283 long userId, long companyId, 284 java.util.Map<java.util.Locale, java.lang.String> nameMap, 285 java.lang.String description, boolean active, 286 boolean layoutsUpdateable, 287 com.liferay.portal.service.ServiceContext serviceContext) 288 throws com.liferay.portal.kernel.exception.PortalException, 289 com.liferay.portal.kernel.exception.SystemException; 290 291 public void deleteLayoutSetPrototypes() 292 throws com.liferay.portal.kernel.exception.PortalException, 293 com.liferay.portal.kernel.exception.SystemException; 294 295 public void deleteNondefaultLayoutSetPrototypes(long companyId) 296 throws com.liferay.portal.kernel.exception.PortalException, 297 com.liferay.portal.kernel.exception.SystemException; 298 299 /** 300 * @deprecated As of 6.2.0, replaced by {@link 301 #getLayoutSetPrototypeByUuidAndCompanyId(String, long)} 302 */ 303 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 304 public com.liferay.portal.model.LayoutSetPrototype getLayoutSetPrototypeByUuid( 305 java.lang.String uuid) 306 throws com.liferay.portal.kernel.exception.PortalException, 307 com.liferay.portal.kernel.exception.SystemException; 308 309 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 310 public java.util.List<com.liferay.portal.model.LayoutSetPrototype> getLayoutSetPrototypes( 311 long companyId) 312 throws com.liferay.portal.kernel.exception.SystemException; 313 314 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 315 public java.util.List<com.liferay.portal.model.LayoutSetPrototype> search( 316 long companyId, java.lang.Boolean active, int start, int end, 317 com.liferay.portal.kernel.util.OrderByComparator obc) 318 throws com.liferay.portal.kernel.exception.SystemException; 319 320 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 321 public int searchCount(long companyId, java.lang.Boolean active) 322 throws com.liferay.portal.kernel.exception.SystemException; 323 324 public com.liferay.portal.model.LayoutSetPrototype updateLayoutSetPrototype( 325 long layoutSetPrototypeId, 326 java.util.Map<java.util.Locale, java.lang.String> nameMap, 327 java.lang.String description, boolean active, 328 boolean layoutsUpdateable, 329 com.liferay.portal.service.ServiceContext serviceContext) 330 throws com.liferay.portal.kernel.exception.PortalException, 331 com.liferay.portal.kernel.exception.SystemException; 332 333 public com.liferay.portal.model.LayoutSetPrototype updateLayoutSetPrototype( 334 long layoutSetPrototypeId, java.lang.String settings) 335 throws com.liferay.portal.kernel.exception.PortalException, 336 com.liferay.portal.kernel.exception.SystemException; 337 }