001 /** 002 * Copyright (c) 2000-2013 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.portlet.trash.service; 016 017 import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil; 018 import com.liferay.portal.kernel.util.ReferenceRegistry; 019 020 /** 021 * Provides the local service utility for TrashVersion. This utility wraps 022 * {@link com.liferay.portlet.trash.service.impl.TrashVersionLocalServiceImpl} and is the 023 * primary access point for service operations in application layer code running 024 * on the local server. Methods of this service will not have security checks 025 * based on the propagated JAAS credentials because this service can only be 026 * accessed from within the same VM. 027 * 028 * @author Brian Wing Shun Chan 029 * @see TrashVersionLocalService 030 * @see com.liferay.portlet.trash.service.base.TrashVersionLocalServiceBaseImpl 031 * @see com.liferay.portlet.trash.service.impl.TrashVersionLocalServiceImpl 032 * @generated 033 */ 034 public class TrashVersionLocalServiceUtil { 035 /* 036 * NOTE FOR DEVELOPERS: 037 * 038 * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.trash.service.impl.TrashVersionLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 039 */ 040 041 /** 042 * Adds the trash version to the database. Also notifies the appropriate model listeners. 043 * 044 * @param trashVersion the trash version 045 * @return the trash version that was added 046 * @throws SystemException if a system exception occurred 047 */ 048 public static com.liferay.portlet.trash.model.TrashVersion addTrashVersion( 049 com.liferay.portlet.trash.model.TrashVersion trashVersion) 050 throws com.liferay.portal.kernel.exception.SystemException { 051 return getService().addTrashVersion(trashVersion); 052 } 053 054 /** 055 * Creates a new trash version with the primary key. Does not add the trash version to the database. 056 * 057 * @param versionId the primary key for the new trash version 058 * @return the new trash version 059 */ 060 public static com.liferay.portlet.trash.model.TrashVersion createTrashVersion( 061 long versionId) { 062 return getService().createTrashVersion(versionId); 063 } 064 065 /** 066 * Deletes the trash version with the primary key from the database. Also notifies the appropriate model listeners. 067 * 068 * @param versionId the primary key of the trash version 069 * @return the trash version that was removed 070 * @throws PortalException if a trash version with the primary key could not be found 071 * @throws SystemException if a system exception occurred 072 */ 073 public static com.liferay.portlet.trash.model.TrashVersion deleteTrashVersion( 074 long versionId) 075 throws com.liferay.portal.kernel.exception.PortalException, 076 com.liferay.portal.kernel.exception.SystemException { 077 return getService().deleteTrashVersion(versionId); 078 } 079 080 /** 081 * Deletes the trash version from the database. Also notifies the appropriate model listeners. 082 * 083 * @param trashVersion the trash version 084 * @return the trash version that was removed 085 * @throws SystemException if a system exception occurred 086 */ 087 public static com.liferay.portlet.trash.model.TrashVersion deleteTrashVersion( 088 com.liferay.portlet.trash.model.TrashVersion trashVersion) 089 throws com.liferay.portal.kernel.exception.SystemException { 090 return getService().deleteTrashVersion(trashVersion); 091 } 092 093 public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 094 return getService().dynamicQuery(); 095 } 096 097 /** 098 * Performs a dynamic query on the database and returns the matching rows. 099 * 100 * @param dynamicQuery the dynamic query 101 * @return the matching rows 102 * @throws SystemException if a system exception occurred 103 */ 104 @SuppressWarnings("rawtypes") 105 public static java.util.List dynamicQuery( 106 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 107 throws com.liferay.portal.kernel.exception.SystemException { 108 return getService().dynamicQuery(dynamicQuery); 109 } 110 111 /** 112 * Performs a dynamic query on the database and returns a range of the matching rows. 113 * 114 * <p> 115 * 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.portlet.trash.model.impl.TrashVersionModelImpl}. 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. 116 * </p> 117 * 118 * @param dynamicQuery the dynamic query 119 * @param start the lower bound of the range of model instances 120 * @param end the upper bound of the range of model instances (not inclusive) 121 * @return the range of matching rows 122 * @throws SystemException if a system exception occurred 123 */ 124 @SuppressWarnings("rawtypes") 125 public static java.util.List dynamicQuery( 126 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 127 int end) throws com.liferay.portal.kernel.exception.SystemException { 128 return getService().dynamicQuery(dynamicQuery, start, end); 129 } 130 131 /** 132 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 133 * 134 * <p> 135 * 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.portlet.trash.model.impl.TrashVersionModelImpl}. 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. 136 * </p> 137 * 138 * @param dynamicQuery the dynamic query 139 * @param start the lower bound of the range of model instances 140 * @param end the upper bound of the range of model instances (not inclusive) 141 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 142 * @return the ordered range of matching rows 143 * @throws SystemException if a system exception occurred 144 */ 145 @SuppressWarnings("rawtypes") 146 public static java.util.List dynamicQuery( 147 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 148 int end, 149 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 150 throws com.liferay.portal.kernel.exception.SystemException { 151 return getService() 152 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 153 } 154 155 /** 156 * Returns the number of rows that match the dynamic query. 157 * 158 * @param dynamicQuery the dynamic query 159 * @return the number of rows that match the dynamic query 160 * @throws SystemException if a system exception occurred 161 */ 162 public static long dynamicQueryCount( 163 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 164 throws com.liferay.portal.kernel.exception.SystemException { 165 return getService().dynamicQueryCount(dynamicQuery); 166 } 167 168 /** 169 * Returns the number of rows that match the dynamic query. 170 * 171 * @param dynamicQuery the dynamic query 172 * @param projection the projection to apply to the query 173 * @return the number of rows that match the dynamic query 174 * @throws SystemException if a system exception occurred 175 */ 176 public static long dynamicQueryCount( 177 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 178 com.liferay.portal.kernel.dao.orm.Projection projection) 179 throws com.liferay.portal.kernel.exception.SystemException { 180 return getService().dynamicQueryCount(dynamicQuery, projection); 181 } 182 183 public static com.liferay.portlet.trash.model.TrashVersion fetchTrashVersion( 184 long versionId) 185 throws com.liferay.portal.kernel.exception.SystemException { 186 return getService().fetchTrashVersion(versionId); 187 } 188 189 /** 190 * Returns the trash version with the primary key. 191 * 192 * @param versionId the primary key of the trash version 193 * @return the trash version 194 * @throws PortalException if a trash version with the primary key could not be found 195 * @throws SystemException if a system exception occurred 196 */ 197 public static com.liferay.portlet.trash.model.TrashVersion getTrashVersion( 198 long versionId) 199 throws com.liferay.portal.kernel.exception.PortalException, 200 com.liferay.portal.kernel.exception.SystemException { 201 return getService().getTrashVersion(versionId); 202 } 203 204 public static com.liferay.portal.model.PersistedModel getPersistedModel( 205 java.io.Serializable primaryKeyObj) 206 throws com.liferay.portal.kernel.exception.PortalException, 207 com.liferay.portal.kernel.exception.SystemException { 208 return getService().getPersistedModel(primaryKeyObj); 209 } 210 211 /** 212 * Returns a range of all the trash versions. 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.portlet.trash.model.impl.TrashVersionModelImpl}. 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 trash versions 219 * @param end the upper bound of the range of trash versions (not inclusive) 220 * @return the range of trash versions 221 * @throws SystemException if a system exception occurred 222 */ 223 public static java.util.List<com.liferay.portlet.trash.model.TrashVersion> getTrashVersions( 224 int start, int end) 225 throws com.liferay.portal.kernel.exception.SystemException { 226 return getService().getTrashVersions(start, end); 227 } 228 229 /** 230 * Returns the number of trash versions. 231 * 232 * @return the number of trash versions 233 * @throws SystemException if a system exception occurred 234 */ 235 public static int getTrashVersionsCount() 236 throws com.liferay.portal.kernel.exception.SystemException { 237 return getService().getTrashVersionsCount(); 238 } 239 240 /** 241 * Updates the trash version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 242 * 243 * @param trashVersion the trash version 244 * @return the trash version that was updated 245 * @throws SystemException if a system exception occurred 246 */ 247 public static com.liferay.portlet.trash.model.TrashVersion updateTrashVersion( 248 com.liferay.portlet.trash.model.TrashVersion trashVersion) 249 throws com.liferay.portal.kernel.exception.SystemException { 250 return getService().updateTrashVersion(trashVersion); 251 } 252 253 /** 254 * Returns the Spring bean ID for this bean. 255 * 256 * @return the Spring bean ID for this bean 257 */ 258 public static java.lang.String getBeanIdentifier() { 259 return getService().getBeanIdentifier(); 260 } 261 262 /** 263 * Sets the Spring bean ID for this bean. 264 * 265 * @param beanIdentifier the Spring bean ID for this bean 266 */ 267 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 268 getService().setBeanIdentifier(beanIdentifier); 269 } 270 271 public static void addTrashVersion(long trashEntryId, 272 java.lang.String className, long classPK, int status) 273 throws com.liferay.portal.kernel.exception.SystemException { 274 getService().addTrashVersion(trashEntryId, className, classPK, status); 275 } 276 277 public static com.liferay.portlet.trash.model.TrashVersion fetchVersion( 278 long entryId, java.lang.String className, long classPK) 279 throws com.liferay.portal.kernel.exception.SystemException { 280 return getService().fetchVersion(entryId, className, classPK); 281 } 282 283 public static java.util.List<com.liferay.portlet.trash.model.TrashVersion> getVersions( 284 long entryId) 285 throws com.liferay.portal.kernel.exception.SystemException { 286 return getService().getVersions(entryId); 287 } 288 289 public static java.util.List<com.liferay.portlet.trash.model.TrashVersion> getVersions( 290 long entryId, java.lang.String className) 291 throws com.liferay.portal.kernel.exception.SystemException { 292 return getService().getVersions(entryId, className); 293 } 294 295 /** 296 * Returns all the trash versions associated with the trash entry. 297 * 298 * @param className the class name of the trash entity 299 * @param classPK the primary key of the trash entity 300 * @return all the trash versions associated with the trash entry 301 * @throws SystemException if a system exception occurred 302 */ 303 public static java.util.List<com.liferay.portlet.trash.model.TrashVersion> getVersions( 304 java.lang.String className, long classPK) 305 throws com.liferay.portal.kernel.exception.SystemException { 306 return getService().getVersions(className, classPK); 307 } 308 309 public static TrashVersionLocalService getService() { 310 if (_service == null) { 311 _service = (TrashVersionLocalService)PortalBeanLocatorUtil.locate(TrashVersionLocalService.class.getName()); 312 313 ReferenceRegistry.registerReference(TrashVersionLocalServiceUtil.class, 314 "_service"); 315 } 316 317 return _service; 318 } 319 320 /** 321 * @deprecated As of 6.2.0 322 */ 323 public void setService(TrashVersionLocalService service) { 324 } 325 326 private static TrashVersionLocalService _service; 327 }