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 061 /** 062 * Adds the recent layout set branch to the database. Also notifies the appropriate model listeners. 063 * 064 * @param recentLayoutSetBranch the recent layout set branch 065 * @return the recent layout set branch that was added 066 */ 067 @Indexable(type = IndexableType.REINDEX) 068 public RecentLayoutSetBranch addRecentLayoutSetBranch( 069 RecentLayoutSetBranch recentLayoutSetBranch); 070 071 public RecentLayoutSetBranch addRecentLayoutSetBranch(long userId, 072 long layoutSetBranchId, long layoutSetId) throws PortalException; 073 074 /** 075 * Creates a new recent layout set branch with the primary key. Does not add the recent layout set branch to the database. 076 * 077 * @param recentLayoutSetBranchId the primary key for the new recent layout set branch 078 * @return the new recent layout set branch 079 */ 080 public RecentLayoutSetBranch createRecentLayoutSetBranch( 081 long recentLayoutSetBranchId); 082 083 /** 084 * @throws PortalException 085 */ 086 @Override 087 public PersistedModel deletePersistedModel(PersistedModel persistedModel) 088 throws PortalException; 089 090 /** 091 * Deletes the recent layout set branch from the database. Also notifies the appropriate model listeners. 092 * 093 * @param recentLayoutSetBranch the recent layout set branch 094 * @return the recent layout set branch that was removed 095 */ 096 @Indexable(type = IndexableType.DELETE) 097 public RecentLayoutSetBranch deleteRecentLayoutSetBranch( 098 RecentLayoutSetBranch recentLayoutSetBranch); 099 100 /** 101 * Deletes the recent layout set branch with the primary key from the database. Also notifies the appropriate model listeners. 102 * 103 * @param recentLayoutSetBranchId the primary key of the recent layout set branch 104 * @return the recent layout set branch that was removed 105 * @throws PortalException if a recent layout set branch with the primary key could not be found 106 */ 107 @Indexable(type = IndexableType.DELETE) 108 public RecentLayoutSetBranch deleteRecentLayoutSetBranch( 109 long recentLayoutSetBranchId) throws PortalException; 110 111 public void deleteRecentLayoutSetBranches(long layoutSetBranchId); 112 113 public void deleteUserRecentLayoutSetBranches(long userId); 114 115 public DynamicQuery dynamicQuery(); 116 117 /** 118 * Performs a dynamic query on the database and returns the matching rows. 119 * 120 * @param dynamicQuery the dynamic query 121 * @return the matching rows 122 */ 123 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery); 124 125 /** 126 * Performs a dynamic query on the database and returns a range of the matching rows. 127 * 128 * <p> 129 * 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. 130 * </p> 131 * 132 * @param dynamicQuery the dynamic query 133 * @param start the lower bound of the range of model instances 134 * @param end the upper bound of the range of model instances (not inclusive) 135 * @return the range of matching rows 136 */ 137 public <T> List<T> dynamicQuery(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.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. 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> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 154 int end, OrderByComparator<T> orderByComparator); 155 156 /** 157 * Returns the number of rows matching the dynamic query. 158 * 159 * @param dynamicQuery the dynamic query 160 * @return the number of rows matching the dynamic query 161 */ 162 public long dynamicQueryCount(DynamicQuery dynamicQuery); 163 164 /** 165 * Returns the number of rows matching the dynamic query. 166 * 167 * @param dynamicQuery the dynamic query 168 * @param projection the projection to apply to the query 169 * @return the number of rows matching the dynamic query 170 */ 171 public long dynamicQueryCount(DynamicQuery dynamicQuery, 172 Projection projection); 173 174 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 175 public RecentLayoutSetBranch fetchRecentLayoutSetBranch( 176 long recentLayoutSetBranchId); 177 178 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 179 public RecentLayoutSetBranch fetchRecentLayoutSetBranch(long userId, 180 long layoutSetId); 181 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public ActionableDynamicQuery getActionableDynamicQuery(); 184 185 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 186 public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 187 188 /** 189 * Returns the OSGi service identifier. 190 * 191 * @return the OSGi service identifier 192 */ 193 public java.lang.String getOSGiServiceIdentifier(); 194 195 @Override 196 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 197 public PersistedModel getPersistedModel(Serializable primaryKeyObj) 198 throws PortalException; 199 200 /** 201 * Returns the recent layout set branch with the primary key. 202 * 203 * @param recentLayoutSetBranchId the primary key of the recent layout set branch 204 * @return the recent layout set branch 205 * @throws PortalException if a recent layout set branch with the primary key could not be found 206 */ 207 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 208 public RecentLayoutSetBranch getRecentLayoutSetBranch( 209 long recentLayoutSetBranchId) throws PortalException; 210 211 /** 212 * Returns a range of all the recent layout set branchs. 213 * 214 * <p> 215 * 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. 216 * </p> 217 * 218 * @param start the lower bound of the range of recent layout set branchs 219 * @param end the upper bound of the range of recent layout set branchs (not inclusive) 220 * @return the range of recent layout set branchs 221 */ 222 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 223 public List<RecentLayoutSetBranch> getRecentLayoutSetBranchs(int start, 224 int end); 225 226 /** 227 * Returns the number of recent layout set branchs. 228 * 229 * @return the number of recent layout set branchs 230 */ 231 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 232 public int getRecentLayoutSetBranchsCount(); 233 234 /** 235 * Updates the recent layout set branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 236 * 237 * @param recentLayoutSetBranch the recent layout set branch 238 * @return the recent layout set branch that was updated 239 */ 240 @Indexable(type = IndexableType.REINDEX) 241 public RecentLayoutSetBranch updateRecentLayoutSetBranch( 242 RecentLayoutSetBranch recentLayoutSetBranch); 243 }