001 /** 002 * Copyright (c) 2000-present 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 aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.exception.PortalException; 020 import com.liferay.portal.kernel.exception.SystemException; 021 import com.liferay.portal.kernel.search.IndexableType; 022 import com.liferay.portal.kernel.transaction.Isolation; 023 import com.liferay.portal.kernel.transaction.Propagation; 024 import com.liferay.portal.kernel.transaction.Transactional; 025 import com.liferay.portal.service.BaseLocalService; 026 import com.liferay.portal.service.PersistedModelLocalService; 027 028 /** 029 * Provides the local service interface for DLFileEntryMetadata. Methods of this 030 * service will not have security checks based on the propagated JAAS 031 * credentials because this service can only be accessed from within the same 032 * VM. 033 * 034 * @author Brian Wing Shun Chan 035 * @see DLFileEntryMetadataLocalServiceUtil 036 * @see com.liferay.portlet.documentlibrary.service.base.DLFileEntryMetadataLocalServiceBaseImpl 037 * @see com.liferay.portlet.documentlibrary.service.impl.DLFileEntryMetadataLocalServiceImpl 038 * @generated 039 */ 040 @ProviderType 041 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 042 PortalException.class, SystemException.class}) 043 public interface DLFileEntryMetadataLocalService extends BaseLocalService, 044 PersistedModelLocalService { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * Never modify or reference this interface directly. Always use {@link DLFileEntryMetadataLocalServiceUtil} to access the document library file entry metadata local service. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFileEntryMetadataLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 049 */ 050 051 /** 052 * Adds the document library file entry metadata to the database. Also notifies the appropriate model listeners. 053 * 054 * @param dlFileEntryMetadata the document library file entry metadata 055 * @return the document library file entry metadata that was added 056 */ 057 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 058 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata addDLFileEntryMetadata( 059 com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata dlFileEntryMetadata); 060 061 /** 062 * Creates a new document library file entry metadata with the primary key. Does not add the document library file entry metadata to the database. 063 * 064 * @param fileEntryMetadataId the primary key for the new document library file entry metadata 065 * @return the new document library file entry metadata 066 */ 067 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata createDLFileEntryMetadata( 068 long fileEntryMetadataId); 069 070 /** 071 * Deletes the document library file entry metadata from the database. Also notifies the appropriate model listeners. 072 * 073 * @param dlFileEntryMetadata the document library file entry metadata 074 * @return the document library file entry metadata that was removed 075 */ 076 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 077 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata deleteDLFileEntryMetadata( 078 com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata dlFileEntryMetadata); 079 080 /** 081 * Deletes the document library file entry metadata with the primary key from the database. Also notifies the appropriate model listeners. 082 * 083 * @param fileEntryMetadataId the primary key of the document library file entry metadata 084 * @return the document library file entry metadata that was removed 085 * @throws PortalException if a document library file entry metadata with the primary key could not be found 086 */ 087 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 088 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata deleteDLFileEntryMetadata( 089 long fileEntryMetadataId) 090 throws com.liferay.portal.kernel.exception.PortalException; 091 092 public void deleteFileEntryMetadata(long fileEntryId) 093 throws com.liferay.portal.kernel.exception.PortalException; 094 095 public void deleteFileVersionFileEntryMetadata(long fileVersionId) 096 throws com.liferay.portal.kernel.exception.PortalException; 097 098 /** 099 * @throws PortalException 100 */ 101 @Override 102 public com.liferay.portal.model.PersistedModel deletePersistedModel( 103 com.liferay.portal.model.PersistedModel persistedModel) 104 throws com.liferay.portal.kernel.exception.PortalException; 105 106 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 107 108 /** 109 * Performs a dynamic query on the database and returns the matching rows. 110 * 111 * @param dynamicQuery the dynamic query 112 * @return the matching rows 113 */ 114 public <T> java.util.List<T> dynamicQuery( 115 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 116 117 /** 118 * Performs a dynamic query on the database and returns a range of the matching rows. 119 * 120 * <p> 121 * 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. 122 * </p> 123 * 124 * @param dynamicQuery the dynamic query 125 * @param start the lower bound of the range of model instances 126 * @param end the upper bound of the range of model instances (not inclusive) 127 * @return the range of matching rows 128 */ 129 public <T> java.util.List<T> dynamicQuery( 130 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 131 int end); 132 133 /** 134 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 135 * 136 * <p> 137 * 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. 138 * </p> 139 * 140 * @param dynamicQuery the dynamic query 141 * @param start the lower bound of the range of model instances 142 * @param end the upper bound of the range of model instances (not inclusive) 143 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 144 * @return the ordered range of matching rows 145 */ 146 public <T> java.util.List<T> dynamicQuery( 147 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 148 int end, 149 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 150 151 /** 152 * Returns the number of rows matching the dynamic query. 153 * 154 * @param dynamicQuery the dynamic query 155 * @return the number of rows matching the dynamic query 156 */ 157 public long dynamicQueryCount( 158 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 159 160 /** 161 * Returns the number of rows matching the dynamic query. 162 * 163 * @param dynamicQuery the dynamic query 164 * @param projection the projection to apply to the query 165 * @return the number of rows matching the dynamic query 166 */ 167 public long dynamicQueryCount( 168 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 169 com.liferay.portal.kernel.dao.orm.Projection projection); 170 171 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 172 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata fetchDLFileEntryMetadata( 173 long fileEntryMetadataId); 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata fetchFileEntryMetadata( 177 long ddmStructureId, long fileVersionId); 178 179 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 180 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata fetchFileEntryMetadata( 181 long fileEntryMetadataId); 182 183 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 184 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 185 186 /** 187 * Returns the Spring bean ID for this bean. 188 * 189 * @return the Spring bean ID for this bean 190 */ 191 public java.lang.String getBeanIdentifier(); 192 193 /** 194 * Returns the document library file entry metadata with the primary key. 195 * 196 * @param fileEntryMetadataId the primary key of the document library file entry metadata 197 * @return the document library file entry metadata 198 * @throws PortalException if a document library file entry metadata with the primary key could not be found 199 */ 200 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 201 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getDLFileEntryMetadata( 202 long fileEntryMetadataId) 203 throws com.liferay.portal.kernel.exception.PortalException; 204 205 /** 206 * Returns a range of all the document library file entry metadatas. 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. 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. 210 * </p> 211 * 212 * @param start the lower bound of the range of document library file entry metadatas 213 * @param end the upper bound of the range of document library file entry metadatas (not inclusive) 214 * @return the range of document library file entry metadatas 215 */ 216 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 217 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata> getDLFileEntryMetadatas( 218 int start, int end); 219 220 /** 221 * Returns the number of document library file entry metadatas. 222 * 223 * @return the number of document library file entry metadatas 224 */ 225 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 226 public int getDLFileEntryMetadatasCount(); 227 228 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 229 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getFileEntryMetadata( 230 long ddmStructureId, long fileVersionId) 231 throws com.liferay.portal.kernel.exception.PortalException; 232 233 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 234 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getFileEntryMetadata( 235 long fileEntryMetadataId) 236 throws com.liferay.portal.kernel.exception.PortalException; 237 238 /** 239 * @deprecated As of 6.2.0, replaced by {@link 240 #getFileVersionFileEntryMetadatasCount(long)} 241 */ 242 @java.lang.Deprecated 243 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 244 public long getFileEntryMetadataCount(long fileEntryId, long fileVersionId); 245 246 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 247 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata> getFileVersionFileEntryMetadatas( 248 long fileVersionId); 249 250 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 251 public long getFileVersionFileEntryMetadatasCount(long fileVersionId); 252 253 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 254 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata> getMismatchedCompanyIdFileEntryMetadatas(); 255 256 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 257 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata> getNoStructuresFileEntryMetadatas(); 258 259 @Override 260 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 261 public com.liferay.portal.model.PersistedModel getPersistedModel( 262 java.io.Serializable primaryKeyObj) 263 throws com.liferay.portal.kernel.exception.PortalException; 264 265 /** 266 * Sets the Spring bean ID for this bean. 267 * 268 * @param beanIdentifier the Spring bean ID for this bean 269 */ 270 public void setBeanIdentifier(java.lang.String beanIdentifier); 271 272 /** 273 * 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. 274 * 275 * @param dlFileEntryMetadata the document library file entry metadata 276 * @return the document library file entry metadata that was updated 277 */ 278 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 279 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata updateDLFileEntryMetadata( 280 com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata dlFileEntryMetadata); 281 282 public void updateFileEntryMetadata(long companyId, 283 java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> ddmStructures, 284 long fileEntryTypeId, long fileEntryId, long fileVersionId, 285 java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap, 286 com.liferay.portal.service.ServiceContext serviceContext) 287 throws com.liferay.portal.kernel.exception.PortalException; 288 289 public void updateFileEntryMetadata(long fileEntryTypeId, long fileEntryId, 290 long fileVersionId, 291 java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap, 292 com.liferay.portal.service.ServiceContext serviceContext) 293 throws com.liferay.portal.kernel.exception.PortalException; 294 }