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 LayoutSet. 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 LayoutSetLocalServiceUtil 034 * @see com.liferay.portal.service.base.LayoutSetLocalServiceBaseImpl 035 * @see com.liferay.portal.service.impl.LayoutSetLocalServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface LayoutSetLocalService extends BaseLocalService, 042 PersistedModelLocalService { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * Never modify or reference this interface directly. Always use {@link LayoutSetLocalServiceUtil} to access the layout set local service. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutSetLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 047 */ 048 049 /** 050 * Adds the layout set to the database. Also notifies the appropriate model listeners. 051 * 052 * @param layoutSet the layout set 053 * @return the layout set 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.LayoutSet addLayoutSet( 058 com.liferay.portal.model.LayoutSet layoutSet) 059 throws com.liferay.portal.kernel.exception.SystemException; 060 061 /** 062 * Creates a new layout set with the primary key. Does not add the layout set to the database. 063 * 064 * @param layoutSetId the primary key for the new layout set 065 * @return the new layout set 066 */ 067 public com.liferay.portal.model.LayoutSet createLayoutSet(long layoutSetId); 068 069 /** 070 * Deletes the layout set with the primary key from the database. Also notifies the appropriate model listeners. 071 * 072 * @param layoutSetId the primary key of the layout set 073 * @return the layout set that was removed 074 * @throws PortalException if a layout set with the primary key could not be found 075 * @throws SystemException if a system exception occurred 076 */ 077 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 078 public com.liferay.portal.model.LayoutSet deleteLayoutSet(long layoutSetId) 079 throws com.liferay.portal.kernel.exception.PortalException, 080 com.liferay.portal.kernel.exception.SystemException; 081 082 /** 083 * Deletes the layout set from the database. Also notifies the appropriate model listeners. 084 * 085 * @param layoutSet the layout set 086 * @return the layout set that was removed 087 * @throws SystemException if a system exception occurred 088 */ 089 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 090 public com.liferay.portal.model.LayoutSet deleteLayoutSet( 091 com.liferay.portal.model.LayoutSet layoutSet) 092 throws 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.LayoutSetModelImpl}. 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.LayoutSetModelImpl}. 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.LayoutSet fetchLayoutSet(long layoutSetId) 173 throws com.liferay.portal.kernel.exception.SystemException; 174 175 /** 176 * Returns the layout set with the primary key. 177 * 178 * @param layoutSetId the primary key of the layout set 179 * @return the layout set 180 * @throws PortalException if a layout set with the primary key could not be found 181 * @throws SystemException if a system exception occurred 182 */ 183 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 184 public com.liferay.portal.model.LayoutSet getLayoutSet(long layoutSetId) 185 throws com.liferay.portal.kernel.exception.PortalException, 186 com.liferay.portal.kernel.exception.SystemException; 187 188 @Override 189 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 190 public com.liferay.portal.model.PersistedModel getPersistedModel( 191 java.io.Serializable primaryKeyObj) 192 throws com.liferay.portal.kernel.exception.PortalException, 193 com.liferay.portal.kernel.exception.SystemException; 194 195 /** 196 * Returns a range of all the layout sets. 197 * 198 * <p> 199 * 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.LayoutSetModelImpl}. 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. 200 * </p> 201 * 202 * @param start the lower bound of the range of layout sets 203 * @param end the upper bound of the range of layout sets (not inclusive) 204 * @return the range of layout sets 205 * @throws SystemException if a system exception occurred 206 */ 207 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 208 public java.util.List<com.liferay.portal.model.LayoutSet> getLayoutSets( 209 int start, int end) 210 throws com.liferay.portal.kernel.exception.SystemException; 211 212 /** 213 * Returns the number of layout sets. 214 * 215 * @return the number of layout sets 216 * @throws SystemException if a system exception occurred 217 */ 218 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 219 public int getLayoutSetsCount() 220 throws com.liferay.portal.kernel.exception.SystemException; 221 222 /** 223 * Updates the layout set in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 224 * 225 * @param layoutSet the layout set 226 * @return the layout set that was updated 227 * @throws SystemException if a system exception occurred 228 */ 229 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 230 public com.liferay.portal.model.LayoutSet updateLayoutSet( 231 com.liferay.portal.model.LayoutSet layoutSet) 232 throws com.liferay.portal.kernel.exception.SystemException; 233 234 /** 235 * Returns the Spring bean ID for this bean. 236 * 237 * @return the Spring bean ID for this bean 238 */ 239 public java.lang.String getBeanIdentifier(); 240 241 /** 242 * Sets the Spring bean ID for this bean. 243 * 244 * @param beanIdentifier the Spring bean ID for this bean 245 */ 246 public void setBeanIdentifier(java.lang.String beanIdentifier); 247 248 public com.liferay.portal.model.LayoutSet addLayoutSet(long groupId, 249 boolean privateLayout) 250 throws com.liferay.portal.kernel.exception.PortalException, 251 com.liferay.portal.kernel.exception.SystemException; 252 253 public void deleteLayoutSet(long groupId, boolean privateLayout, 254 com.liferay.portal.service.ServiceContext serviceContext) 255 throws com.liferay.portal.kernel.exception.PortalException, 256 com.liferay.portal.kernel.exception.SystemException; 257 258 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 259 public com.liferay.portal.model.LayoutSet fetchLayoutSet( 260 java.lang.String virtualHostname) 261 throws com.liferay.portal.kernel.exception.SystemException; 262 263 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 264 public com.liferay.portal.model.LayoutSet getLayoutSet(long groupId, 265 boolean privateLayout) 266 throws com.liferay.portal.kernel.exception.PortalException, 267 com.liferay.portal.kernel.exception.SystemException; 268 269 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 270 public com.liferay.portal.model.LayoutSet getLayoutSet( 271 java.lang.String virtualHostname) 272 throws com.liferay.portal.kernel.exception.PortalException, 273 com.liferay.portal.kernel.exception.SystemException; 274 275 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 276 public java.util.List<com.liferay.portal.model.LayoutSet> getLayoutSetsByLayoutSetPrototypeUuid( 277 java.lang.String layoutSetPrototypeUuid) 278 throws com.liferay.portal.kernel.exception.SystemException; 279 280 /** 281 * Updates the state of the layout set prototype link. 282 * 283 * <p> 284 * This method can disable the layout set prototype's link by setting 285 * <code>layoutSetPrototypeLinkEnabled</code> to <code>false</code>. 286 * However, this method can only enable the layout set prototype's link if 287 * the layout set prototype's current uuid is not <code>null</code>. Setting 288 * the <code>layoutSetPrototypeLinkEnabled</code> to <code>true</code> when 289 * the layout set prototype's current uuid is <code>null</code> will have no 290 * effect. 291 * </p> 292 * 293 * @param groupId the primary key of the group 294 * @param privateLayout whether the layout set is private to the group 295 * @param layoutSetPrototypeLinkEnabled whether the layout set 296 prototype is link enabled 297 * @throws PortalException if a portal exception occurred 298 * @throws SystemException if a system exception occurred 299 * @deprecated As of 6.1.0, replaced by {@link 300 #updateLayoutSetPrototypeLinkEnabled(long, boolean, boolean, 301 String)} 302 */ 303 public void updateLayoutSetPrototypeLinkEnabled(long groupId, 304 boolean privateLayout, boolean layoutSetPrototypeLinkEnabled) 305 throws com.liferay.portal.kernel.exception.PortalException, 306 com.liferay.portal.kernel.exception.SystemException; 307 308 /** 309 * Updates the state of the layout set prototype link. 310 * 311 * @param groupId the primary key of the group 312 * @param privateLayout whether the layout set is private to the group 313 * @param layoutSetPrototypeLinkEnabled whether the layout set prototype is 314 link enabled 315 * @param layoutSetPrototypeUuid the uuid of the layout set prototype to 316 link with 317 * @throws PortalException if a portal exception occurred 318 * @throws SystemException if a system exception occurred 319 */ 320 public void updateLayoutSetPrototypeLinkEnabled(long groupId, 321 boolean privateLayout, boolean layoutSetPrototypeLinkEnabled, 322 java.lang.String layoutSetPrototypeUuid) 323 throws com.liferay.portal.kernel.exception.PortalException, 324 com.liferay.portal.kernel.exception.SystemException; 325 326 public com.liferay.portal.model.LayoutSet updateLogo(long groupId, 327 boolean privateLayout, boolean logo, byte[] bytes) 328 throws com.liferay.portal.kernel.exception.PortalException, 329 com.liferay.portal.kernel.exception.SystemException; 330 331 public com.liferay.portal.model.LayoutSet updateLogo(long groupId, 332 boolean privateLayout, boolean logo, java.io.File file) 333 throws com.liferay.portal.kernel.exception.PortalException, 334 com.liferay.portal.kernel.exception.SystemException; 335 336 public com.liferay.portal.model.LayoutSet updateLogo(long groupId, 337 boolean privateLayout, boolean logo, java.io.InputStream is) 338 throws com.liferay.portal.kernel.exception.PortalException, 339 com.liferay.portal.kernel.exception.SystemException; 340 341 public com.liferay.portal.model.LayoutSet updateLogo(long groupId, 342 boolean privateLayout, boolean logo, java.io.InputStream is, 343 boolean cleanUpStream) 344 throws com.liferay.portal.kernel.exception.PortalException, 345 com.liferay.portal.kernel.exception.SystemException; 346 347 public com.liferay.portal.model.LayoutSet updateLookAndFeel(long groupId, 348 boolean privateLayout, java.lang.String themeId, 349 java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme) 350 throws com.liferay.portal.kernel.exception.PortalException, 351 com.liferay.portal.kernel.exception.SystemException; 352 353 public void updateLookAndFeel(long groupId, java.lang.String themeId, 354 java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme) 355 throws com.liferay.portal.kernel.exception.PortalException, 356 com.liferay.portal.kernel.exception.SystemException; 357 358 public com.liferay.portal.model.LayoutSet updatePageCount(long groupId, 359 boolean privateLayout) 360 throws com.liferay.portal.kernel.exception.PortalException, 361 com.liferay.portal.kernel.exception.SystemException; 362 363 public com.liferay.portal.model.LayoutSet updateSettings(long groupId, 364 boolean privateLayout, java.lang.String settings) 365 throws com.liferay.portal.kernel.exception.PortalException, 366 com.liferay.portal.kernel.exception.SystemException; 367 368 public com.liferay.portal.model.LayoutSet updateVirtualHost(long groupId, 369 boolean privateLayout, java.lang.String virtualHostname) 370 throws com.liferay.portal.kernel.exception.PortalException, 371 com.liferay.portal.kernel.exception.SystemException; 372 }