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) throws PortalException; 090 091 public void deleteFileEntryMetadata(long fileEntryId) 092 throws PortalException; 093 094 public void deleteFileVersionFileEntryMetadata(long fileVersionId) 095 throws PortalException; 096 097 /** 098 * @throws PortalException 099 */ 100 @Override 101 public com.liferay.portal.model.PersistedModel deletePersistedModel( 102 com.liferay.portal.model.PersistedModel persistedModel) 103 throws PortalException; 104 105 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 106 107 /** 108 * Performs a dynamic query on the database and returns the matching rows. 109 * 110 * @param dynamicQuery the dynamic query 111 * @return the matching rows 112 */ 113 public <T> java.util.List<T> dynamicQuery( 114 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 115 116 /** 117 * Performs a dynamic query on the database and returns a range of the matching rows. 118 * 119 * <p> 120 * 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. 121 * </p> 122 * 123 * @param dynamicQuery the dynamic query 124 * @param start the lower bound of the range of model instances 125 * @param end the upper bound of the range of model instances (not inclusive) 126 * @return the range of matching rows 127 */ 128 public <T> java.util.List<T> dynamicQuery( 129 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 130 int end); 131 132 /** 133 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 134 * 135 * <p> 136 * 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. 137 * </p> 138 * 139 * @param dynamicQuery the dynamic query 140 * @param start the lower bound of the range of model instances 141 * @param end the upper bound of the range of model instances (not inclusive) 142 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 143 * @return the ordered range of matching rows 144 */ 145 public <T> java.util.List<T> dynamicQuery( 146 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 147 int end, 148 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 149 150 /** 151 * Returns the number of rows matching the dynamic query. 152 * 153 * @param dynamicQuery the dynamic query 154 * @return the number of rows matching the dynamic query 155 */ 156 public long dynamicQueryCount( 157 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 158 159 /** 160 * Returns the number of rows matching the dynamic query. 161 * 162 * @param dynamicQuery the dynamic query 163 * @param projection the projection to apply to the query 164 * @return the number of rows matching the dynamic query 165 */ 166 public long dynamicQueryCount( 167 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 168 com.liferay.portal.kernel.dao.orm.Projection projection); 169 170 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 171 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata fetchDLFileEntryMetadata( 172 long fileEntryMetadataId); 173 174 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 175 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata fetchFileEntryMetadata( 176 long ddmStructureId, long fileVersionId); 177 178 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 179 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata fetchFileEntryMetadata( 180 long fileEntryMetadataId); 181 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 184 185 /** 186 * Returns the Spring bean ID for this bean. 187 * 188 * @return the Spring bean ID for this bean 189 */ 190 public java.lang.String getBeanIdentifier(); 191 192 /** 193 * Returns the document library file entry metadata with the primary key. 194 * 195 * @param fileEntryMetadataId the primary key of the document library file entry metadata 196 * @return the document library file entry metadata 197 * @throws PortalException if a document library file entry metadata with the primary key could not be found 198 */ 199 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 200 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getDLFileEntryMetadata( 201 long fileEntryMetadataId) throws PortalException; 202 203 /** 204 * Returns a range of all the document library file entry metadatas. 205 * 206 * <p> 207 * 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. 208 * </p> 209 * 210 * @param start the lower bound of the range of document library file entry metadatas 211 * @param end the upper bound of the range of document library file entry metadatas (not inclusive) 212 * @return the range of document library file entry metadatas 213 */ 214 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 215 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata> getDLFileEntryMetadatas( 216 int start, int end); 217 218 /** 219 * Returns the number of document library file entry metadatas. 220 * 221 * @return the number of document library file entry metadatas 222 */ 223 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 224 public int getDLFileEntryMetadatasCount(); 225 226 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 227 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getFileEntryMetadata( 228 long ddmStructureId, long fileVersionId) throws PortalException; 229 230 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 231 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getFileEntryMetadata( 232 long fileEntryMetadataId) throws PortalException; 233 234 /** 235 * @deprecated As of 6.2.0, replaced by {@link 236 #getFileVersionFileEntryMetadatasCount(long)} 237 */ 238 @java.lang.Deprecated 239 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 240 public long getFileEntryMetadataCount(long fileEntryId, long fileVersionId); 241 242 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 243 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata> getFileVersionFileEntryMetadatas( 244 long fileVersionId); 245 246 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 247 public long getFileVersionFileEntryMetadatasCount(long fileVersionId); 248 249 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 250 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata> getMismatchedCompanyIdFileEntryMetadatas(); 251 252 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 253 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata> getNoStructuresFileEntryMetadatas(); 254 255 @Override 256 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 257 public com.liferay.portal.model.PersistedModel getPersistedModel( 258 java.io.Serializable primaryKeyObj) throws PortalException; 259 260 /** 261 * Sets the Spring bean ID for this bean. 262 * 263 * @param beanIdentifier the Spring bean ID for this bean 264 */ 265 public void setBeanIdentifier(java.lang.String beanIdentifier); 266 267 /** 268 * 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. 269 * 270 * @param dlFileEntryMetadata the document library file entry metadata 271 * @return the document library file entry metadata that was updated 272 */ 273 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 274 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata updateDLFileEntryMetadata( 275 com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata dlFileEntryMetadata); 276 277 public void updateFileEntryMetadata(long companyId, 278 java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> ddmStructures, 279 long fileEntryId, long fileVersionId, 280 java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.DDMFormValues> ddmFormValuesMap, 281 com.liferay.portal.service.ServiceContext serviceContext) 282 throws PortalException; 283 284 public void updateFileEntryMetadata(long fileEntryTypeId, long fileEntryId, 285 long fileVersionId, 286 java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.DDMFormValues> ddmFormValuesMap, 287 com.liferay.portal.service.ServiceContext serviceContext) 288 throws PortalException; 289 }