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.Release; 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.upgrade.UpgradeProcess; 033 import com.liferay.portal.kernel.util.OrderByComparator; 034 035 import java.io.Serializable; 036 037 import java.util.Date; 038 import java.util.List; 039 import java.util.Properties; 040 041 /** 042 * Provides the local service interface for Release. Methods of this 043 * service will not have security checks based on the propagated JAAS 044 * credentials because this service can only be accessed from within the same 045 * VM. 046 * 047 * @author Brian Wing Shun Chan 048 * @see ReleaseLocalServiceUtil 049 * @see com.liferay.portal.service.base.ReleaseLocalServiceBaseImpl 050 * @see com.liferay.portal.service.impl.ReleaseLocalServiceImpl 051 * @generated 052 */ 053 @ProviderType 054 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 055 PortalException.class, SystemException.class}) 056 public interface ReleaseLocalService extends BaseLocalService, 057 PersistedModelLocalService { 058 /* 059 * NOTE FOR DEVELOPERS: 060 * 061 * Never modify or reference this interface directly. Always use {@link ReleaseLocalServiceUtil} to access the release local service. Add custom service methods to {@link com.liferay.portal.service.impl.ReleaseLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 062 */ 063 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 064 public ActionableDynamicQuery getActionableDynamicQuery(); 065 066 public DynamicQuery dynamicQuery(); 067 068 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 069 public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 070 071 /** 072 * @throws PortalException 073 */ 074 @Override 075 public PersistedModel deletePersistedModel(PersistedModel persistedModel) 076 throws PortalException; 077 078 @Override 079 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 080 public PersistedModel getPersistedModel(Serializable primaryKeyObj) 081 throws PortalException; 082 083 /** 084 * Adds the release to the database. Also notifies the appropriate model listeners. 085 * 086 * @param release the release 087 * @return the release that was added 088 */ 089 @Indexable(type = IndexableType.REINDEX) 090 public Release addRelease(Release release); 091 092 public Release addRelease(java.lang.String servletContextName, 093 int buildNumber); 094 095 public Release addRelease(java.lang.String servletContextName, 096 java.lang.String schemaVersion); 097 098 /** 099 * Creates a new release with the primary key. Does not add the release to the database. 100 * 101 * @param releaseId the primary key for the new release 102 * @return the new release 103 */ 104 public Release createRelease(long releaseId); 105 106 /** 107 * Deletes the release from the database. Also notifies the appropriate model listeners. 108 * 109 * @param release the release 110 * @return the release that was removed 111 */ 112 @Indexable(type = IndexableType.DELETE) 113 public Release deleteRelease(Release release); 114 115 /** 116 * Deletes the release with the primary key from the database. Also notifies the appropriate model listeners. 117 * 118 * @param releaseId the primary key of the release 119 * @return the release that was removed 120 * @throws PortalException if a release with the primary key could not be found 121 */ 122 @Indexable(type = IndexableType.DELETE) 123 public Release deleteRelease(long releaseId) throws PortalException; 124 125 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 126 public Release fetchRelease(java.lang.String servletContextName); 127 128 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 129 public Release fetchRelease(long releaseId); 130 131 /** 132 * Returns the release with the primary key. 133 * 134 * @param releaseId the primary key of the release 135 * @return the release 136 * @throws PortalException if a release with the primary key could not be found 137 */ 138 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 139 public Release getRelease(long releaseId) throws PortalException; 140 141 /** 142 * Updates the release in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 143 * 144 * @param release the release 145 * @return the release that was updated 146 */ 147 @Indexable(type = IndexableType.REINDEX) 148 public Release updateRelease(Release release); 149 150 public Release updateRelease(long releaseId, 151 java.lang.String schemaVersion, int buildNumber, Date buildDate, 152 boolean verified) throws PortalException; 153 154 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 155 public int getBuildNumberOrCreate() throws PortalException; 156 157 /** 158 * Returns the number of releases. 159 * 160 * @return the number of releases 161 */ 162 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 163 public int getReleasesCount(); 164 165 /** 166 * Returns the OSGi service identifier. 167 * 168 * @return the OSGi service identifier 169 */ 170 public java.lang.String getOSGiServiceIdentifier(); 171 172 /** 173 * Performs a dynamic query on the database and returns the matching rows. 174 * 175 * @param dynamicQuery the dynamic query 176 * @return the matching rows 177 */ 178 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery); 179 180 /** 181 * Performs a dynamic query on the database and returns a range of the matching rows. 182 * 183 * <p> 184 * 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.ReleaseModelImpl}. 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. 185 * </p> 186 * 187 * @param dynamicQuery the dynamic query 188 * @param start the lower bound of the range of model instances 189 * @param end the upper bound of the range of model instances (not inclusive) 190 * @return the range of matching rows 191 */ 192 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 193 int end); 194 195 /** 196 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 197 * 198 * <p> 199 * 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.ReleaseModelImpl}. 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. 200 * </p> 201 * 202 * @param dynamicQuery the dynamic query 203 * @param start the lower bound of the range of model instances 204 * @param end the upper bound of the range of model instances (not inclusive) 205 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 206 * @return the ordered range of matching rows 207 */ 208 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 209 int end, OrderByComparator<T> orderByComparator); 210 211 /** 212 * Returns a range of all the releases. 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.ReleaseModelImpl}. 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 releases 219 * @param end the upper bound of the range of releases (not inclusive) 220 * @return the range of releases 221 */ 222 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 223 public List<Release> getReleases(int start, int end); 224 225 /** 226 * Returns the number of rows matching the dynamic query. 227 * 228 * @param dynamicQuery the dynamic query 229 * @return the number of rows matching the dynamic query 230 */ 231 public long dynamicQueryCount(DynamicQuery dynamicQuery); 232 233 /** 234 * Returns the number of rows matching the dynamic query. 235 * 236 * @param dynamicQuery the dynamic query 237 * @param projection the projection to apply to the query 238 * @return the number of rows matching the dynamic query 239 */ 240 public long dynamicQueryCount(DynamicQuery dynamicQuery, 241 Projection projection); 242 243 public void createTablesAndPopulate(); 244 245 public void updateRelease(java.lang.String servletContextName, 246 java.lang.String schemaVersion, java.lang.String previousSchemaVersion); 247 248 public void updateRelease(java.lang.String servletContextName, 249 List<UpgradeProcess> upgradeProcesses, int buildNumber, 250 int previousBuildNumber, boolean indexOnUpgrade) 251 throws PortalException; 252 253 public void updateRelease(java.lang.String servletContextName, 254 List<UpgradeProcess> upgradeProcesses, 255 Properties unfilteredPortalProperties) throws java.lang.Exception; 256 }