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