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