001 /** 002 * Copyright (c) 2000-2012 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.MethodCache; 019 import com.liferay.portal.kernel.util.ReferenceRegistry; 020 021 /** 022 * The utility for the document library file version local service. This utility wraps {@link com.liferay.portlet.documentlibrary.service.impl.DLFileVersionLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server. 023 * 024 * <p> 025 * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM. 026 * </p> 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 * @throws PortalException if a document library file version with the primary key could not be found 070 * @throws SystemException if a system exception occurred 071 */ 072 public static void deleteDLFileVersion(long fileVersionId) 073 throws com.liferay.portal.kernel.exception.PortalException, 074 com.liferay.portal.kernel.exception.SystemException { 075 getService().deleteDLFileVersion(fileVersionId); 076 } 077 078 /** 079 * Deletes the document library file version from the database. Also notifies the appropriate model listeners. 080 * 081 * @param dlFileVersion the document library file version 082 * @throws SystemException if a system exception occurred 083 */ 084 public static void deleteDLFileVersion( 085 com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion) 086 throws com.liferay.portal.kernel.exception.SystemException { 087 getService().deleteDLFileVersion(dlFileVersion); 088 } 089 090 /** 091 * Performs a dynamic query on the database and returns the matching rows. 092 * 093 * @param dynamicQuery the dynamic query 094 * @return the matching rows 095 * @throws SystemException if a system exception occurred 096 */ 097 @SuppressWarnings("rawtypes") 098 public static java.util.List dynamicQuery( 099 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 100 throws com.liferay.portal.kernel.exception.SystemException { 101 return getService().dynamicQuery(dynamicQuery); 102 } 103 104 /** 105 * Performs a dynamic query on the database and returns a range of the matching rows. 106 * 107 * <p> 108 * 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. 109 * </p> 110 * 111 * @param dynamicQuery the dynamic query 112 * @param start the lower bound of the range of model instances 113 * @param end the upper bound of the range of model instances (not inclusive) 114 * @return the range of matching rows 115 * @throws SystemException if a system exception occurred 116 */ 117 @SuppressWarnings("rawtypes") 118 public static java.util.List dynamicQuery( 119 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 120 int end) throws com.liferay.portal.kernel.exception.SystemException { 121 return getService().dynamicQuery(dynamicQuery, start, end); 122 } 123 124 /** 125 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 126 * 127 * <p> 128 * 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. 129 * </p> 130 * 131 * @param dynamicQuery the dynamic query 132 * @param start the lower bound of the range of model instances 133 * @param end the upper bound of the range of model instances (not inclusive) 134 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 135 * @return the ordered range of matching rows 136 * @throws SystemException if a system exception occurred 137 */ 138 @SuppressWarnings("rawtypes") 139 public static java.util.List dynamicQuery( 140 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 141 int end, 142 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 143 throws com.liferay.portal.kernel.exception.SystemException { 144 return getService() 145 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 146 } 147 148 /** 149 * Returns the number of rows that match the dynamic query. 150 * 151 * @param dynamicQuery the dynamic query 152 * @return the number of rows that match the dynamic query 153 * @throws SystemException if a system exception occurred 154 */ 155 public static long dynamicQueryCount( 156 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 157 throws com.liferay.portal.kernel.exception.SystemException { 158 return getService().dynamicQueryCount(dynamicQuery); 159 } 160 161 public static com.liferay.portlet.documentlibrary.model.DLFileVersion fetchDLFileVersion( 162 long fileVersionId) 163 throws com.liferay.portal.kernel.exception.SystemException { 164 return getService().fetchDLFileVersion(fileVersionId); 165 } 166 167 /** 168 * Returns the document library file version with the primary key. 169 * 170 * @param fileVersionId the primary key of the document library file version 171 * @return the document library file version 172 * @throws PortalException if a document library file version with the primary key could not be found 173 * @throws SystemException if a system exception occurred 174 */ 175 public static com.liferay.portlet.documentlibrary.model.DLFileVersion getDLFileVersion( 176 long fileVersionId) 177 throws com.liferay.portal.kernel.exception.PortalException, 178 com.liferay.portal.kernel.exception.SystemException { 179 return getService().getDLFileVersion(fileVersionId); 180 } 181 182 public static com.liferay.portal.model.PersistedModel getPersistedModel( 183 java.io.Serializable primaryKeyObj) 184 throws com.liferay.portal.kernel.exception.PortalException, 185 com.liferay.portal.kernel.exception.SystemException { 186 return getService().getPersistedModel(primaryKeyObj); 187 } 188 189 /** 190 * Returns the document library file version with the UUID in the group. 191 * 192 * @param uuid the UUID of document library file version 193 * @param groupId the group id of the document library file version 194 * @return the document library file version 195 * @throws PortalException if a document library file version with the UUID in the group could not be found 196 * @throws SystemException if a system exception occurred 197 */ 198 public static com.liferay.portlet.documentlibrary.model.DLFileVersion getDLFileVersionByUuidAndGroupId( 199 java.lang.String uuid, long groupId) 200 throws com.liferay.portal.kernel.exception.PortalException, 201 com.liferay.portal.kernel.exception.SystemException { 202 return getService().getDLFileVersionByUuidAndGroupId(uuid, groupId); 203 } 204 205 /** 206 * Returns a range of all the document library file versions. 207 * 208 * <p> 209 * 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. 210 * </p> 211 * 212 * @param start the lower bound of the range of document library file versions 213 * @param end the upper bound of the range of document library file versions (not inclusive) 214 * @return the range of document library file versions 215 * @throws SystemException if a system exception occurred 216 */ 217 public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getDLFileVersions( 218 int start, int end) 219 throws com.liferay.portal.kernel.exception.SystemException { 220 return getService().getDLFileVersions(start, end); 221 } 222 223 /** 224 * Returns the number of document library file versions. 225 * 226 * @return the number of document library file versions 227 * @throws SystemException if a system exception occurred 228 */ 229 public static int getDLFileVersionsCount() 230 throws com.liferay.portal.kernel.exception.SystemException { 231 return getService().getDLFileVersionsCount(); 232 } 233 234 /** 235 * Updates the document library file version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 236 * 237 * @param dlFileVersion the document library file version 238 * @return the document library file version that was updated 239 * @throws SystemException if a system exception occurred 240 */ 241 public static com.liferay.portlet.documentlibrary.model.DLFileVersion updateDLFileVersion( 242 com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion) 243 throws com.liferay.portal.kernel.exception.SystemException { 244 return getService().updateDLFileVersion(dlFileVersion); 245 } 246 247 /** 248 * Updates the document library file version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 249 * 250 * @param dlFileVersion the document library file version 251 * @param merge whether to merge the document library file version with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation. 252 * @return the document library file version that was updated 253 * @throws SystemException if a system exception occurred 254 */ 255 public static com.liferay.portlet.documentlibrary.model.DLFileVersion updateDLFileVersion( 256 com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion, 257 boolean merge) 258 throws com.liferay.portal.kernel.exception.SystemException { 259 return getService().updateDLFileVersion(dlFileVersion, merge); 260 } 261 262 /** 263 * Returns the Spring bean ID for this bean. 264 * 265 * @return the Spring bean ID for this bean 266 */ 267 public static java.lang.String getBeanIdentifier() { 268 return getService().getBeanIdentifier(); 269 } 270 271 /** 272 * Sets the Spring bean ID for this bean. 273 * 274 * @param beanIdentifier the Spring bean ID for this bean 275 */ 276 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 277 getService().setBeanIdentifier(beanIdentifier); 278 } 279 280 public static com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersion( 281 long fileVersionId) 282 throws com.liferay.portal.kernel.exception.PortalException, 283 com.liferay.portal.kernel.exception.SystemException { 284 return getService().getFileVersion(fileVersionId); 285 } 286 287 public static com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersion( 288 long fileEntryId, java.lang.String version) 289 throws com.liferay.portal.kernel.exception.PortalException, 290 com.liferay.portal.kernel.exception.SystemException { 291 return getService().getFileVersion(fileEntryId, version); 292 } 293 294 public static com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersionByUuidAndGroupId( 295 java.lang.String uuid, long groupId) 296 throws com.liferay.portal.kernel.exception.SystemException { 297 return getService().getFileVersionByUuidAndGroupId(uuid, groupId); 298 } 299 300 public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getFileVersions( 301 long fileEntryId, int status) 302 throws com.liferay.portal.kernel.exception.SystemException { 303 return getService().getFileVersions(fileEntryId, status); 304 } 305 306 public static com.liferay.portlet.documentlibrary.model.DLFileVersion getLatestFileVersion( 307 long fileEntryId, boolean excludeWorkingCopy) 308 throws com.liferay.portal.kernel.exception.PortalException, 309 com.liferay.portal.kernel.exception.SystemException { 310 return getService().getLatestFileVersion(fileEntryId, excludeWorkingCopy); 311 } 312 313 public static com.liferay.portlet.documentlibrary.model.DLFileVersion getLatestFileVersion( 314 long userId, long fileEntryId) 315 throws com.liferay.portal.kernel.exception.PortalException, 316 com.liferay.portal.kernel.exception.SystemException { 317 return getService().getLatestFileVersion(userId, fileEntryId); 318 } 319 320 public static DLFileVersionLocalService getService() { 321 if (_service == null) { 322 _service = (DLFileVersionLocalService)PortalBeanLocatorUtil.locate(DLFileVersionLocalService.class.getName()); 323 324 ReferenceRegistry.registerReference(DLFileVersionLocalServiceUtil.class, 325 "_service"); 326 MethodCache.remove(DLFileVersionLocalService.class); 327 } 328 329 return _service; 330 } 331 332 public void setService(DLFileVersionLocalService service) { 333 MethodCache.remove(DLFileVersionLocalService.class); 334 335 _service = service; 336 337 ReferenceRegistry.registerReference(DLFileVersionLocalServiceUtil.class, 338 "_service"); 339 MethodCache.remove(DLFileVersionLocalService.class); 340 } 341 342 private static DLFileVersionLocalService _service; 343 }