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