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