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.PersistedModel; 026 import com.liferay.portal.kernel.model.RecentLayoutSetBranch; 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 RecentLayoutSetBranch. 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 RecentLayoutSetBranchLocalServiceUtil 046 * @see com.liferay.portal.service.base.RecentLayoutSetBranchLocalServiceBaseImpl 047 * @see com.liferay.portal.service.impl.RecentLayoutSetBranchLocalServiceImpl 048 * @generated 049 */ 050 @ProviderType 051 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 052 PortalException.class, SystemException.class}) 053 public interface RecentLayoutSetBranchLocalService extends BaseLocalService, 054 PersistedModelLocalService { 055 /* 056 * NOTE FOR DEVELOPERS: 057 * 058 * Never modify or reference this interface directly. Always use {@link RecentLayoutSetBranchLocalServiceUtil} to access the recent layout set branch local service. Add custom service methods to {@link com.liferay.portal.service.impl.RecentLayoutSetBranchLocalServiceImpl} 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 * @throws PortalException 070 */ 071 @Override 072 public PersistedModel deletePersistedModel(PersistedModel persistedModel) 073 throws PortalException; 074 075 @Override 076 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 077 public PersistedModel getPersistedModel(Serializable primaryKeyObj) 078 throws PortalException; 079 080 /** 081 * Adds the recent layout set branch to the database. Also notifies the appropriate model listeners. 082 * 083 * @param recentLayoutSetBranch the recent layout set branch 084 * @return the recent layout set branch that was added 085 */ 086 @Indexable(type = IndexableType.REINDEX) 087 public RecentLayoutSetBranch addRecentLayoutSetBranch( 088 RecentLayoutSetBranch recentLayoutSetBranch); 089 090 public RecentLayoutSetBranch addRecentLayoutSetBranch(long userId, 091 long layoutSetBranchId, long layoutSetId) throws PortalException; 092 093 /** 094 * Creates a new recent layout set branch with the primary key. Does not add the recent layout set branch to the database. 095 * 096 * @param recentLayoutSetBranchId the primary key for the new recent layout set branch 097 * @return the new recent layout set branch 098 */ 099 public RecentLayoutSetBranch createRecentLayoutSetBranch( 100 long recentLayoutSetBranchId); 101 102 /** 103 * Deletes the recent layout set branch from the database. Also notifies the appropriate model listeners. 104 * 105 * @param recentLayoutSetBranch the recent layout set branch 106 * @return the recent layout set branch that was removed 107 */ 108 @Indexable(type = IndexableType.DELETE) 109 public RecentLayoutSetBranch deleteRecentLayoutSetBranch( 110 RecentLayoutSetBranch recentLayoutSetBranch); 111 112 /** 113 * Deletes the recent layout set branch with the primary key from the database. Also notifies the appropriate model listeners. 114 * 115 * @param recentLayoutSetBranchId the primary key of the recent layout set branch 116 * @return the recent layout set branch that was removed 117 * @throws PortalException if a recent layout set branch with the primary key could not be found 118 */ 119 @Indexable(type = IndexableType.DELETE) 120 public RecentLayoutSetBranch deleteRecentLayoutSetBranch( 121 long recentLayoutSetBranchId) throws PortalException; 122 123 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 124 public RecentLayoutSetBranch fetchRecentLayoutSetBranch( 125 long recentLayoutSetBranchId); 126 127 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 128 public RecentLayoutSetBranch fetchRecentLayoutSetBranch(long userId, 129 long layoutSetId); 130 131 /** 132 * Returns the recent layout set branch with the primary key. 133 * 134 * @param recentLayoutSetBranchId the primary key of the recent layout set branch 135 * @return the recent layout set branch 136 * @throws PortalException if a recent layout set branch with the primary key could not be found 137 */ 138 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 139 public RecentLayoutSetBranch getRecentLayoutSetBranch( 140 long recentLayoutSetBranchId) throws PortalException; 141 142 /** 143 * Updates the recent layout set branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 144 * 145 * @param recentLayoutSetBranch the recent layout set branch 146 * @return the recent layout set branch that was updated 147 */ 148 @Indexable(type = IndexableType.REINDEX) 149 public RecentLayoutSetBranch updateRecentLayoutSetBranch( 150 RecentLayoutSetBranch recentLayoutSetBranch); 151 152 /** 153 * Returns the number of recent layout set branchs. 154 * 155 * @return the number of recent layout set branchs 156 */ 157 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 158 public int getRecentLayoutSetBranchsCount(); 159 160 /** 161 * Returns the OSGi service identifier. 162 * 163 * @return the OSGi service identifier 164 */ 165 public java.lang.String getOSGiServiceIdentifier(); 166 167 /** 168 * Performs a dynamic query on the database and returns the matching rows. 169 * 170 * @param dynamicQuery the dynamic query 171 * @return the matching rows 172 */ 173 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery); 174 175 /** 176 * Performs a dynamic query on the database and returns a range of the matching rows. 177 * 178 * <p> 179 * 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.RecentLayoutSetBranchModelImpl}. 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. 180 * </p> 181 * 182 * @param dynamicQuery the dynamic query 183 * @param start the lower bound of the range of model instances 184 * @param end the upper bound of the range of model instances (not inclusive) 185 * @return the range of matching rows 186 */ 187 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 188 int end); 189 190 /** 191 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 192 * 193 * <p> 194 * 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.RecentLayoutSetBranchModelImpl}. 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. 195 * </p> 196 * 197 * @param dynamicQuery the dynamic query 198 * @param start the lower bound of the range of model instances 199 * @param end the upper bound of the range of model instances (not inclusive) 200 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 201 * @return the ordered range of matching rows 202 */ 203 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 204 int end, OrderByComparator<T> orderByComparator); 205 206 /** 207 * Returns a range of all the recent layout set branchs. 208 * 209 * <p> 210 * 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.RecentLayoutSetBranchModelImpl}. 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. 211 * </p> 212 * 213 * @param start the lower bound of the range of recent layout set branchs 214 * @param end the upper bound of the range of recent layout set branchs (not inclusive) 215 * @return the range of recent layout set branchs 216 */ 217 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 218 public List<RecentLayoutSetBranch> getRecentLayoutSetBranchs(int start, 219 int end); 220 221 /** 222 * Returns the number of rows matching the dynamic query. 223 * 224 * @param dynamicQuery the dynamic query 225 * @return the number of rows matching the dynamic query 226 */ 227 public long dynamicQueryCount(DynamicQuery dynamicQuery); 228 229 /** 230 * Returns the number of rows matching the dynamic query. 231 * 232 * @param dynamicQuery the dynamic query 233 * @param projection the projection to apply to the query 234 * @return the number of rows matching the dynamic query 235 */ 236 public long dynamicQueryCount(DynamicQuery dynamicQuery, 237 Projection projection); 238 239 public void deleteRecentLayoutSetBranches(long layoutSetBranchId); 240 241 public void deleteUserRecentLayoutSetBranches(long userId); 242 }