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.RecentLayoutBranch; 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 RecentLayoutBranch. 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 RecentLayoutBranchLocalServiceUtil 046 * @see com.liferay.portal.service.base.RecentLayoutBranchLocalServiceBaseImpl 047 * @see com.liferay.portal.service.impl.RecentLayoutBranchLocalServiceImpl 048 * @generated 049 */ 050 @ProviderType 051 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 052 PortalException.class, SystemException.class}) 053 public interface RecentLayoutBranchLocalService extends BaseLocalService, 054 PersistedModelLocalService { 055 /* 056 * NOTE FOR DEVELOPERS: 057 * 058 * Never modify or reference this interface directly. Always use {@link RecentLayoutBranchLocalServiceUtil} to access the recent layout branch local service. Add custom service methods to {@link com.liferay.portal.service.impl.RecentLayoutBranchLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 059 */ 060 061 /** 062 * Adds the recent layout branch to the database. Also notifies the appropriate model listeners. 063 * 064 * @param recentLayoutBranch the recent layout branch 065 * @return the recent layout branch that was added 066 */ 067 @Indexable(type = IndexableType.REINDEX) 068 public RecentLayoutBranch addRecentLayoutBranch( 069 RecentLayoutBranch recentLayoutBranch); 070 071 public RecentLayoutBranch addRecentLayoutBranch(long userId, 072 long layoutBranchId, long layoutSetBranchId, long plid) 073 throws PortalException; 074 075 /** 076 * Creates a new recent layout branch with the primary key. Does not add the recent layout branch to the database. 077 * 078 * @param recentLayoutBranchId the primary key for the new recent layout branch 079 * @return the new recent layout branch 080 */ 081 public RecentLayoutBranch createRecentLayoutBranch( 082 long recentLayoutBranchId); 083 084 /** 085 * @throws PortalException 086 */ 087 @Override 088 public PersistedModel deletePersistedModel(PersistedModel persistedModel) 089 throws PortalException; 090 091 /** 092 * Deletes the recent layout branch from the database. Also notifies the appropriate model listeners. 093 * 094 * @param recentLayoutBranch the recent layout branch 095 * @return the recent layout branch that was removed 096 */ 097 @Indexable(type = IndexableType.DELETE) 098 public RecentLayoutBranch deleteRecentLayoutBranch( 099 RecentLayoutBranch recentLayoutBranch); 100 101 /** 102 * Deletes the recent layout branch with the primary key from the database. Also notifies the appropriate model listeners. 103 * 104 * @param recentLayoutBranchId the primary key of the recent layout branch 105 * @return the recent layout branch that was removed 106 * @throws PortalException if a recent layout branch with the primary key could not be found 107 */ 108 @Indexable(type = IndexableType.DELETE) 109 public RecentLayoutBranch deleteRecentLayoutBranch( 110 long recentLayoutBranchId) throws PortalException; 111 112 public void deleteRecentLayoutBranches(long layoutBranchId); 113 114 public void deleteUserRecentLayoutBranches(long userId); 115 116 public DynamicQuery dynamicQuery(); 117 118 /** 119 * Performs a dynamic query on the database and returns the matching rows. 120 * 121 * @param dynamicQuery the dynamic query 122 * @return the matching rows 123 */ 124 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery); 125 126 /** 127 * Performs a dynamic query on the database and returns a range of the matching rows. 128 * 129 * <p> 130 * 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.RecentLayoutBranchModelImpl}. 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. 131 * </p> 132 * 133 * @param dynamicQuery the dynamic query 134 * @param start the lower bound of the range of model instances 135 * @param end the upper bound of the range of model instances (not inclusive) 136 * @return the range of matching rows 137 */ 138 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 139 int end); 140 141 /** 142 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 143 * 144 * <p> 145 * 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.RecentLayoutBranchModelImpl}. 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. 146 * </p> 147 * 148 * @param dynamicQuery the dynamic query 149 * @param start the lower bound of the range of model instances 150 * @param end the upper bound of the range of model instances (not inclusive) 151 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 152 * @return the ordered range of matching rows 153 */ 154 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 155 int end, 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(DynamicQuery dynamicQuery); 164 165 /** 166 * Returns the number of rows matching the dynamic query. 167 * 168 * @param dynamicQuery the dynamic query 169 * @param projection the projection to apply to the query 170 * @return the number of rows matching the dynamic query 171 */ 172 public long dynamicQueryCount(DynamicQuery dynamicQuery, 173 Projection projection); 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public RecentLayoutBranch fetchRecentLayoutBranch(long recentLayoutBranchId); 177 178 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 179 public RecentLayoutBranch fetchRecentLayoutBranch(long userId, 180 long layoutSetBranchId, long plid); 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 branch with the primary key. 202 * 203 * @param recentLayoutBranchId the primary key of the recent layout branch 204 * @return the recent layout branch 205 * @throws PortalException if a recent layout branch with the primary key could not be found 206 */ 207 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 208 public RecentLayoutBranch getRecentLayoutBranch(long recentLayoutBranchId) 209 throws PortalException; 210 211 /** 212 * Returns a range of all the recent layout 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.RecentLayoutBranchModelImpl}. 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 branchs 219 * @param end the upper bound of the range of recent layout branchs (not inclusive) 220 * @return the range of recent layout branchs 221 */ 222 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 223 public List<RecentLayoutBranch> getRecentLayoutBranchs(int start, int end); 224 225 /** 226 * Returns the number of recent layout branchs. 227 * 228 * @return the number of recent layout branchs 229 */ 230 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 231 public int getRecentLayoutBranchsCount(); 232 233 /** 234 * Updates the recent layout branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 235 * 236 * @param recentLayoutBranch the recent layout branch 237 * @return the recent layout branch that was updated 238 */ 239 @Indexable(type = IndexableType.REINDEX) 240 public RecentLayoutBranch updateRecentLayoutBranch( 241 RecentLayoutBranch recentLayoutBranch); 242 }