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 * The interface for the layout set local service. 025 * 026 * <p> 027 * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM. 028 * </p> 029 * 030 * @author Brian Wing Shun Chan 031 * @see LayoutSetLocalServiceUtil 032 * @see com.liferay.portal.service.base.LayoutSetLocalServiceBaseImpl 033 * @see com.liferay.portal.service.impl.LayoutSetLocalServiceImpl 034 * @generated 035 */ 036 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 037 PortalException.class, SystemException.class}) 038 public interface LayoutSetLocalService extends BaseLocalService, 039 PersistedModelLocalService { 040 /* 041 * NOTE FOR DEVELOPERS: 042 * 043 * 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. 044 */ 045 046 /** 047 * Adds the layout set to the database. Also notifies the appropriate model listeners. 048 * 049 * @param layoutSet the layout set 050 * @return the layout set that was added 051 * @throws SystemException if a system exception occurred 052 */ 053 public com.liferay.portal.model.LayoutSet addLayoutSet( 054 com.liferay.portal.model.LayoutSet layoutSet) 055 throws com.liferay.portal.kernel.exception.SystemException; 056 057 /** 058 * Creates a new layout set with the primary key. Does not add the layout set to the database. 059 * 060 * @param layoutSetId the primary key for the new layout set 061 * @return the new layout set 062 */ 063 public com.liferay.portal.model.LayoutSet createLayoutSet(long layoutSetId); 064 065 /** 066 * Deletes the layout set with the primary key from the database. Also notifies the appropriate model listeners. 067 * 068 * @param layoutSetId the primary key of the layout set 069 * @return the layout set that was removed 070 * @throws PortalException if a layout set with the primary key could not be found 071 * @throws SystemException if a system exception occurred 072 */ 073 public com.liferay.portal.model.LayoutSet deleteLayoutSet(long layoutSetId) 074 throws com.liferay.portal.kernel.exception.PortalException, 075 com.liferay.portal.kernel.exception.SystemException; 076 077 /** 078 * Deletes the layout set from the database. Also notifies the appropriate model listeners. 079 * 080 * @param layoutSet the layout set 081 * @return the layout set that was removed 082 * @throws SystemException if a system exception occurred 083 */ 084 public com.liferay.portal.model.LayoutSet deleteLayoutSet( 085 com.liferay.portal.model.LayoutSet layoutSet) 086 throws com.liferay.portal.kernel.exception.SystemException; 087 088 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 089 090 /** 091 * Performs a dynamic query on the database and returns the matching rows. 092 * 093 * @param dynamicQuery the dynamic query 094 * @return the matching rows 095 * @throws SystemException if a system exception occurred 096 */ 097 @SuppressWarnings("rawtypes") 098 public java.util.List dynamicQuery( 099 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 100 throws com.liferay.portal.kernel.exception.SystemException; 101 102 /** 103 * Performs a dynamic query on the database and returns a range of the matching rows. 104 * 105 * <p> 106 * 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. 107 * </p> 108 * 109 * @param dynamicQuery the dynamic query 110 * @param start the lower bound of the range of model instances 111 * @param end the upper bound of the range of model instances (not inclusive) 112 * @return the range of matching rows 113 * @throws SystemException if a system exception occurred 114 */ 115 @SuppressWarnings("rawtypes") 116 public java.util.List dynamicQuery( 117 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 118 int end) throws com.liferay.portal.kernel.exception.SystemException; 119 120 /** 121 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 122 * 123 * <p> 124 * 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. 125 * </p> 126 * 127 * @param dynamicQuery the dynamic query 128 * @param start the lower bound of the range of model instances 129 * @param end the upper bound of the range of model instances (not inclusive) 130 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 131 * @return the ordered range of matching rows 132 * @throws SystemException if a system exception occurred 133 */ 134 @SuppressWarnings("rawtypes") 135 public java.util.List dynamicQuery( 136 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 137 int end, 138 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 139 throws com.liferay.portal.kernel.exception.SystemException; 140 141 /** 142 * Returns the number of rows that match the dynamic query. 143 * 144 * @param dynamicQuery the dynamic query 145 * @return the number of rows that match the dynamic query 146 * @throws SystemException if a system exception occurred 147 */ 148 public long dynamicQueryCount( 149 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 150 throws com.liferay.portal.kernel.exception.SystemException; 151 152 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 153 public com.liferay.portal.model.LayoutSet fetchLayoutSet(long layoutSetId) 154 throws com.liferay.portal.kernel.exception.SystemException; 155 156 /** 157 * Returns the layout set with the primary key. 158 * 159 * @param layoutSetId the primary key of the layout set 160 * @return the layout set 161 * @throws PortalException if a layout set with the primary key could not be found 162 * @throws SystemException if a system exception occurred 163 */ 164 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 165 public com.liferay.portal.model.LayoutSet getLayoutSet(long layoutSetId) 166 throws com.liferay.portal.kernel.exception.PortalException, 167 com.liferay.portal.kernel.exception.SystemException; 168 169 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 170 public com.liferay.portal.model.PersistedModel getPersistedModel( 171 java.io.Serializable primaryKeyObj) 172 throws com.liferay.portal.kernel.exception.PortalException, 173 com.liferay.portal.kernel.exception.SystemException; 174 175 /** 176 * Returns a range of all the layout sets. 177 * 178 * <p> 179 * 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. 180 * </p> 181 * 182 * @param start the lower bound of the range of layout sets 183 * @param end the upper bound of the range of layout sets (not inclusive) 184 * @return the range of layout sets 185 * @throws SystemException if a system exception occurred 186 */ 187 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 188 public java.util.List<com.liferay.portal.model.LayoutSet> getLayoutSets( 189 int start, int end) 190 throws com.liferay.portal.kernel.exception.SystemException; 191 192 /** 193 * Returns the number of layout sets. 194 * 195 * @return the number of layout sets 196 * @throws SystemException if a system exception occurred 197 */ 198 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 199 public int getLayoutSetsCount() 200 throws com.liferay.portal.kernel.exception.SystemException; 201 202 /** 203 * Updates the layout set in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 204 * 205 * @param layoutSet the layout set 206 * @return the layout set that was updated 207 * @throws SystemException if a system exception occurred 208 */ 209 public com.liferay.portal.model.LayoutSet updateLayoutSet( 210 com.liferay.portal.model.LayoutSet layoutSet) 211 throws com.liferay.portal.kernel.exception.SystemException; 212 213 /** 214 * Updates the layout set in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 215 * 216 * @param layoutSet the layout set 217 * @param merge whether to merge the layout set with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation. 218 * @return the layout set that was updated 219 * @throws SystemException if a system exception occurred 220 */ 221 public com.liferay.portal.model.LayoutSet updateLayoutSet( 222 com.liferay.portal.model.LayoutSet layoutSet, boolean merge) 223 throws com.liferay.portal.kernel.exception.SystemException; 224 225 /** 226 * Returns the Spring bean ID for this bean. 227 * 228 * @return the Spring bean ID for this bean 229 */ 230 public java.lang.String getBeanIdentifier(); 231 232 /** 233 * Sets the Spring bean ID for this bean. 234 * 235 * @param beanIdentifier the Spring bean ID for this bean 236 */ 237 public void setBeanIdentifier(java.lang.String beanIdentifier); 238 239 public com.liferay.portal.model.LayoutSet addLayoutSet(long groupId, 240 boolean privateLayout) 241 throws com.liferay.portal.kernel.exception.PortalException, 242 com.liferay.portal.kernel.exception.SystemException; 243 244 public void deleteLayoutSet(long groupId, boolean privateLayout, 245 com.liferay.portal.service.ServiceContext serviceContext) 246 throws com.liferay.portal.kernel.exception.PortalException, 247 com.liferay.portal.kernel.exception.SystemException; 248 249 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 250 public com.liferay.portal.model.LayoutSet fetchLayoutSet( 251 java.lang.String virtualHostname) 252 throws com.liferay.portal.kernel.exception.SystemException; 253 254 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 255 public com.liferay.portal.model.LayoutSet getLayoutSet(long groupId, 256 boolean privateLayout) 257 throws com.liferay.portal.kernel.exception.PortalException, 258 com.liferay.portal.kernel.exception.SystemException; 259 260 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 261 public com.liferay.portal.model.LayoutSet getLayoutSet( 262 java.lang.String virtualHostname) 263 throws com.liferay.portal.kernel.exception.PortalException, 264 com.liferay.portal.kernel.exception.SystemException; 265 266 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 267 public java.util.List<com.liferay.portal.model.LayoutSet> getLayoutSetsByLayoutSetPrototypeUuid( 268 java.lang.String layoutSetPrototypeUuid) 269 throws com.liferay.portal.kernel.exception.SystemException; 270 271 /** 272 * Updates the state of the layout set prototype link. 273 * 274 * <p> 275 * This method can disable the layout set prototype's link by setting 276 * <code>layoutSetPrototypeLinkEnabled</code> to <code>false</code>. 277 * However, this method can only enable the layout set prototype's link if 278 * the layout set prototype's current uuid is not <code>null</code>. Setting 279 * the <code>layoutSetPrototypeLinkEnabled</code> to <code>true</code> when 280 * the layout set prototype's current uuid is <code>null</code> will have no 281 * effect. 282 * </p> 283 * 284 * @param groupId the primary key of the group 285 * @param privateLayout whether the layout set is private to the group 286 * @param layoutSetPrototypeLinkEnabled whether the layout set 287 prototype is link enabled 288 * @throws PortalException if a portal exception occurred 289 * @throws SystemException if a system exception occurred 290 * @deprecated As of 6.1.0, replaced by {@link 291 #updateLayoutSetPrototypeLinkEnabled(long, boolean, boolean, 292 String)} 293 */ 294 public void updateLayoutSetPrototypeLinkEnabled(long groupId, 295 boolean privateLayout, boolean layoutSetPrototypeLinkEnabled) 296 throws com.liferay.portal.kernel.exception.PortalException, 297 com.liferay.portal.kernel.exception.SystemException; 298 299 /** 300 * Updates the state of the layout set prototype link. 301 * 302 * @param groupId the primary key of the group 303 * @param privateLayout whether the layout set is private to the group 304 * @param layoutSetPrototypeLinkEnabled whether the layout set prototype is 305 link enabled 306 * @param layoutSetPrototypeUuid the uuid of the layout set prototype to 307 link with 308 * @throws PortalException if a portal exception occurred 309 * @throws SystemException if a system exception occurred 310 */ 311 public void updateLayoutSetPrototypeLinkEnabled(long groupId, 312 boolean privateLayout, boolean layoutSetPrototypeLinkEnabled, 313 java.lang.String layoutSetPrototypeUuid) 314 throws com.liferay.portal.kernel.exception.PortalException, 315 com.liferay.portal.kernel.exception.SystemException; 316 317 public com.liferay.portal.model.LayoutSet updateLogo(long groupId, 318 boolean privateLayout, boolean logo, java.io.File file) 319 throws com.liferay.portal.kernel.exception.PortalException, 320 com.liferay.portal.kernel.exception.SystemException; 321 322 public com.liferay.portal.model.LayoutSet updateLogo(long groupId, 323 boolean privateLayout, boolean logo, java.io.InputStream is) 324 throws com.liferay.portal.kernel.exception.PortalException, 325 com.liferay.portal.kernel.exception.SystemException; 326 327 public com.liferay.portal.model.LayoutSet updateLogo(long groupId, 328 boolean privateLayout, boolean logo, java.io.InputStream is, 329 boolean cleanUpStream) 330 throws com.liferay.portal.kernel.exception.PortalException, 331 com.liferay.portal.kernel.exception.SystemException; 332 333 public com.liferay.portal.model.LayoutSet updateLookAndFeel(long groupId, 334 boolean privateLayout, java.lang.String themeId, 335 java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme) 336 throws com.liferay.portal.kernel.exception.PortalException, 337 com.liferay.portal.kernel.exception.SystemException; 338 339 public void updateLookAndFeel(long groupId, java.lang.String themeId, 340 java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme) 341 throws com.liferay.portal.kernel.exception.PortalException, 342 com.liferay.portal.kernel.exception.SystemException; 343 344 public com.liferay.portal.model.LayoutSet updatePageCount(long groupId, 345 boolean privateLayout) 346 throws com.liferay.portal.kernel.exception.PortalException, 347 com.liferay.portal.kernel.exception.SystemException; 348 349 public com.liferay.portal.model.LayoutSet updateSettings(long groupId, 350 boolean privateLayout, java.lang.String settings) 351 throws com.liferay.portal.kernel.exception.PortalException, 352 com.liferay.portal.kernel.exception.SystemException; 353 354 public com.liferay.portal.model.LayoutSet updateVirtualHost(long groupId, 355 boolean privateLayout, java.lang.String virtualHostname) 356 throws com.liferay.portal.kernel.exception.PortalException, 357 com.liferay.portal.kernel.exception.SystemException; 358 }