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 content 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 DLContentLocalServiceUtil
034     * @see com.liferay.portlet.documentlibrary.service.base.DLContentLocalServiceBaseImpl
035     * @see com.liferay.portlet.documentlibrary.service.impl.DLContentLocalServiceImpl
036     * @generated
037     */
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface DLContentLocalService extends BaseLocalService,
041            PersistedModelLocalService {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * 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.
046             */
047    
048            /**
049            * Adds the document library content to the database. Also notifies the appropriate model listeners.
050            *
051            * @param dlContent the document library content
052            * @return the document library content that was added
053            * @throws SystemException if a system exception occurred
054            */
055            public com.liferay.portlet.documentlibrary.model.DLContent addDLContent(
056                    com.liferay.portlet.documentlibrary.model.DLContent dlContent)
057                    throws com.liferay.portal.kernel.exception.SystemException;
058    
059            /**
060            * Creates a new document library content with the primary key. Does not add the document library content to the database.
061            *
062            * @param contentId the primary key for the new document library content
063            * @return the new document library content
064            */
065            public com.liferay.portlet.documentlibrary.model.DLContent createDLContent(
066                    long contentId);
067    
068            /**
069            * Deletes the document library content with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param contentId the primary key of the document library content
072            * @return the document library content that was removed
073            * @throws PortalException if a document library content with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public com.liferay.portlet.documentlibrary.model.DLContent deleteDLContent(
077                    long contentId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException;
080    
081            /**
082            * Deletes the document library content from the database. Also notifies the appropriate model listeners.
083            *
084            * @param dlContent the document library content
085            * @return the document library content that was removed
086            * @throws SystemException if a system exception occurred
087            */
088            public com.liferay.portlet.documentlibrary.model.DLContent deleteDLContent(
089                    com.liferay.portlet.documentlibrary.model.DLContent dlContent)
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.DLContent fetchDLContent(
158                    long contentId)
159                    throws com.liferay.portal.kernel.exception.SystemException;
160    
161            /**
162            * Returns the document library content with the primary key.
163            *
164            * @param contentId the primary key of the document library content
165            * @return the document library content
166            * @throws PortalException if a document library content 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.DLContent getDLContent(
171                    long contentId)
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 contents.
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 contents
189            * @param end the upper bound of the range of document library contents (not inclusive)
190            * @return the range of document library contents
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.DLContent> getDLContents(
195                    int start, int end)
196                    throws com.liferay.portal.kernel.exception.SystemException;
197    
198            /**
199            * Returns the number of document library contents.
200            *
201            * @return the number of document library contents
202            * @throws SystemException if a system exception occurred
203            */
204            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
205            public int getDLContentsCount()
206                    throws com.liferay.portal.kernel.exception.SystemException;
207    
208            /**
209            * Updates the document library content in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
210            *
211            * @param dlContent the document library content
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                    throws com.liferay.portal.kernel.exception.SystemException;
218    
219            /**
220            * Updates the document library content in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
221            *
222            * @param dlContent the document library content
223            * @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.
224            * @return the document library content that was updated
225            * @throws SystemException if a system exception occurred
226            */
227            public com.liferay.portlet.documentlibrary.model.DLContent updateDLContent(
228                    com.liferay.portlet.documentlibrary.model.DLContent dlContent,
229                    boolean merge)
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    }