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