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