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 064 /** 065 * Adds the release to the database. Also notifies the appropriate model listeners. 066 * 067 * @param release the release 068 * @return the release that was added 069 */ 070 @Indexable(type = IndexableType.REINDEX) 071 public Release addRelease(Release release); 072 073 public Release addRelease(java.lang.String servletContextName, 074 int buildNumber); 075 076 public Release addRelease(java.lang.String servletContextName, 077 java.lang.String schemaVersion); 078 079 /** 080 * Creates a new release with the primary key. Does not add the release to the database. 081 * 082 * @param releaseId the primary key for the new release 083 * @return the new release 084 */ 085 public Release createRelease(long releaseId); 086 087 public void createTablesAndPopulate(); 088 089 /** 090 * @throws PortalException 091 */ 092 @Override 093 public PersistedModel deletePersistedModel(PersistedModel persistedModel) 094 throws PortalException; 095 096 /** 097 * Deletes the release from the database. Also notifies the appropriate model listeners. 098 * 099 * @param release the release 100 * @return the release that was removed 101 */ 102 @Indexable(type = IndexableType.DELETE) 103 public Release deleteRelease(Release release); 104 105 /** 106 * Deletes the release with the primary key from the database. Also notifies the appropriate model listeners. 107 * 108 * @param releaseId the primary key of the release 109 * @return the release that was removed 110 * @throws PortalException if a release with the primary key could not be found 111 */ 112 @Indexable(type = IndexableType.DELETE) 113 public Release deleteRelease(long releaseId) throws PortalException; 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.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. 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.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. 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 Release fetchRelease(long releaseId); 176 177 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 178 public Release fetchRelease(java.lang.String servletContextName); 179 180 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 181 public ActionableDynamicQuery getActionableDynamicQuery(); 182 183 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 184 public int getBuildNumberOrCreate() throws PortalException; 185 186 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 187 public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 188 189 /** 190 * Returns the OSGi service identifier. 191 * 192 * @return the OSGi service identifier 193 */ 194 public java.lang.String getOSGiServiceIdentifier(); 195 196 @Override 197 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 198 public PersistedModel getPersistedModel(Serializable primaryKeyObj) 199 throws PortalException; 200 201 /** 202 * Returns the release with the primary key. 203 * 204 * @param releaseId the primary key of the release 205 * @return the release 206 * @throws PortalException if a release with the primary key could not be found 207 */ 208 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 209 public Release getRelease(long releaseId) throws PortalException; 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 releases. 227 * 228 * @return the number of releases 229 */ 230 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 231 public int getReleasesCount(); 232 233 /** 234 * Updates the release in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 235 * 236 * @param release the release 237 * @return the release that was updated 238 */ 239 @Indexable(type = IndexableType.REINDEX) 240 public Release updateRelease(Release release); 241 242 public Release updateRelease(long releaseId, int buildNumber, 243 Date buildDate, boolean verified) throws PortalException; 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 }