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