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.kernel.service; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery; 020 import com.liferay.portal.kernel.dao.orm.DynamicQuery; 021 import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery; 022 import com.liferay.portal.kernel.dao.orm.Projection; 023 import com.liferay.portal.kernel.exception.PortalException; 024 import com.liferay.portal.kernel.exception.SystemException; 025 import com.liferay.portal.kernel.model.LayoutSetBranch; 026 import com.liferay.portal.kernel.model.PersistedModel; 027 import com.liferay.portal.kernel.search.Indexable; 028 import com.liferay.portal.kernel.search.IndexableType; 029 import com.liferay.portal.kernel.transaction.Isolation; 030 import com.liferay.portal.kernel.transaction.Propagation; 031 import com.liferay.portal.kernel.transaction.Transactional; 032 import com.liferay.portal.kernel.util.OrderByComparator; 033 034 import java.io.Serializable; 035 036 import java.util.List; 037 038 /** 039 * Provides the local service interface for LayoutSetBranch. Methods of this 040 * service will not have security checks based on the propagated JAAS 041 * credentials because this service can only be accessed from within the same 042 * VM. 043 * 044 * @author Brian Wing Shun Chan 045 * @see LayoutSetBranchLocalServiceUtil 046 * @see com.liferay.portal.service.base.LayoutSetBranchLocalServiceBaseImpl 047 * @see com.liferay.portal.service.impl.LayoutSetBranchLocalServiceImpl 048 * @generated 049 */ 050 @ProviderType 051 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 052 PortalException.class, SystemException.class}) 053 public interface LayoutSetBranchLocalService extends BaseLocalService, 054 PersistedModelLocalService { 055 /* 056 * NOTE FOR DEVELOPERS: 057 * 058 * 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. 059 */ 060 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 061 public ActionableDynamicQuery getActionableDynamicQuery(); 062 063 public DynamicQuery dynamicQuery(); 064 065 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 066 public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 067 068 /** 069 * Adds the layout set branch to the database. Also notifies the appropriate model listeners. 070 * 071 * @param layoutSetBranch the layout set branch 072 * @return the layout set branch that was added 073 */ 074 @Indexable(type = IndexableType.REINDEX) 075 public LayoutSetBranch addLayoutSetBranch(LayoutSetBranch layoutSetBranch); 076 077 public LayoutSetBranch addLayoutSetBranch(long userId, long groupId, 078 boolean privateLayout, java.lang.String name, 079 java.lang.String description, boolean master, 080 long copyLayoutSetBranchId, ServiceContext serviceContext) 081 throws PortalException; 082 083 /** 084 * Creates a new layout set branch with the primary key. Does not add the layout set branch to the database. 085 * 086 * @param layoutSetBranchId the primary key for the new layout set branch 087 * @return the new layout set branch 088 */ 089 public LayoutSetBranch createLayoutSetBranch(long layoutSetBranchId); 090 091 /** 092 * Deletes the layout set branch from the database. Also notifies the appropriate model listeners. 093 * 094 * @param layoutSetBranch the layout set branch 095 * @return the layout set branch that was removed 096 * @throws PortalException 097 */ 098 @Indexable(type = IndexableType.DELETE) 099 public LayoutSetBranch deleteLayoutSetBranch( 100 LayoutSetBranch layoutSetBranch) throws PortalException; 101 102 public LayoutSetBranch deleteLayoutSetBranch( 103 LayoutSetBranch layoutSetBranch, boolean includeMaster) 104 throws PortalException; 105 106 /** 107 * Deletes the layout set branch with the primary key from the database. Also notifies the appropriate model listeners. 108 * 109 * @param layoutSetBranchId the primary key of the layout set branch 110 * @return the layout set branch that was removed 111 * @throws PortalException if a layout set branch with the primary key could not be found 112 */ 113 @Indexable(type = IndexableType.DELETE) 114 public LayoutSetBranch deleteLayoutSetBranch(long layoutSetBranchId) 115 throws PortalException; 116 117 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 118 public LayoutSetBranch fetchLayoutSetBranch(long groupId, 119 boolean privateLayout, java.lang.String name); 120 121 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 122 public LayoutSetBranch fetchLayoutSetBranch(long layoutSetBranchId); 123 124 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 125 public LayoutSetBranch getLayoutSetBranch(long groupId, 126 boolean privateLayout, java.lang.String name) throws PortalException; 127 128 /** 129 * Returns the layout set branch with the primary key. 130 * 131 * @param layoutSetBranchId the primary key of the layout set branch 132 * @return the layout set branch 133 * @throws PortalException if a layout set branch with the primary key could not be found 134 */ 135 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 136 public LayoutSetBranch getLayoutSetBranch(long layoutSetBranchId) 137 throws PortalException; 138 139 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 140 public LayoutSetBranch getMasterLayoutSetBranch(long groupId, 141 boolean privateLayout) throws PortalException; 142 143 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 144 public LayoutSetBranch getUserLayoutSetBranch(long userId, long groupId, 145 boolean privateLayout, long layoutSetId, long layoutSetBranchId) 146 throws PortalException; 147 148 public LayoutSetBranch mergeLayoutSetBranch(long layoutSetBranchId, 149 long mergeLayoutSetBranchId, ServiceContext serviceContext) 150 throws PortalException; 151 152 /** 153 * Updates the layout set branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 154 * 155 * @param layoutSetBranch the layout set branch 156 * @return the layout set branch that was updated 157 */ 158 @Indexable(type = IndexableType.REINDEX) 159 public LayoutSetBranch updateLayoutSetBranch( 160 LayoutSetBranch layoutSetBranch); 161 162 public LayoutSetBranch updateLayoutSetBranch(long layoutSetBranchId, 163 java.lang.String name, java.lang.String description, 164 ServiceContext serviceContext) throws PortalException; 165 166 /** 167 * @throws PortalException 168 */ 169 @Override 170 public PersistedModel deletePersistedModel(PersistedModel persistedModel) 171 throws PortalException; 172 173 @Override 174 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 175 public PersistedModel getPersistedModel(Serializable primaryKeyObj) 176 throws PortalException; 177 178 /** 179 * Returns the number of layout set branchs. 180 * 181 * @return the number of layout set branchs 182 */ 183 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 184 public int getLayoutSetBranchsCount(); 185 186 /** 187 * Returns the OSGi service identifier. 188 * 189 * @return the OSGi service identifier 190 */ 191 public java.lang.String getOSGiServiceIdentifier(); 192 193 /** 194 * Performs a dynamic query on the database and returns the matching rows. 195 * 196 * @param dynamicQuery the dynamic query 197 * @return the matching rows 198 */ 199 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery); 200 201 /** 202 * Performs a dynamic query on the database and returns a range of the matching rows. 203 * 204 * <p> 205 * 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. 206 * </p> 207 * 208 * @param dynamicQuery the dynamic query 209 * @param start the lower bound of the range of model instances 210 * @param end the upper bound of the range of model instances (not inclusive) 211 * @return the range of matching rows 212 */ 213 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 214 int end); 215 216 /** 217 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 218 * 219 * <p> 220 * 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. 221 * </p> 222 * 223 * @param dynamicQuery the dynamic query 224 * @param start the lower bound of the range of model instances 225 * @param end the upper bound of the range of model instances (not inclusive) 226 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 227 * @return the ordered range of matching rows 228 */ 229 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 230 int end, OrderByComparator<T> orderByComparator); 231 232 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 233 public List<LayoutSetBranch> getLayoutSetBranches(long groupId, 234 boolean privateLayout); 235 236 /** 237 * Returns a range of all the layout set branchs. 238 * 239 * <p> 240 * 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. 241 * </p> 242 * 243 * @param start the lower bound of the range of layout set branchs 244 * @param end the upper bound of the range of layout set branchs (not inclusive) 245 * @return the range of layout set branchs 246 */ 247 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 248 public List<LayoutSetBranch> getLayoutSetBranchs(int start, int end); 249 250 /** 251 * Returns the number of rows matching the dynamic query. 252 * 253 * @param dynamicQuery the dynamic query 254 * @return the number of rows matching the dynamic query 255 */ 256 public long dynamicQueryCount(DynamicQuery dynamicQuery); 257 258 /** 259 * Returns the number of rows matching the dynamic query. 260 * 261 * @param dynamicQuery the dynamic query 262 * @param projection the projection to apply to the query 263 * @return the number of rows matching the dynamic query 264 */ 265 public long dynamicQueryCount(DynamicQuery dynamicQuery, 266 Projection projection); 267 268 public void deleteLayoutSetBranches(long groupId, boolean privateLayout) 269 throws PortalException; 270 271 public void deleteLayoutSetBranches(long groupId, boolean privateLayout, 272 boolean includeMaster) throws PortalException; 273 }