001 /** 002 * Copyright (c) 2000-2011 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 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 LayoutBranchLocalServiceUtil 032 * @see com.liferay.portal.service.base.LayoutBranchLocalServiceBaseImpl 033 * @see com.liferay.portal.service.impl.LayoutBranchLocalServiceImpl 034 * @generated 035 */ 036 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 037 PortalException.class, SystemException.class}) 038 public interface LayoutBranchLocalService extends PersistedModelLocalService { 039 /* 040 * NOTE FOR DEVELOPERS: 041 * 042 * Never modify or reference this interface directly. Always use {@link LayoutBranchLocalServiceUtil} to access the layout branch local service. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutBranchLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 043 */ 044 045 /** 046 * Adds the layout branch to the database. Also notifies the appropriate model listeners. 047 * 048 * @param layoutBranch the layout branch 049 * @return the layout branch that was added 050 * @throws SystemException if a system exception occurred 051 */ 052 public com.liferay.portal.model.LayoutBranch addLayoutBranch( 053 com.liferay.portal.model.LayoutBranch layoutBranch) 054 throws com.liferay.portal.kernel.exception.SystemException; 055 056 /** 057 * Creates a new layout branch with the primary key. Does not add the layout branch to the database. 058 * 059 * @param LayoutBranchId the primary key for the new layout branch 060 * @return the new layout branch 061 */ 062 public com.liferay.portal.model.LayoutBranch createLayoutBranch( 063 long LayoutBranchId); 064 065 /** 066 * Deletes the layout branch with the primary key from the database. Also notifies the appropriate model listeners. 067 * 068 * @param LayoutBranchId the primary key of the layout branch 069 * @throws PortalException if a layout branch with the primary key could not be found 070 * @throws SystemException if a system exception occurred 071 */ 072 public void deleteLayoutBranch(long LayoutBranchId) 073 throws com.liferay.portal.kernel.exception.PortalException, 074 com.liferay.portal.kernel.exception.SystemException; 075 076 /** 077 * Deletes the layout branch from the database. Also notifies the appropriate model listeners. 078 * 079 * @param layoutBranch the layout branch 080 * @throws SystemException if a system exception occurred 081 */ 082 public void deleteLayoutBranch( 083 com.liferay.portal.model.LayoutBranch layoutBranch) 084 throws com.liferay.portal.kernel.exception.SystemException; 085 086 /** 087 * Performs a dynamic query on the database and returns the matching rows. 088 * 089 * @param dynamicQuery the dynamic query 090 * @return the matching rows 091 * @throws SystemException if a system exception occurred 092 */ 093 @SuppressWarnings("rawtypes") 094 public java.util.List dynamicQuery( 095 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 096 throws com.liferay.portal.kernel.exception.SystemException; 097 098 /** 099 * Performs a dynamic query on the database and returns a range of the matching rows. 100 * 101 * <p> 102 * 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. 103 * </p> 104 * 105 * @param dynamicQuery the dynamic query 106 * @param start the lower bound of the range of model instances 107 * @param end the upper bound of the range of model instances (not inclusive) 108 * @return the range of matching rows 109 * @throws SystemException if a system exception occurred 110 */ 111 @SuppressWarnings("rawtypes") 112 public java.util.List dynamicQuery( 113 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 114 int end) throws com.liferay.portal.kernel.exception.SystemException; 115 116 /** 117 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 118 * 119 * <p> 120 * 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. 121 * </p> 122 * 123 * @param dynamicQuery the dynamic query 124 * @param start the lower bound of the range of model instances 125 * @param end the upper bound of the range of model instances (not inclusive) 126 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 127 * @return the ordered range of matching rows 128 * @throws SystemException if a system exception occurred 129 */ 130 @SuppressWarnings("rawtypes") 131 public java.util.List dynamicQuery( 132 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 133 int end, 134 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 135 throws com.liferay.portal.kernel.exception.SystemException; 136 137 /** 138 * Returns the number of rows that match the dynamic query. 139 * 140 * @param dynamicQuery the dynamic query 141 * @return the number of rows that match the dynamic query 142 * @throws SystemException if a system exception occurred 143 */ 144 public long dynamicQueryCount( 145 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 146 throws com.liferay.portal.kernel.exception.SystemException; 147 148 /** 149 * Returns the layout branch with the primary key. 150 * 151 * @param LayoutBranchId the primary key of the layout branch 152 * @return the layout branch 153 * @throws PortalException if a layout branch with the primary key could not be found 154 * @throws SystemException if a system exception occurred 155 */ 156 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 157 public com.liferay.portal.model.LayoutBranch getLayoutBranch( 158 long LayoutBranchId) 159 throws com.liferay.portal.kernel.exception.PortalException, 160 com.liferay.portal.kernel.exception.SystemException; 161 162 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 163 public com.liferay.portal.model.PersistedModel getPersistedModel( 164 java.io.Serializable primaryKeyObj) 165 throws com.liferay.portal.kernel.exception.PortalException, 166 com.liferay.portal.kernel.exception.SystemException; 167 168 /** 169 * Returns a range of all the layout branchs. 170 * 171 * <p> 172 * 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. 173 * </p> 174 * 175 * @param start the lower bound of the range of layout branchs 176 * @param end the upper bound of the range of layout branchs (not inclusive) 177 * @return the range of layout branchs 178 * @throws SystemException if a system exception occurred 179 */ 180 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 181 public java.util.List<com.liferay.portal.model.LayoutBranch> getLayoutBranchs( 182 int start, int end) 183 throws com.liferay.portal.kernel.exception.SystemException; 184 185 /** 186 * Returns the number of layout branchs. 187 * 188 * @return the number of layout branchs 189 * @throws SystemException if a system exception occurred 190 */ 191 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 192 public int getLayoutBranchsCount() 193 throws com.liferay.portal.kernel.exception.SystemException; 194 195 /** 196 * Updates the layout branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 197 * 198 * @param layoutBranch the layout branch 199 * @return the layout branch that was updated 200 * @throws SystemException if a system exception occurred 201 */ 202 public com.liferay.portal.model.LayoutBranch updateLayoutBranch( 203 com.liferay.portal.model.LayoutBranch layoutBranch) 204 throws com.liferay.portal.kernel.exception.SystemException; 205 206 /** 207 * Updates the layout branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 208 * 209 * @param layoutBranch the layout branch 210 * @param merge whether to merge the layout branch 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. 211 * @return the layout branch that was updated 212 * @throws SystemException if a system exception occurred 213 */ 214 public com.liferay.portal.model.LayoutBranch updateLayoutBranch( 215 com.liferay.portal.model.LayoutBranch layoutBranch, boolean merge) 216 throws com.liferay.portal.kernel.exception.SystemException; 217 218 /** 219 * Returns the Spring bean ID for this bean. 220 * 221 * @return the Spring bean ID for this bean 222 */ 223 public java.lang.String getBeanIdentifier(); 224 225 /** 226 * Sets the Spring bean ID for this bean. 227 * 228 * @param beanIdentifier the Spring bean ID for this bean 229 */ 230 public void setBeanIdentifier(java.lang.String beanIdentifier); 231 232 public com.liferay.portal.model.LayoutBranch addLayoutBranch( 233 long layoutSetBranchId, long plid, java.lang.String name, 234 java.lang.String description, boolean master, 235 com.liferay.portal.service.ServiceContext serviceContext) 236 throws com.liferay.portal.kernel.exception.PortalException, 237 com.liferay.portal.kernel.exception.SystemException; 238 239 public com.liferay.portal.model.LayoutBranch addLayoutBranch( 240 long layoutRevisionId, java.lang.String name, 241 java.lang.String description, boolean master, 242 com.liferay.portal.service.ServiceContext serviceContext) 243 throws com.liferay.portal.kernel.exception.PortalException, 244 com.liferay.portal.kernel.exception.SystemException; 245 246 public void deleteLayoutSetBranchLayoutBranches(long layoutSetBranchId) 247 throws com.liferay.portal.kernel.exception.PortalException, 248 com.liferay.portal.kernel.exception.SystemException; 249 250 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 251 public java.util.List<com.liferay.portal.model.LayoutBranch> getLayoutBranches( 252 long layoutSetBranchId, long plid, int start, int end, 253 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 254 throws com.liferay.portal.kernel.exception.SystemException; 255 256 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 257 public java.util.List<com.liferay.portal.model.LayoutBranch> getLayoutSetBranchLayoutBranches( 258 long layoutSetBranchId) 259 throws com.liferay.portal.kernel.exception.SystemException; 260 261 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 262 public com.liferay.portal.model.LayoutBranch getMasterLayoutBranch( 263 long layoutSetBranchId, long plid) 264 throws com.liferay.portal.kernel.exception.PortalException, 265 com.liferay.portal.kernel.exception.SystemException; 266 267 public com.liferay.portal.model.LayoutBranch updateLayoutBranch( 268 long layoutBranchId, java.lang.String name, 269 java.lang.String description, 270 com.liferay.portal.service.ServiceContext serviceContext) 271 throws com.liferay.portal.kernel.exception.PortalException, 272 com.liferay.portal.kernel.exception.SystemException; 273 }