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 DLContent. 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 DLContentLocalServiceUtil 036 * @see com.liferay.portlet.documentlibrary.service.base.DLContentLocalServiceBaseImpl 037 * @see com.liferay.portlet.documentlibrary.service.impl.DLContentLocalServiceImpl 038 * @generated 039 */ 040 @ProviderType 041 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 042 PortalException.class, SystemException.class}) 043 public interface DLContentLocalService extends BaseLocalService, 044 PersistedModelLocalService { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * Never modify or reference this interface directly. Always use {@link DLContentLocalServiceUtil} to access the document library content local service. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLContentLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 049 */ 050 public com.liferay.portlet.documentlibrary.model.DLContent addContent( 051 long companyId, long repositoryId, java.lang.String path, 052 java.lang.String version, byte[] bytes); 053 054 public com.liferay.portlet.documentlibrary.model.DLContent addContent( 055 long companyId, long repositoryId, java.lang.String path, 056 java.lang.String version, java.io.InputStream inputStream, long size); 057 058 /** 059 * Adds the document library content to the database. Also notifies the appropriate model listeners. 060 * 061 * @param dlContent the document library content 062 * @return the document library content that was added 063 */ 064 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 065 public com.liferay.portlet.documentlibrary.model.DLContent addDLContent( 066 com.liferay.portlet.documentlibrary.model.DLContent dlContent); 067 068 /** 069 * Creates a new document library content with the primary key. Does not add the document library content to the database. 070 * 071 * @param contentId the primary key for the new document library content 072 * @return the new document library content 073 */ 074 public com.liferay.portlet.documentlibrary.model.DLContent createDLContent( 075 long contentId); 076 077 public void deleteContent(long companyId, long repositoryId, 078 java.lang.String path, java.lang.String version) 079 throws com.liferay.portal.kernel.exception.PortalException; 080 081 public void deleteContents(long companyId, long repositoryId, 082 java.lang.String path); 083 084 public void deleteContentsByDirectory(long companyId, long repositoryId, 085 java.lang.String dirName); 086 087 /** 088 * Deletes the document library content with the primary key from the database. Also notifies the appropriate model listeners. 089 * 090 * @param contentId the primary key of the document library content 091 * @return the document library content that was removed 092 * @throws PortalException if a document library content with the primary key could not be found 093 */ 094 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 095 public com.liferay.portlet.documentlibrary.model.DLContent deleteDLContent( 096 long contentId) 097 throws com.liferay.portal.kernel.exception.PortalException; 098 099 /** 100 * Deletes the document library content from the database. Also notifies the appropriate model listeners. 101 * 102 * @param dlContent the document library content 103 * @return the document library content that was removed 104 */ 105 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 106 public com.liferay.portlet.documentlibrary.model.DLContent deleteDLContent( 107 com.liferay.portlet.documentlibrary.model.DLContent dlContent); 108 109 /** 110 * @throws PortalException 111 */ 112 @Override 113 public com.liferay.portal.model.PersistedModel deletePersistedModel( 114 com.liferay.portal.model.PersistedModel persistedModel) 115 throws com.liferay.portal.kernel.exception.PortalException; 116 117 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 118 119 /** 120 * Performs a dynamic query on the database and returns the matching rows. 121 * 122 * @param dynamicQuery the dynamic query 123 * @return the matching rows 124 */ 125 public <T> java.util.List<T> dynamicQuery( 126 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 127 128 /** 129 * Performs a dynamic query on the database and returns a range of the matching rows. 130 * 131 * <p> 132 * 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.DLContentModelImpl}. 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. 133 * </p> 134 * 135 * @param dynamicQuery the dynamic query 136 * @param start the lower bound of the range of model instances 137 * @param end the upper bound of the range of model instances (not inclusive) 138 * @return the range of matching rows 139 */ 140 public <T> java.util.List<T> dynamicQuery( 141 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 142 int end); 143 144 /** 145 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 146 * 147 * <p> 148 * 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.DLContentModelImpl}. 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. 149 * </p> 150 * 151 * @param dynamicQuery the dynamic query 152 * @param start the lower bound of the range of model instances 153 * @param end the upper bound of the range of model instances (not inclusive) 154 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 155 * @return the ordered range of matching rows 156 */ 157 public <T> java.util.List<T> dynamicQuery( 158 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 159 int end, 160 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 161 162 /** 163 * Returns the number of rows matching the dynamic query. 164 * 165 * @param dynamicQuery the dynamic query 166 * @return the number of rows matching the dynamic query 167 */ 168 public long dynamicQueryCount( 169 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 170 171 /** 172 * Returns the number of rows matching the dynamic query. 173 * 174 * @param dynamicQuery the dynamic query 175 * @param projection the projection to apply to the query 176 * @return the number of rows matching the dynamic query 177 */ 178 public long dynamicQueryCount( 179 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 180 com.liferay.portal.kernel.dao.orm.Projection projection); 181 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public com.liferay.portlet.documentlibrary.model.DLContent fetchDLContent( 184 long contentId); 185 186 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 187 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 188 189 /** 190 * Returns the Spring bean ID for this bean. 191 * 192 * @return the Spring bean ID for this bean 193 */ 194 public java.lang.String getBeanIdentifier(); 195 196 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 197 public com.liferay.portlet.documentlibrary.model.DLContent getContent( 198 long companyId, long repositoryId, java.lang.String path) 199 throws com.liferay.portlet.documentlibrary.NoSuchContentException; 200 201 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 202 public com.liferay.portlet.documentlibrary.model.DLContent getContent( 203 long companyId, long repositoryId, java.lang.String path, 204 java.lang.String version) 205 throws com.liferay.portlet.documentlibrary.NoSuchContentException; 206 207 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 208 public java.util.List<com.liferay.portlet.documentlibrary.model.DLContent> getContents( 209 long companyId, long repositoryId); 210 211 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 212 public java.util.List<com.liferay.portlet.documentlibrary.model.DLContent> getContents( 213 long companyId, long repositoryId, java.lang.String path); 214 215 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 216 public java.util.List<com.liferay.portlet.documentlibrary.model.DLContent> getContentsByDirectory( 217 long companyId, long repositoryId, java.lang.String dirName); 218 219 /** 220 * Returns the document library content with the primary key. 221 * 222 * @param contentId the primary key of the document library content 223 * @return the document library content 224 * @throws PortalException if a document library content with the primary key could not be found 225 */ 226 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 227 public com.liferay.portlet.documentlibrary.model.DLContent getDLContent( 228 long contentId) 229 throws com.liferay.portal.kernel.exception.PortalException; 230 231 /** 232 * Returns a range of all the document library contents. 233 * 234 * <p> 235 * 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.DLContentModelImpl}. 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. 236 * </p> 237 * 238 * @param start the lower bound of the range of document library contents 239 * @param end the upper bound of the range of document library contents (not inclusive) 240 * @return the range of document library contents 241 */ 242 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 243 public java.util.List<com.liferay.portlet.documentlibrary.model.DLContent> getDLContents( 244 int start, int end); 245 246 /** 247 * Returns the number of document library contents. 248 * 249 * @return the number of document library contents 250 */ 251 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 252 public int getDLContentsCount(); 253 254 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 255 public com.liferay.portlet.documentlibrary.model.DLContentDataBlobModel getDataBlobModel( 256 java.io.Serializable primaryKey); 257 258 @Override 259 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 260 public com.liferay.portal.model.PersistedModel getPersistedModel( 261 java.io.Serializable primaryKeyObj) 262 throws com.liferay.portal.kernel.exception.PortalException; 263 264 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 265 public boolean hasContent(long companyId, long repositoryId, 266 java.lang.String path, java.lang.String version); 267 268 /** 269 * Sets the Spring bean ID for this bean. 270 * 271 * @param beanIdentifier the Spring bean ID for this bean 272 */ 273 public void setBeanIdentifier(java.lang.String beanIdentifier); 274 275 public void updateDLContent(long companyId, long oldRepositoryId, 276 long newRepositoryId, java.lang.String oldPath, java.lang.String newPath); 277 278 /** 279 * Updates the document library content in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 280 * 281 * @param dlContent the document library content 282 * @return the document library content that was updated 283 */ 284 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 285 public com.liferay.portlet.documentlibrary.model.DLContent updateDLContent( 286 com.liferay.portlet.documentlibrary.model.DLContent dlContent); 287 }