001 /** 002 * Copyright (c) 2000-2011 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 entry metadata local service. This utility wraps {@link com.liferay.portlet.documentlibrary.service.impl.DLFileEntryMetadataLocalServiceImpl} 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 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 * @throws PortalException if a document library file entry metadata with the primary key could not be found 070 * @throws SystemException if a system exception occurred 071 */ 072 public static void deleteDLFileEntryMetadata(long fileEntryMetadataId) 073 throws com.liferay.portal.kernel.exception.PortalException, 074 com.liferay.portal.kernel.exception.SystemException { 075 getService().deleteDLFileEntryMetadata(fileEntryMetadataId); 076 } 077 078 /** 079 * Deletes the document library file entry metadata from the database. Also notifies the appropriate model listeners. 080 * 081 * @param dlFileEntryMetadata the document library file entry metadata 082 * @throws SystemException if a system exception occurred 083 */ 084 public static void deleteDLFileEntryMetadata( 085 com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata dlFileEntryMetadata) 086 throws com.liferay.portal.kernel.exception.SystemException { 087 getService().deleteDLFileEntryMetadata(dlFileEntryMetadata); 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 /** 162 * Returns the document library file entry metadata with the primary key. 163 * 164 * @param fileEntryMetadataId the primary key of the document library file entry metadata 165 * @return the document library file entry metadata 166 * @throws PortalException if a document library file entry metadata with the primary key could not be found 167 * @throws SystemException if a system exception occurred 168 */ 169 public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getDLFileEntryMetadata( 170 long fileEntryMetadataId) 171 throws com.liferay.portal.kernel.exception.PortalException, 172 com.liferay.portal.kernel.exception.SystemException { 173 return getService().getDLFileEntryMetadata(fileEntryMetadataId); 174 } 175 176 public static com.liferay.portal.model.PersistedModel getPersistedModel( 177 java.io.Serializable primaryKeyObj) 178 throws com.liferay.portal.kernel.exception.PortalException, 179 com.liferay.portal.kernel.exception.SystemException { 180 return getService().getPersistedModel(primaryKeyObj); 181 } 182 183 /** 184 * Returns a range of all the document library file entry metadatas. 185 * 186 * <p> 187 * 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. 188 * </p> 189 * 190 * @param start the lower bound of the range of document library file entry metadatas 191 * @param end the upper bound of the range of document library file entry metadatas (not inclusive) 192 * @return the range of document library file entry metadatas 193 * @throws SystemException if a system exception occurred 194 */ 195 public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata> getDLFileEntryMetadatas( 196 int start, int end) 197 throws com.liferay.portal.kernel.exception.SystemException { 198 return getService().getDLFileEntryMetadatas(start, end); 199 } 200 201 /** 202 * Returns the number of document library file entry metadatas. 203 * 204 * @return the number of document library file entry metadatas 205 * @throws SystemException if a system exception occurred 206 */ 207 public static int getDLFileEntryMetadatasCount() 208 throws com.liferay.portal.kernel.exception.SystemException { 209 return getService().getDLFileEntryMetadatasCount(); 210 } 211 212 /** 213 * 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. 214 * 215 * @param dlFileEntryMetadata the document library file entry metadata 216 * @return the document library file entry metadata that was updated 217 * @throws SystemException if a system exception occurred 218 */ 219 public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata updateDLFileEntryMetadata( 220 com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata dlFileEntryMetadata) 221 throws com.liferay.portal.kernel.exception.SystemException { 222 return getService().updateDLFileEntryMetadata(dlFileEntryMetadata); 223 } 224 225 /** 226 * 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. 227 * 228 * @param dlFileEntryMetadata the document library file entry metadata 229 * @param merge whether to merge the document library file entry metadata 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. 230 * @return the document library file entry metadata that was updated 231 * @throws SystemException if a system exception occurred 232 */ 233 public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata updateDLFileEntryMetadata( 234 com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata dlFileEntryMetadata, 235 boolean merge) 236 throws com.liferay.portal.kernel.exception.SystemException { 237 return getService().updateDLFileEntryMetadata(dlFileEntryMetadata, merge); 238 } 239 240 /** 241 * Returns the Spring bean ID for this bean. 242 * 243 * @return the Spring bean ID for this bean 244 */ 245 public static java.lang.String getBeanIdentifier() { 246 return getService().getBeanIdentifier(); 247 } 248 249 /** 250 * Sets the Spring bean ID for this bean. 251 * 252 * @param beanIdentifier the Spring bean ID for this bean 253 */ 254 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 255 getService().setBeanIdentifier(beanIdentifier); 256 } 257 258 public static void deleteFileEntryMetadata(long fileEntryId) 259 throws com.liferay.portal.kernel.exception.PortalException, 260 com.liferay.portal.kernel.exception.SystemException { 261 getService().deleteFileEntryMetadata(fileEntryId); 262 } 263 264 public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getFileEntryMetadata( 265 long fileEntryMetadataId) 266 throws com.liferay.portal.kernel.exception.PortalException, 267 com.liferay.portal.kernel.exception.SystemException { 268 return getService().getFileEntryMetadata(fileEntryMetadataId); 269 } 270 271 public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getFileEntryMetadata( 272 long ddmStructureId, long fileVersionId) 273 throws com.liferay.portal.kernel.exception.PortalException, 274 com.liferay.portal.kernel.exception.SystemException { 275 return getService().getFileEntryMetadata(ddmStructureId, fileVersionId); 276 } 277 278 public static long getFileEntryMetadataCount(long fileEntryId, 279 long fileVersionId) 280 throws com.liferay.portal.kernel.exception.SystemException { 281 return getService().getFileEntryMetadataCount(fileEntryId, fileVersionId); 282 } 283 284 public static void updateFileEntryMetadata(long companyId, 285 java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> ddmStructures, 286 long fileEntryTypeId, long fileEntryId, long fileVersionId, 287 java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap, 288 com.liferay.portal.service.ServiceContext serviceContext) 289 throws com.liferay.portal.kernel.exception.PortalException, 290 com.liferay.portal.kernel.exception.SystemException { 291 getService() 292 .updateFileEntryMetadata(companyId, ddmStructures, fileEntryTypeId, 293 fileEntryId, fileVersionId, fieldsMap, serviceContext); 294 } 295 296 public static void updateFileEntryMetadata(long fileEntryTypeId, 297 long fileEntryId, long fileVersionId, 298 java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap, 299 com.liferay.portal.service.ServiceContext serviceContext) 300 throws com.liferay.portal.kernel.exception.PortalException, 301 com.liferay.portal.kernel.exception.SystemException { 302 getService() 303 .updateFileEntryMetadata(fileEntryTypeId, fileEntryId, 304 fileVersionId, fieldsMap, serviceContext); 305 } 306 307 public static DLFileEntryMetadataLocalService getService() { 308 if (_service == null) { 309 _service = (DLFileEntryMetadataLocalService)PortalBeanLocatorUtil.locate(DLFileEntryMetadataLocalService.class.getName()); 310 311 ReferenceRegistry.registerReference(DLFileEntryMetadataLocalServiceUtil.class, 312 "_service"); 313 MethodCache.remove(DLFileEntryMetadataLocalService.class); 314 } 315 316 return _service; 317 } 318 319 public void setService(DLFileEntryMetadataLocalService service) { 320 MethodCache.remove(DLFileEntryMetadataLocalService.class); 321 322 _service = service; 323 324 ReferenceRegistry.registerReference(DLFileEntryMetadataLocalServiceUtil.class, 325 "_service"); 326 MethodCache.remove(DLFileEntryMetadataLocalService.class); 327 } 328 329 private static DLFileEntryMetadataLocalService _service; 330 }