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 LayoutSetBranch. 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 LayoutSetBranchLocalServiceUtil 033 * @see com.liferay.portal.service.base.LayoutSetBranchLocalServiceBaseImpl 034 * @see com.liferay.portal.service.impl.LayoutSetBranchLocalServiceImpl 035 * @generated 036 */ 037 @ProviderType 038 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 039 PortalException.class, SystemException.class}) 040 public interface LayoutSetBranchLocalService extends BaseLocalService, 041 PersistedModelLocalService { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * Never modify or reference this interface directly. Always use {@link LayoutSetBranchLocalServiceUtil} to access the layout set branch local service. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutSetBranchLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 046 */ 047 048 /** 049 * Adds the layout set branch to the database. Also notifies the appropriate model listeners. 050 * 051 * @param layoutSetBranch the layout set branch 052 * @return the layout set branch that was added 053 * @throws SystemException if a system exception occurred 054 */ 055 public com.liferay.portal.model.LayoutSetBranch addLayoutSetBranch( 056 com.liferay.portal.model.LayoutSetBranch layoutSetBranch) 057 throws com.liferay.portal.kernel.exception.SystemException; 058 059 /** 060 * Creates a new layout set branch with the primary key. Does not add the layout set branch to the database. 061 * 062 * @param layoutSetBranchId the primary key for the new layout set branch 063 * @return the new layout set branch 064 */ 065 public com.liferay.portal.model.LayoutSetBranch createLayoutSetBranch( 066 long layoutSetBranchId); 067 068 /** 069 * Deletes the layout set branch with the primary key from the database. Also notifies the appropriate model listeners. 070 * 071 * @param layoutSetBranchId the primary key of the layout set branch 072 * @return the layout set branch that was removed 073 * @throws PortalException if a layout set branch with the primary key could not be found 074 * @throws SystemException if a system exception occurred 075 */ 076 public com.liferay.portal.model.LayoutSetBranch deleteLayoutSetBranch( 077 long layoutSetBranchId) 078 throws com.liferay.portal.kernel.exception.PortalException, 079 com.liferay.portal.kernel.exception.SystemException; 080 081 /** 082 * Deletes the layout set branch from the database. Also notifies the appropriate model listeners. 083 * 084 * @param layoutSetBranch the layout set branch 085 * @return the layout set branch that was removed 086 * @throws PortalException 087 * @throws SystemException if a system exception occurred 088 */ 089 public com.liferay.portal.model.LayoutSetBranch deleteLayoutSetBranch( 090 com.liferay.portal.model.LayoutSetBranch layoutSetBranch) 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.LayoutSetBranchModelImpl}. 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.LayoutSetBranchModelImpl}. 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.LayoutSetBranch fetchLayoutSetBranch( 173 long layoutSetBranchId) 174 throws com.liferay.portal.kernel.exception.SystemException; 175 176 /** 177 * Returns the layout set branch with the primary key. 178 * 179 * @param layoutSetBranchId the primary key of the layout set branch 180 * @return the layout set branch 181 * @throws PortalException if a layout set branch with the primary key 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.LayoutSetBranch getLayoutSetBranch( 186 long layoutSetBranchId) 187 throws com.liferay.portal.kernel.exception.PortalException, 188 com.liferay.portal.kernel.exception.SystemException; 189 190 @Override 191 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 192 public com.liferay.portal.model.PersistedModel getPersistedModel( 193 java.io.Serializable primaryKeyObj) 194 throws com.liferay.portal.kernel.exception.PortalException, 195 com.liferay.portal.kernel.exception.SystemException; 196 197 /** 198 * Returns a range of all the layout set branchs. 199 * 200 * <p> 201 * 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.LayoutSetBranchModelImpl}. 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. 202 * </p> 203 * 204 * @param start the lower bound of the range of layout set branchs 205 * @param end the upper bound of the range of layout set branchs (not inclusive) 206 * @return the range of layout set branchs 207 * @throws SystemException if a system exception occurred 208 */ 209 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 210 public java.util.List<com.liferay.portal.model.LayoutSetBranch> getLayoutSetBranchs( 211 int start, int end) 212 throws com.liferay.portal.kernel.exception.SystemException; 213 214 /** 215 * Returns the number of layout set branchs. 216 * 217 * @return the number of layout set branchs 218 * @throws SystemException if a system exception occurred 219 */ 220 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 221 public int getLayoutSetBranchsCount() 222 throws com.liferay.portal.kernel.exception.SystemException; 223 224 /** 225 * Updates the layout set branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 226 * 227 * @param layoutSetBranch the layout set branch 228 * @return the layout set branch that was updated 229 * @throws SystemException if a system exception occurred 230 */ 231 public com.liferay.portal.model.LayoutSetBranch updateLayoutSetBranch( 232 com.liferay.portal.model.LayoutSetBranch layoutSetBranch) 233 throws com.liferay.portal.kernel.exception.SystemException; 234 235 /** 236 * Returns the Spring bean ID for this bean. 237 * 238 * @return the Spring bean ID for this bean 239 */ 240 public java.lang.String getBeanIdentifier(); 241 242 /** 243 * Sets the Spring bean ID for this bean. 244 * 245 * @param beanIdentifier the Spring bean ID for this bean 246 */ 247 public void setBeanIdentifier(java.lang.String beanIdentifier); 248 249 public com.liferay.portal.model.LayoutSetBranch addLayoutSetBranch( 250 long userId, long groupId, boolean privateLayout, 251 java.lang.String name, java.lang.String description, boolean master, 252 long copyLayoutSetBranchId, 253 com.liferay.portal.service.ServiceContext serviceContext) 254 throws com.liferay.portal.kernel.exception.PortalException, 255 com.liferay.portal.kernel.exception.SystemException; 256 257 public com.liferay.portal.model.LayoutSetBranch deleteLayoutSetBranch( 258 com.liferay.portal.model.LayoutSetBranch layoutSetBranch, 259 boolean includeMaster) 260 throws com.liferay.portal.kernel.exception.PortalException, 261 com.liferay.portal.kernel.exception.SystemException; 262 263 public void deleteLayoutSetBranches(long groupId, boolean privateLayout) 264 throws com.liferay.portal.kernel.exception.PortalException, 265 com.liferay.portal.kernel.exception.SystemException; 266 267 public void deleteLayoutSetBranches(long groupId, boolean privateLayout, 268 boolean includeMaster) 269 throws com.liferay.portal.kernel.exception.PortalException, 270 com.liferay.portal.kernel.exception.SystemException; 271 272 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 273 public com.liferay.portal.model.LayoutSetBranch fetchLayoutSetBranch( 274 long groupId, boolean privateLayout, java.lang.String name) 275 throws com.liferay.portal.kernel.exception.SystemException; 276 277 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 278 public com.liferay.portal.model.LayoutSetBranch getLayoutSetBranch( 279 long groupId, boolean privateLayout, java.lang.String name) 280 throws com.liferay.portal.kernel.exception.PortalException, 281 com.liferay.portal.kernel.exception.SystemException; 282 283 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 284 public java.util.List<com.liferay.portal.model.LayoutSetBranch> getLayoutSetBranches( 285 long groupId, boolean privateLayout) 286 throws com.liferay.portal.kernel.exception.SystemException; 287 288 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 289 public com.liferay.portal.model.LayoutSetBranch getMasterLayoutSetBranch( 290 long groupId, boolean privateLayout) 291 throws com.liferay.portal.kernel.exception.PortalException, 292 com.liferay.portal.kernel.exception.SystemException; 293 294 /** 295 * @deprecated As of 6.2.0, replaced by {@link #getUserLayoutSetBranch(long, 296 long, boolean, long, long)} 297 */ 298 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 299 public com.liferay.portal.model.LayoutSetBranch getUserLayoutSetBranch( 300 long userId, long groupId, boolean privateLayout, long layoutSetBranchId) 301 throws com.liferay.portal.kernel.exception.PortalException, 302 com.liferay.portal.kernel.exception.SystemException; 303 304 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 305 public com.liferay.portal.model.LayoutSetBranch getUserLayoutSetBranch( 306 long userId, long groupId, boolean privateLayout, long layoutSetId, 307 long layoutSetBranchId) 308 throws com.liferay.portal.kernel.exception.PortalException, 309 com.liferay.portal.kernel.exception.SystemException; 310 311 public com.liferay.portal.model.LayoutSetBranch mergeLayoutSetBranch( 312 long layoutSetBranchId, long mergeLayoutSetBranchId, 313 com.liferay.portal.service.ServiceContext serviceContext) 314 throws com.liferay.portal.kernel.exception.PortalException, 315 com.liferay.portal.kernel.exception.SystemException; 316 317 public com.liferay.portal.model.LayoutSetBranch updateLayoutSetBranch( 318 long layoutSetBranchId, java.lang.String name, 319 java.lang.String description, 320 com.liferay.portal.service.ServiceContext serviceContext) 321 throws com.liferay.portal.kernel.exception.PortalException, 322 com.liferay.portal.kernel.exception.SystemException; 323 }