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 DLFileEntryMetadata. This utility wraps 022 * {@link com.liferay.portlet.documentlibrary.service.impl.DLFileEntryMetadataLocalServiceImpl} 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 DLFileEntryMetadataLocalService 030 * @see com.liferay.portlet.documentlibrary.service.base.DLFileEntryMetadataLocalServiceBaseImpl 031 * @see com.liferay.portlet.documentlibrary.service.impl.DLFileEntryMetadataLocalServiceImpl 032 * @generated 033 */ 034 public class DLFileEntryMetadataLocalServiceUtil { 035 /* 036 * NOTE FOR DEVELOPERS: 037 * 038 * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFileEntryMetadataLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 039 */ 040 041 /** 042 * Adds the document library file entry metadata to the database. Also notifies the appropriate model listeners. 043 * 044 * @param dlFileEntryMetadata the document library file entry metadata 045 * @return the document library file entry metadata that was added 046 * @throws SystemException if a system exception occurred 047 */ 048 public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata addDLFileEntryMetadata( 049 com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata dlFileEntryMetadata) 050 throws com.liferay.portal.kernel.exception.SystemException { 051 return getService().addDLFileEntryMetadata(dlFileEntryMetadata); 052 } 053 054 /** 055 * Creates a new document library file entry metadata with the primary key. Does not add the document library file entry metadata to the database. 056 * 057 * @param fileEntryMetadataId the primary key for the new document library file entry metadata 058 * @return the new document library file entry metadata 059 */ 060 public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata createDLFileEntryMetadata( 061 long fileEntryMetadataId) { 062 return getService().createDLFileEntryMetadata(fileEntryMetadataId); 063 } 064 065 /** 066 * Deletes the document library file entry metadata with the primary key from the database. Also notifies the appropriate model listeners. 067 * 068 * @param fileEntryMetadataId the primary key of the document library file entry metadata 069 * @return the document library file entry metadata that was removed 070 * @throws PortalException if a document library file entry metadata 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.DLFileEntryMetadata deleteDLFileEntryMetadata( 074 long fileEntryMetadataId) 075 throws com.liferay.portal.kernel.exception.PortalException, 076 com.liferay.portal.kernel.exception.SystemException { 077 return getService().deleteDLFileEntryMetadata(fileEntryMetadataId); 078 } 079 080 /** 081 * Deletes the document library file entry metadata from the database. Also notifies the appropriate model listeners. 082 * 083 * @param dlFileEntryMetadata the document library file entry metadata 084 * @return the document library file entry metadata that was removed 085 * @throws SystemException if a system exception occurred 086 */ 087 public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata deleteDLFileEntryMetadata( 088 com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata dlFileEntryMetadata) 089 throws com.liferay.portal.kernel.exception.SystemException { 090 return getService().deleteDLFileEntryMetadata(dlFileEntryMetadata); 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.DLFileEntryMetadataModelImpl}. 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.DLFileEntryMetadataModelImpl}. 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.DLFileEntryMetadata fetchDLFileEntryMetadata( 184 long fileEntryMetadataId) 185 throws com.liferay.portal.kernel.exception.SystemException { 186 return getService().fetchDLFileEntryMetadata(fileEntryMetadataId); 187 } 188 189 /** 190 * Returns the document library file entry metadata with the primary key. 191 * 192 * @param fileEntryMetadataId the primary key of the document library file entry metadata 193 * @return the document library file entry metadata 194 * @throws PortalException if a document library file entry metadata with the primary key could not be found 195 * @throws SystemException if a system exception occurred 196 */ 197 public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getDLFileEntryMetadata( 198 long fileEntryMetadataId) 199 throws com.liferay.portal.kernel.exception.PortalException, 200 com.liferay.portal.kernel.exception.SystemException { 201 return getService().getDLFileEntryMetadata(fileEntryMetadataId); 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 document library file entry metadatas. 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.documentlibrary.model.impl.DLFileEntryMetadataModelImpl}. 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 document library file entry metadatas 219 * @param end the upper bound of the range of document library file entry metadatas (not inclusive) 220 * @return the range of document library file entry metadatas 221 * @throws SystemException if a system exception occurred 222 */ 223 public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata> getDLFileEntryMetadatas( 224 int start, int end) 225 throws com.liferay.portal.kernel.exception.SystemException { 226 return getService().getDLFileEntryMetadatas(start, end); 227 } 228 229 /** 230 * Returns the number of document library file entry metadatas. 231 * 232 * @return the number of document library file entry metadatas 233 * @throws SystemException if a system exception occurred 234 */ 235 public static int getDLFileEntryMetadatasCount() 236 throws com.liferay.portal.kernel.exception.SystemException { 237 return getService().getDLFileEntryMetadatasCount(); 238 } 239 240 /** 241 * Updates the document library file entry metadata in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 242 * 243 * @param dlFileEntryMetadata the document library file entry metadata 244 * @return the document library file entry metadata that was updated 245 * @throws SystemException if a system exception occurred 246 */ 247 public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata updateDLFileEntryMetadata( 248 com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata dlFileEntryMetadata) 249 throws com.liferay.portal.kernel.exception.SystemException { 250 return getService().updateDLFileEntryMetadata(dlFileEntryMetadata); 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 deleteFileEntryMetadata(long fileEntryId) 272 throws com.liferay.portal.kernel.exception.PortalException, 273 com.liferay.portal.kernel.exception.SystemException { 274 getService().deleteFileEntryMetadata(fileEntryId); 275 } 276 277 public static void deleteFileVersionFileEntryMetadata(long fileVersionId) 278 throws com.liferay.portal.kernel.exception.PortalException, 279 com.liferay.portal.kernel.exception.SystemException { 280 getService().deleteFileVersionFileEntryMetadata(fileVersionId); 281 } 282 283 public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata fetchFileEntryMetadata( 284 long fileEntryMetadataId) 285 throws com.liferay.portal.kernel.exception.SystemException { 286 return getService().fetchFileEntryMetadata(fileEntryMetadataId); 287 } 288 289 public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata fetchFileEntryMetadata( 290 long ddmStructureId, long fileVersionId) 291 throws com.liferay.portal.kernel.exception.SystemException { 292 return getService().fetchFileEntryMetadata(ddmStructureId, fileVersionId); 293 } 294 295 public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getFileEntryMetadata( 296 long fileEntryMetadataId) 297 throws com.liferay.portal.kernel.exception.PortalException, 298 com.liferay.portal.kernel.exception.SystemException { 299 return getService().getFileEntryMetadata(fileEntryMetadataId); 300 } 301 302 public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getFileEntryMetadata( 303 long ddmStructureId, long fileVersionId) 304 throws com.liferay.portal.kernel.exception.PortalException, 305 com.liferay.portal.kernel.exception.SystemException { 306 return getService().getFileEntryMetadata(ddmStructureId, fileVersionId); 307 } 308 309 /** 310 * @deprecated As of 6.2.0, replaced by {@link 311 #getFileVersionFileEntryMetadatasCount(long)} 312 */ 313 public static long getFileEntryMetadataCount(long fileEntryId, 314 long fileVersionId) 315 throws com.liferay.portal.kernel.exception.SystemException { 316 return getService().getFileEntryMetadataCount(fileEntryId, fileVersionId); 317 } 318 319 public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata> getFileVersionFileEntryMetadatas( 320 long fileVersionId) 321 throws com.liferay.portal.kernel.exception.SystemException { 322 return getService().getFileVersionFileEntryMetadatas(fileVersionId); 323 } 324 325 public static long getFileVersionFileEntryMetadatasCount(long fileVersionId) 326 throws com.liferay.portal.kernel.exception.SystemException { 327 return getService().getFileVersionFileEntryMetadatasCount(fileVersionId); 328 } 329 330 public static void updateFileEntryMetadata(long companyId, 331 java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> ddmStructures, 332 long fileEntryTypeId, long fileEntryId, long fileVersionId, 333 java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap, 334 com.liferay.portal.service.ServiceContext serviceContext) 335 throws com.liferay.portal.kernel.exception.PortalException, 336 com.liferay.portal.kernel.exception.SystemException { 337 getService() 338 .updateFileEntryMetadata(companyId, ddmStructures, fileEntryTypeId, 339 fileEntryId, fileVersionId, fieldsMap, serviceContext); 340 } 341 342 public static void updateFileEntryMetadata(long fileEntryTypeId, 343 long fileEntryId, long fileVersionId, 344 java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap, 345 com.liferay.portal.service.ServiceContext serviceContext) 346 throws com.liferay.portal.kernel.exception.PortalException, 347 com.liferay.portal.kernel.exception.SystemException { 348 getService() 349 .updateFileEntryMetadata(fileEntryTypeId, fileEntryId, 350 fileVersionId, fieldsMap, serviceContext); 351 } 352 353 public static DLFileEntryMetadataLocalService getService() { 354 if (_service == null) { 355 _service = (DLFileEntryMetadataLocalService)PortalBeanLocatorUtil.locate(DLFileEntryMetadataLocalService.class.getName()); 356 357 ReferenceRegistry.registerReference(DLFileEntryMetadataLocalServiceUtil.class, 358 "_service"); 359 } 360 361 return _service; 362 } 363 364 /** 365 * @deprecated As of 6.2.0 366 */ 367 public void setService(DLFileEntryMetadataLocalService service) { 368 } 369 370 private static DLFileEntryMetadataLocalService _service; 371 }