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 branch 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 LayoutSetBranchLocalServiceUtil 032 * @see com.liferay.portal.service.base.LayoutSetBranchLocalServiceBaseImpl 033 * @see com.liferay.portal.service.impl.LayoutSetBranchLocalServiceImpl 034 * @generated 035 */ 036 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 037 PortalException.class, SystemException.class}) 038 public interface LayoutSetBranchLocalService extends BaseLocalService, 039 PersistedModelLocalService { 040 /* 041 * NOTE FOR DEVELOPERS: 042 * 043 * 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. 044 */ 045 046 /** 047 * Adds the layout set branch to the database. Also notifies the appropriate model listeners. 048 * 049 * @param layoutSetBranch the layout set branch 050 * @return the layout set branch that was added 051 * @throws SystemException if a system exception occurred 052 */ 053 public com.liferay.portal.model.LayoutSetBranch addLayoutSetBranch( 054 com.liferay.portal.model.LayoutSetBranch layoutSetBranch) 055 throws com.liferay.portal.kernel.exception.SystemException; 056 057 /** 058 * Creates a new layout set branch with the primary key. Does not add the layout set branch to the database. 059 * 060 * @param layoutSetBranchId the primary key for the new layout set branch 061 * @return the new layout set branch 062 */ 063 public com.liferay.portal.model.LayoutSetBranch createLayoutSetBranch( 064 long layoutSetBranchId); 065 066 /** 067 * Deletes the layout set branch with the primary key from the database. Also notifies the appropriate model listeners. 068 * 069 * @param layoutSetBranchId the primary key of the layout set branch 070 * @return the layout set branch that was removed 071 * @throws PortalException if a layout set branch with the primary key could not be found 072 * @throws SystemException if a system exception occurred 073 */ 074 public com.liferay.portal.model.LayoutSetBranch deleteLayoutSetBranch( 075 long layoutSetBranchId) 076 throws com.liferay.portal.kernel.exception.PortalException, 077 com.liferay.portal.kernel.exception.SystemException; 078 079 /** 080 * Deletes the layout set branch from the database. Also notifies the appropriate model listeners. 081 * 082 * @param layoutSetBranch the layout set branch 083 * @return the layout set branch that was removed 084 * @throws PortalException 085 * @throws SystemException if a system exception occurred 086 */ 087 public com.liferay.portal.model.LayoutSetBranch deleteLayoutSetBranch( 088 com.liferay.portal.model.LayoutSetBranch layoutSetBranch) 089 throws com.liferay.portal.kernel.exception.PortalException, 090 com.liferay.portal.kernel.exception.SystemException; 091 092 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 093 094 /** 095 * Performs a dynamic query on the database and returns the matching rows. 096 * 097 * @param dynamicQuery the dynamic query 098 * @return the matching rows 099 * @throws SystemException if a system exception occurred 100 */ 101 @SuppressWarnings("rawtypes") 102 public java.util.List dynamicQuery( 103 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 104 throws com.liferay.portal.kernel.exception.SystemException; 105 106 /** 107 * Performs a dynamic query on the database and returns a range of the matching rows. 108 * 109 * <p> 110 * 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. 111 * </p> 112 * 113 * @param dynamicQuery the dynamic query 114 * @param start the lower bound of the range of model instances 115 * @param end the upper bound of the range of model instances (not inclusive) 116 * @return the range of matching rows 117 * @throws SystemException if a system exception occurred 118 */ 119 @SuppressWarnings("rawtypes") 120 public java.util.List dynamicQuery( 121 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 122 int end) throws com.liferay.portal.kernel.exception.SystemException; 123 124 /** 125 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 126 * 127 * <p> 128 * 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. 129 * </p> 130 * 131 * @param dynamicQuery the dynamic query 132 * @param start the lower bound of the range of model instances 133 * @param end the upper bound of the range of model instances (not inclusive) 134 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 135 * @return the ordered range of matching rows 136 * @throws SystemException if a system exception occurred 137 */ 138 @SuppressWarnings("rawtypes") 139 public java.util.List dynamicQuery( 140 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 141 int end, 142 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 143 throws com.liferay.portal.kernel.exception.SystemException; 144 145 /** 146 * Returns the number of rows that match the dynamic query. 147 * 148 * @param dynamicQuery the dynamic query 149 * @return the number of rows that match the dynamic query 150 * @throws SystemException if a system exception occurred 151 */ 152 public long dynamicQueryCount( 153 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 154 throws com.liferay.portal.kernel.exception.SystemException; 155 156 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 157 public com.liferay.portal.model.LayoutSetBranch fetchLayoutSetBranch( 158 long layoutSetBranchId) 159 throws com.liferay.portal.kernel.exception.SystemException; 160 161 /** 162 * Returns the layout set branch with the primary key. 163 * 164 * @param layoutSetBranchId the primary key of the layout set branch 165 * @return the layout set branch 166 * @throws PortalException if a layout set branch with the primary key could not be found 167 * @throws SystemException if a system exception occurred 168 */ 169 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 170 public com.liferay.portal.model.LayoutSetBranch getLayoutSetBranch( 171 long layoutSetBranchId) 172 throws com.liferay.portal.kernel.exception.PortalException, 173 com.liferay.portal.kernel.exception.SystemException; 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public com.liferay.portal.model.PersistedModel getPersistedModel( 177 java.io.Serializable primaryKeyObj) 178 throws com.liferay.portal.kernel.exception.PortalException, 179 com.liferay.portal.kernel.exception.SystemException; 180 181 /** 182 * Returns a range of all the layout set branchs. 183 * 184 * <p> 185 * 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. 186 * </p> 187 * 188 * @param start the lower bound of the range of layout set branchs 189 * @param end the upper bound of the range of layout set branchs (not inclusive) 190 * @return the range of layout set branchs 191 * @throws SystemException if a system exception occurred 192 */ 193 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 194 public java.util.List<com.liferay.portal.model.LayoutSetBranch> getLayoutSetBranchs( 195 int start, int end) 196 throws com.liferay.portal.kernel.exception.SystemException; 197 198 /** 199 * Returns the number of layout set branchs. 200 * 201 * @return the number of layout set branchs 202 * @throws SystemException if a system exception occurred 203 */ 204 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 205 public int getLayoutSetBranchsCount() 206 throws com.liferay.portal.kernel.exception.SystemException; 207 208 /** 209 * Updates the layout set branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 210 * 211 * @param layoutSetBranch the layout set branch 212 * @return the layout set branch that was updated 213 * @throws SystemException if a system exception occurred 214 */ 215 public com.liferay.portal.model.LayoutSetBranch updateLayoutSetBranch( 216 com.liferay.portal.model.LayoutSetBranch layoutSetBranch) 217 throws com.liferay.portal.kernel.exception.SystemException; 218 219 /** 220 * Returns the Spring bean ID for this bean. 221 * 222 * @return the Spring bean ID for this bean 223 */ 224 public java.lang.String getBeanIdentifier(); 225 226 /** 227 * Sets the Spring bean ID for this bean. 228 * 229 * @param beanIdentifier the Spring bean ID for this bean 230 */ 231 public void setBeanIdentifier(java.lang.String beanIdentifier); 232 233 public com.liferay.portal.model.LayoutSetBranch addLayoutSetBranch( 234 long userId, long groupId, boolean privateLayout, 235 java.lang.String name, java.lang.String description, boolean master, 236 long copyLayoutSetBranchId, 237 com.liferay.portal.service.ServiceContext serviceContext) 238 throws com.liferay.portal.kernel.exception.PortalException, 239 com.liferay.portal.kernel.exception.SystemException; 240 241 public com.liferay.portal.model.LayoutSetBranch deleteLayoutSetBranch( 242 com.liferay.portal.model.LayoutSetBranch layoutSetBranch, 243 boolean includeMaster) 244 throws com.liferay.portal.kernel.exception.PortalException, 245 com.liferay.portal.kernel.exception.SystemException; 246 247 public void deleteLayoutSetBranches(long groupId, boolean privateLayout) 248 throws com.liferay.portal.kernel.exception.PortalException, 249 com.liferay.portal.kernel.exception.SystemException; 250 251 public void deleteLayoutSetBranches(long groupId, boolean privateLayout, 252 boolean includeMaster) 253 throws com.liferay.portal.kernel.exception.PortalException, 254 com.liferay.portal.kernel.exception.SystemException; 255 256 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 257 public com.liferay.portal.model.LayoutSetBranch getLayoutSetBranch( 258 long groupId, boolean privateLayout, java.lang.String name) 259 throws com.liferay.portal.kernel.exception.PortalException, 260 com.liferay.portal.kernel.exception.SystemException; 261 262 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 263 public java.util.List<com.liferay.portal.model.LayoutSetBranch> getLayoutSetBranches( 264 long groupId, boolean privateLayout) 265 throws com.liferay.portal.kernel.exception.SystemException; 266 267 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 268 public com.liferay.portal.model.LayoutSetBranch getMasterLayoutSetBranch( 269 long groupId, boolean privateLayout) 270 throws com.liferay.portal.kernel.exception.PortalException, 271 com.liferay.portal.kernel.exception.SystemException; 272 273 /** 274 * @deprecated As of 6.2.0, replaced by {@link #getUserLayoutSetBranch(long, 275 long, boolean, long, long)} 276 */ 277 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 278 public com.liferay.portal.model.LayoutSetBranch getUserLayoutSetBranch( 279 long userId, long groupId, boolean privateLayout, long layoutSetBranchId) 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 com.liferay.portal.model.LayoutSetBranch getUserLayoutSetBranch( 285 long userId, long groupId, boolean privateLayout, long layoutSetId, 286 long layoutSetBranchId) 287 throws com.liferay.portal.kernel.exception.PortalException, 288 com.liferay.portal.kernel.exception.SystemException; 289 290 public com.liferay.portal.model.LayoutSetBranch mergeLayoutSetBranch( 291 long layoutSetBranchId, long mergeLayoutSetBranchId, 292 com.liferay.portal.service.ServiceContext serviceContext) 293 throws com.liferay.portal.kernel.exception.PortalException, 294 com.liferay.portal.kernel.exception.SystemException; 295 296 public com.liferay.portal.model.LayoutSetBranch updateLayoutSetBranch( 297 long layoutSetBranchId, java.lang.String name, 298 java.lang.String description, 299 com.liferay.portal.service.ServiceContext serviceContext) 300 throws com.liferay.portal.kernel.exception.PortalException, 301 com.liferay.portal.kernel.exception.SystemException; 302 }