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.exception.PortalException; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.kernel.transaction.Isolation; 020 import com.liferay.portal.kernel.transaction.Propagation; 021 import com.liferay.portal.kernel.transaction.Transactional; 022 import com.liferay.portal.service.BaseLocalService; 023 import com.liferay.portal.service.PersistedModelLocalService; 024 025 /** 026 * The interface for the document library file entry metadata local service. 027 * 028 * <p> 029 * 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. 030 * </p> 031 * 032 * @author Brian Wing Shun Chan 033 * @see DLFileEntryMetadataLocalServiceUtil 034 * @see com.liferay.portlet.documentlibrary.service.base.DLFileEntryMetadataLocalServiceBaseImpl 035 * @see com.liferay.portlet.documentlibrary.service.impl.DLFileEntryMetadataLocalServiceImpl 036 * @generated 037 */ 038 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 039 PortalException.class, SystemException.class}) 040 public interface DLFileEntryMetadataLocalService extends BaseLocalService, 041 PersistedModelLocalService { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * 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. 046 */ 047 048 /** 049 * Adds the document library file entry metadata to the database. Also notifies the appropriate model listeners. 050 * 051 * @param dlFileEntryMetadata the document library file entry metadata 052 * @return the document library file entry metadata that was added 053 * @throws SystemException if a system exception occurred 054 */ 055 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata addDLFileEntryMetadata( 056 com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata dlFileEntryMetadata) 057 throws com.liferay.portal.kernel.exception.SystemException; 058 059 /** 060 * Creates a new document library file entry metadata with the primary key. Does not add the document library file entry metadata to the database. 061 * 062 * @param fileEntryMetadataId the primary key for the new document library file entry metadata 063 * @return the new document library file entry metadata 064 */ 065 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata createDLFileEntryMetadata( 066 long fileEntryMetadataId); 067 068 /** 069 * Deletes the document library file entry metadata with the primary key from the database. Also notifies the appropriate model listeners. 070 * 071 * @param fileEntryMetadataId the primary key of the document library file entry metadata 072 * @return the document library file entry metadata that was removed 073 * @throws PortalException if a document library file entry metadata with the primary key could not be found 074 * @throws SystemException if a system exception occurred 075 */ 076 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata deleteDLFileEntryMetadata( 077 long fileEntryMetadataId) 078 throws com.liferay.portal.kernel.exception.PortalException, 079 com.liferay.portal.kernel.exception.SystemException; 080 081 /** 082 * Deletes the document library file entry metadata from the database. Also notifies the appropriate model listeners. 083 * 084 * @param dlFileEntryMetadata the document library file entry metadata 085 * @return the document library file entry metadata that was removed 086 * @throws SystemException if a system exception occurred 087 */ 088 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata deleteDLFileEntryMetadata( 089 com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata dlFileEntryMetadata) 090 throws com.liferay.portal.kernel.exception.SystemException; 091 092 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 093 094 /** 095 * Performs a dynamic query on the database and returns the matching rows. 096 * 097 * @param dynamicQuery the dynamic query 098 * @return the matching rows 099 * @throws SystemException if a system exception occurred 100 */ 101 @SuppressWarnings("rawtypes") 102 public java.util.List dynamicQuery( 103 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 104 throws com.liferay.portal.kernel.exception.SystemException; 105 106 /** 107 * Performs a dynamic query on the database and returns a range of the matching rows. 108 * 109 * <p> 110 * 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. 111 * </p> 112 * 113 * @param dynamicQuery the dynamic query 114 * @param start the lower bound of the range of model instances 115 * @param end the upper bound of the range of model instances (not inclusive) 116 * @return the range of matching rows 117 * @throws SystemException if a system exception occurred 118 */ 119 @SuppressWarnings("rawtypes") 120 public java.util.List dynamicQuery( 121 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 122 int end) throws com.liferay.portal.kernel.exception.SystemException; 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 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 145 /** 146 * Returns the number of rows that match the dynamic query. 147 * 148 * @param dynamicQuery the dynamic query 149 * @return the number of rows that match the dynamic query 150 * @throws SystemException if a system exception occurred 151 */ 152 public long dynamicQueryCount( 153 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 154 throws com.liferay.portal.kernel.exception.SystemException; 155 156 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 157 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata fetchDLFileEntryMetadata( 158 long fileEntryMetadataId) 159 throws com.liferay.portal.kernel.exception.SystemException; 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 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 170 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getDLFileEntryMetadata( 171 long fileEntryMetadataId) 172 throws com.liferay.portal.kernel.exception.PortalException, 173 com.liferay.portal.kernel.exception.SystemException; 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public 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 181 /** 182 * Returns a range of all the document library file entry metadatas. 183 * 184 * <p> 185 * 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. 186 * </p> 187 * 188 * @param start the lower bound of the range of document library file entry metadatas 189 * @param end the upper bound of the range of document library file entry metadatas (not inclusive) 190 * @return the range of document library file entry metadatas 191 * @throws SystemException if a system exception occurred 192 */ 193 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 194 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata> getDLFileEntryMetadatas( 195 int start, int end) 196 throws com.liferay.portal.kernel.exception.SystemException; 197 198 /** 199 * Returns the number of document library file entry metadatas. 200 * 201 * @return the number of document library file entry metadatas 202 * @throws SystemException if a system exception occurred 203 */ 204 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 205 public int getDLFileEntryMetadatasCount() 206 throws com.liferay.portal.kernel.exception.SystemException; 207 208 /** 209 * 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. 210 * 211 * @param dlFileEntryMetadata the document library file entry metadata 212 * @return the document library file entry metadata that was updated 213 * @throws SystemException if a system exception occurred 214 */ 215 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata updateDLFileEntryMetadata( 216 com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata dlFileEntryMetadata) 217 throws com.liferay.portal.kernel.exception.SystemException; 218 219 /** 220 * 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. 221 * 222 * @param dlFileEntryMetadata the document library file entry metadata 223 * @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. 224 * @return the document library file entry metadata that was updated 225 * @throws SystemException if a system exception occurred 226 */ 227 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata updateDLFileEntryMetadata( 228 com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata dlFileEntryMetadata, 229 boolean merge) 230 throws com.liferay.portal.kernel.exception.SystemException; 231 232 /** 233 * Returns the Spring bean ID for this bean. 234 * 235 * @return the Spring bean ID for this bean 236 */ 237 public java.lang.String getBeanIdentifier(); 238 239 /** 240 * Sets the Spring bean ID for this bean. 241 * 242 * @param beanIdentifier the Spring bean ID for this bean 243 */ 244 public void setBeanIdentifier(java.lang.String beanIdentifier); 245 246 public void deleteFileEntryMetadata(long fileEntryId) 247 throws com.liferay.portal.kernel.exception.PortalException, 248 com.liferay.portal.kernel.exception.SystemException; 249 250 public void deleteFileVersionFileEntryMetadata(long fileVersionId) 251 throws com.liferay.portal.kernel.exception.PortalException, 252 com.liferay.portal.kernel.exception.SystemException; 253 254 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 255 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getFileEntryMetadata( 256 long fileEntryMetadataId) 257 throws com.liferay.portal.kernel.exception.PortalException, 258 com.liferay.portal.kernel.exception.SystemException; 259 260 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 261 public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getFileEntryMetadata( 262 long ddmStructureId, long fileVersionId) 263 throws com.liferay.portal.kernel.exception.PortalException, 264 com.liferay.portal.kernel.exception.SystemException; 265 266 /** 267 * @deprecated {@link #getFileVersionFileEntryMetadatasCount(long)} 268 */ 269 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 270 public long getFileEntryMetadataCount(long fileEntryId, long fileVersionId) 271 throws com.liferay.portal.kernel.exception.SystemException; 272 273 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 274 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata> getFileVersionFileEntryMetadatas( 275 long fileVersionId) 276 throws com.liferay.portal.kernel.exception.SystemException; 277 278 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 279 public long getFileVersionFileEntryMetadatasCount(long fileVersionId) 280 throws com.liferay.portal.kernel.exception.SystemException; 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 com.liferay.portal.kernel.exception.SystemException; 289 290 public void updateFileEntryMetadata(long fileEntryTypeId, long fileEntryId, 291 long fileVersionId, 292 java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap, 293 com.liferay.portal.service.ServiceContext serviceContext) 294 throws com.liferay.portal.kernel.exception.PortalException, 295 com.liferay.portal.kernel.exception.SystemException; 296 }