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 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 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) throws PortalException; 100 101 public void deleteLayoutSetBranchLayoutBranches(long layoutSetBranchId) 102 throws PortalException; 103 104 /** 105 * @throws PortalException 106 */ 107 @Override 108 public com.liferay.portal.model.PersistedModel deletePersistedModel( 109 com.liferay.portal.model.PersistedModel persistedModel) 110 throws PortalException; 111 112 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 113 114 /** 115 * Performs a dynamic query on the database and returns the matching rows. 116 * 117 * @param dynamicQuery the dynamic query 118 * @return the matching rows 119 */ 120 public <T> java.util.List<T> dynamicQuery( 121 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 122 123 /** 124 * Performs a dynamic query on the database and returns a range of the matching rows. 125 * 126 * <p> 127 * 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. 128 * </p> 129 * 130 * @param dynamicQuery the dynamic query 131 * @param start the lower bound of the range of model instances 132 * @param end the upper bound of the range of model instances (not inclusive) 133 * @return the range of matching rows 134 */ 135 public <T> java.util.List<T> dynamicQuery( 136 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 137 int end); 138 139 /** 140 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 141 * 142 * <p> 143 * 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. 144 * </p> 145 * 146 * @param dynamicQuery the dynamic query 147 * @param start the lower bound of the range of model instances 148 * @param end the upper bound of the range of model instances (not inclusive) 149 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 150 * @return the ordered range of matching rows 151 */ 152 public <T> java.util.List<T> dynamicQuery( 153 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 154 int end, 155 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 156 157 /** 158 * Returns the number of rows matching the dynamic query. 159 * 160 * @param dynamicQuery the dynamic query 161 * @return the number of rows matching the dynamic query 162 */ 163 public long dynamicQueryCount( 164 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 165 166 /** 167 * Returns the number of rows matching the dynamic query. 168 * 169 * @param dynamicQuery the dynamic query 170 * @param projection the projection to apply to the query 171 * @return the number of rows matching the dynamic query 172 */ 173 public long dynamicQueryCount( 174 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 175 com.liferay.portal.kernel.dao.orm.Projection projection); 176 177 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 178 public com.liferay.portal.model.LayoutBranch fetchLayoutBranch( 179 long layoutBranchId); 180 181 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 182 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 183 184 /** 185 * Returns the layout branch with the primary key. 186 * 187 * @param layoutBranchId the primary key of the layout branch 188 * @return the layout branch 189 * @throws PortalException if a layout branch with the primary key could not be found 190 */ 191 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 192 public com.liferay.portal.model.LayoutBranch getLayoutBranch( 193 long layoutBranchId) throws PortalException; 194 195 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 196 public java.util.List<com.liferay.portal.model.LayoutBranch> getLayoutBranches( 197 long layoutSetBranchId, long plid, int start, int end, 198 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.LayoutBranch> orderByComparator); 199 200 /** 201 * Returns a range of all the layout branchs. 202 * 203 * <p> 204 * 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. 205 * </p> 206 * 207 * @param start the lower bound of the range of layout branchs 208 * @param end the upper bound of the range of layout branchs (not inclusive) 209 * @return the range of layout branchs 210 */ 211 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 212 public java.util.List<com.liferay.portal.model.LayoutBranch> getLayoutBranchs( 213 int start, int end); 214 215 /** 216 * Returns the number of layout branchs. 217 * 218 * @return the number of layout branchs 219 */ 220 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 221 public int getLayoutBranchsCount(); 222 223 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 224 public java.util.List<com.liferay.portal.model.LayoutBranch> getLayoutSetBranchLayoutBranches( 225 long layoutSetBranchId); 226 227 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 228 public com.liferay.portal.model.LayoutBranch getMasterLayoutBranch( 229 long layoutSetBranchId, long plid) throws PortalException; 230 231 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 232 public com.liferay.portal.model.LayoutBranch getMasterLayoutBranch( 233 long layoutSetBranchId, long plid, 234 com.liferay.portal.service.ServiceContext serviceContext) 235 throws PortalException; 236 237 /** 238 * Returns the OSGi service identifier. 239 * 240 * @return the OSGi service identifier 241 */ 242 public java.lang.String getOSGiServiceIdentifier(); 243 244 @Override 245 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 246 public com.liferay.portal.model.PersistedModel getPersistedModel( 247 java.io.Serializable primaryKeyObj) throws PortalException; 248 249 /** 250 * Updates the layout branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 251 * 252 * @param layoutBranch the layout branch 253 * @return the layout branch that was updated 254 */ 255 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 256 public com.liferay.portal.model.LayoutBranch updateLayoutBranch( 257 com.liferay.portal.model.LayoutBranch layoutBranch); 258 259 public com.liferay.portal.model.LayoutBranch updateLayoutBranch( 260 long layoutBranchId, java.lang.String name, 261 java.lang.String description, 262 com.liferay.portal.service.ServiceContext serviceContext) 263 throws PortalException; 264 }