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.documentlibrary.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 DLFileVersion. This utility wraps 022 * {@link com.liferay.portlet.documentlibrary.service.impl.DLFileVersionLocalServiceImpl} 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 DLFileVersionLocalService 030 * @see com.liferay.portlet.documentlibrary.service.base.DLFileVersionLocalServiceBaseImpl 031 * @see com.liferay.portlet.documentlibrary.service.impl.DLFileVersionLocalServiceImpl 032 * @generated 033 */ 034 public class DLFileVersionLocalServiceUtil { 035 /* 036 * NOTE FOR DEVELOPERS: 037 * 038 * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFileVersionLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 039 */ 040 041 /** 042 * Adds the document library file version to the database. Also notifies the appropriate model listeners. 043 * 044 * @param dlFileVersion the document library file version 045 * @return the document library file version that was added 046 * @throws SystemException if a system exception occurred 047 */ 048 public static com.liferay.portlet.documentlibrary.model.DLFileVersion addDLFileVersion( 049 com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion) 050 throws com.liferay.portal.kernel.exception.SystemException { 051 return getService().addDLFileVersion(dlFileVersion); 052 } 053 054 /** 055 * Creates a new document library file version with the primary key. Does not add the document library file version to the database. 056 * 057 * @param fileVersionId the primary key for the new document library file version 058 * @return the new document library file version 059 */ 060 public static com.liferay.portlet.documentlibrary.model.DLFileVersion createDLFileVersion( 061 long fileVersionId) { 062 return getService().createDLFileVersion(fileVersionId); 063 } 064 065 /** 066 * Deletes the document library file version with the primary key from the database. Also notifies the appropriate model listeners. 067 * 068 * @param fileVersionId the primary key of the document library file version 069 * @return the document library file version that was removed 070 * @throws PortalException if a document library file version with the primary key could not be found 071 * @throws SystemException if a system exception occurred 072 */ 073 public static com.liferay.portlet.documentlibrary.model.DLFileVersion deleteDLFileVersion( 074 long fileVersionId) 075 throws com.liferay.portal.kernel.exception.PortalException, 076 com.liferay.portal.kernel.exception.SystemException { 077 return getService().deleteDLFileVersion(fileVersionId); 078 } 079 080 /** 081 * Deletes the document library file version from the database. Also notifies the appropriate model listeners. 082 * 083 * @param dlFileVersion the document library file version 084 * @return the document library file version that was removed 085 * @throws SystemException if a system exception occurred 086 */ 087 public static com.liferay.portlet.documentlibrary.model.DLFileVersion deleteDLFileVersion( 088 com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion) 089 throws com.liferay.portal.kernel.exception.SystemException { 090 return getService().deleteDLFileVersion(dlFileVersion); 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.documentlibrary.model.impl.DLFileVersionModelImpl}. 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.documentlibrary.model.impl.DLFileVersionModelImpl}. 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.documentlibrary.model.DLFileVersion fetchDLFileVersion( 184 long fileVersionId) 185 throws com.liferay.portal.kernel.exception.SystemException { 186 return getService().fetchDLFileVersion(fileVersionId); 187 } 188 189 /** 190 * Returns the document library file version with the matching UUID and company. 191 * 192 * @param uuid the document library file version's UUID 193 * @param companyId the primary key of the company 194 * @return the matching document library file version, or <code>null</code> if a matching document library file version could not be found 195 * @throws SystemException if a system exception occurred 196 */ 197 public static com.liferay.portlet.documentlibrary.model.DLFileVersion fetchDLFileVersionByUuidAndCompanyId( 198 java.lang.String uuid, long companyId) 199 throws com.liferay.portal.kernel.exception.SystemException { 200 return getService().fetchDLFileVersionByUuidAndCompanyId(uuid, companyId); 201 } 202 203 /** 204 * Returns the document library file version matching the UUID and group. 205 * 206 * @param uuid the document library file version's UUID 207 * @param groupId the primary key of the group 208 * @return the matching document library file version, or <code>null</code> if a matching document library file version could not be found 209 * @throws SystemException if a system exception occurred 210 */ 211 public static com.liferay.portlet.documentlibrary.model.DLFileVersion fetchDLFileVersionByUuidAndGroupId( 212 java.lang.String uuid, long groupId) 213 throws com.liferay.portal.kernel.exception.SystemException { 214 return getService().fetchDLFileVersionByUuidAndGroupId(uuid, groupId); 215 } 216 217 /** 218 * Returns the document library file version with the primary key. 219 * 220 * @param fileVersionId the primary key of the document library file version 221 * @return the document library file version 222 * @throws PortalException if a document library file version with the primary key could not be found 223 * @throws SystemException if a system exception occurred 224 */ 225 public static com.liferay.portlet.documentlibrary.model.DLFileVersion getDLFileVersion( 226 long fileVersionId) 227 throws com.liferay.portal.kernel.exception.PortalException, 228 com.liferay.portal.kernel.exception.SystemException { 229 return getService().getDLFileVersion(fileVersionId); 230 } 231 232 public static com.liferay.portal.model.PersistedModel getPersistedModel( 233 java.io.Serializable primaryKeyObj) 234 throws com.liferay.portal.kernel.exception.PortalException, 235 com.liferay.portal.kernel.exception.SystemException { 236 return getService().getPersistedModel(primaryKeyObj); 237 } 238 239 /** 240 * Returns the document library file version with the matching UUID and company. 241 * 242 * @param uuid the document library file version's UUID 243 * @param companyId the primary key of the company 244 * @return the matching document library file version 245 * @throws PortalException if a matching document library file version could not be found 246 * @throws SystemException if a system exception occurred 247 */ 248 public static com.liferay.portlet.documentlibrary.model.DLFileVersion getDLFileVersionByUuidAndCompanyId( 249 java.lang.String uuid, long companyId) 250 throws com.liferay.portal.kernel.exception.PortalException, 251 com.liferay.portal.kernel.exception.SystemException { 252 return getService().getDLFileVersionByUuidAndCompanyId(uuid, companyId); 253 } 254 255 /** 256 * Returns the document library file version matching the UUID and group. 257 * 258 * @param uuid the document library file version's UUID 259 * @param groupId the primary key of the group 260 * @return the matching document library file version 261 * @throws PortalException if a matching document library file version could not be found 262 * @throws SystemException if a system exception occurred 263 */ 264 public static com.liferay.portlet.documentlibrary.model.DLFileVersion getDLFileVersionByUuidAndGroupId( 265 java.lang.String uuid, long groupId) 266 throws com.liferay.portal.kernel.exception.PortalException, 267 com.liferay.portal.kernel.exception.SystemException { 268 return getService().getDLFileVersionByUuidAndGroupId(uuid, groupId); 269 } 270 271 /** 272 * Returns a range of all the document library file versions. 273 * 274 * <p> 275 * 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.documentlibrary.model.impl.DLFileVersionModelImpl}. 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. 276 * </p> 277 * 278 * @param start the lower bound of the range of document library file versions 279 * @param end the upper bound of the range of document library file versions (not inclusive) 280 * @return the range of document library file versions 281 * @throws SystemException if a system exception occurred 282 */ 283 public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getDLFileVersions( 284 int start, int end) 285 throws com.liferay.portal.kernel.exception.SystemException { 286 return getService().getDLFileVersions(start, end); 287 } 288 289 /** 290 * Returns the number of document library file versions. 291 * 292 * @return the number of document library file versions 293 * @throws SystemException if a system exception occurred 294 */ 295 public static int getDLFileVersionsCount() 296 throws com.liferay.portal.kernel.exception.SystemException { 297 return getService().getDLFileVersionsCount(); 298 } 299 300 /** 301 * Updates the document library file version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 302 * 303 * @param dlFileVersion the document library file version 304 * @return the document library file version that was updated 305 * @throws SystemException if a system exception occurred 306 */ 307 public static com.liferay.portlet.documentlibrary.model.DLFileVersion updateDLFileVersion( 308 com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion) 309 throws com.liferay.portal.kernel.exception.SystemException { 310 return getService().updateDLFileVersion(dlFileVersion); 311 } 312 313 /** 314 * Returns the Spring bean ID for this bean. 315 * 316 * @return the Spring bean ID for this bean 317 */ 318 public static java.lang.String getBeanIdentifier() { 319 return getService().getBeanIdentifier(); 320 } 321 322 /** 323 * Sets the Spring bean ID for this bean. 324 * 325 * @param beanIdentifier the Spring bean ID for this bean 326 */ 327 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 328 getService().setBeanIdentifier(beanIdentifier); 329 } 330 331 public static com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersion( 332 long fileVersionId) 333 throws com.liferay.portal.kernel.exception.PortalException, 334 com.liferay.portal.kernel.exception.SystemException { 335 return getService().getFileVersion(fileVersionId); 336 } 337 338 public static com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersion( 339 long fileEntryId, java.lang.String version) 340 throws com.liferay.portal.kernel.exception.PortalException, 341 com.liferay.portal.kernel.exception.SystemException { 342 return getService().getFileVersion(fileEntryId, version); 343 } 344 345 public static com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersionByUuidAndGroupId( 346 java.lang.String uuid, long groupId) 347 throws com.liferay.portal.kernel.exception.SystemException { 348 return getService().getFileVersionByUuidAndGroupId(uuid, groupId); 349 } 350 351 public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getFileVersions( 352 long fileEntryId, int status) 353 throws com.liferay.portal.kernel.exception.SystemException { 354 return getService().getFileVersions(fileEntryId, status); 355 } 356 357 public static int getFileVersionsCount(long fileEntryId, int status) 358 throws com.liferay.portal.kernel.exception.SystemException { 359 return getService().getFileVersionsCount(fileEntryId, status); 360 } 361 362 public static com.liferay.portlet.documentlibrary.model.DLFileVersion getLatestFileVersion( 363 long fileEntryId, boolean excludeWorkingCopy) 364 throws com.liferay.portal.kernel.exception.PortalException, 365 com.liferay.portal.kernel.exception.SystemException { 366 return getService().getLatestFileVersion(fileEntryId, excludeWorkingCopy); 367 } 368 369 public static com.liferay.portlet.documentlibrary.model.DLFileVersion getLatestFileVersion( 370 long userId, long fileEntryId) 371 throws com.liferay.portal.kernel.exception.PortalException, 372 com.liferay.portal.kernel.exception.SystemException { 373 return getService().getLatestFileVersion(userId, fileEntryId); 374 } 375 376 public static void rebuildTree(long companyId) 377 throws com.liferay.portal.kernel.exception.PortalException, 378 com.liferay.portal.kernel.exception.SystemException { 379 getService().rebuildTree(companyId); 380 } 381 382 public static DLFileVersionLocalService getService() { 383 if (_service == null) { 384 _service = (DLFileVersionLocalService)PortalBeanLocatorUtil.locate(DLFileVersionLocalService.class.getName()); 385 386 ReferenceRegistry.registerReference(DLFileVersionLocalServiceUtil.class, 387 "_service"); 388 } 389 390 return _service; 391 } 392 393 /** 394 * @deprecated As of 6.2.0 395 */ 396 public void setService(DLFileVersionLocalService service) { 397 } 398 399 private static DLFileVersionLocalService _service; 400 }