001    /**
002     * Copyright (c) 2000-2010 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.annotation.Isolation;
018    import com.liferay.portal.kernel.annotation.Propagation;
019    import com.liferay.portal.kernel.annotation.Transactional;
020    import com.liferay.portal.kernel.exception.PortalException;
021    import com.liferay.portal.kernel.exception.SystemException;
022    
023    /**
024     * The interface for the d l file shortcut local service.
025     *
026     * <p>
027     * Never modify or reference this interface directly. Always use {@link DLFileShortcutLocalServiceUtil} to access the d l file shortcut local service. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFileShortcutLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
028     * </p>
029     *
030     * <p>
031     * 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.
032     * </p>
033     *
034     * @author Brian Wing Shun Chan
035     * @see DLFileShortcutLocalServiceUtil
036     * @see com.liferay.portlet.documentlibrary.service.base.DLFileShortcutLocalServiceBaseImpl
037     * @see com.liferay.portlet.documentlibrary.service.impl.DLFileShortcutLocalServiceImpl
038     * @generated
039     */
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface DLFileShortcutLocalService {
043            /**
044            * Adds the d l file shortcut to the database. Also notifies the appropriate model listeners.
045            *
046            * @param dlFileShortcut the d l file shortcut to add
047            * @return the d l file shortcut that was added
048            * @throws SystemException if a system exception occurred
049            */
050            public com.liferay.portlet.documentlibrary.model.DLFileShortcut addDLFileShortcut(
051                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
052                    throws com.liferay.portal.kernel.exception.SystemException;
053    
054            /**
055            * Creates a new d l file shortcut with the primary key. Does not add the d l file shortcut to the database.
056            *
057            * @param fileShortcutId the primary key for the new d l file shortcut
058            * @return the new d l file shortcut
059            */
060            public com.liferay.portlet.documentlibrary.model.DLFileShortcut createDLFileShortcut(
061                    long fileShortcutId);
062    
063            /**
064            * Deletes the d l file shortcut with the primary key from the database. Also notifies the appropriate model listeners.
065            *
066            * @param fileShortcutId the primary key of the d l file shortcut to delete
067            * @throws PortalException if a d l file shortcut with the primary key could not be found
068            * @throws SystemException if a system exception occurred
069            */
070            public void deleteDLFileShortcut(long fileShortcutId)
071                    throws com.liferay.portal.kernel.exception.PortalException,
072                            com.liferay.portal.kernel.exception.SystemException;
073    
074            /**
075            * Deletes the d l file shortcut from the database. Also notifies the appropriate model listeners.
076            *
077            * @param dlFileShortcut the d l file shortcut to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public void deleteDLFileShortcut(
081                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
082                    throws com.liferay.portal.kernel.exception.SystemException;
083    
084            /**
085            * Performs a dynamic query on the database and returns the matching rows.
086            *
087            * @param dynamicQuery the dynamic query to search with
088            * @return the matching rows
089            * @throws SystemException if a system exception occurred
090            */
091            @SuppressWarnings("rawtypes")
092            public java.util.List dynamicQuery(
093                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
094                    throws com.liferay.portal.kernel.exception.SystemException;
095    
096            /**
097            * Performs a dynamic query on the database and returns a range of the matching rows.
098            *
099            * <p>
100            * 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.
101            * </p>
102            *
103            * @param dynamicQuery the dynamic query to search with
104            * @param start the lower bound of the range of model instances to return
105            * @param end the upper bound of the range of model instances to return (not inclusive)
106            * @return the range of matching rows
107            * @throws SystemException if a system exception occurred
108            */
109            @SuppressWarnings("rawtypes")
110            public java.util.List dynamicQuery(
111                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
112                    int end) throws com.liferay.portal.kernel.exception.SystemException;
113    
114            /**
115            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
116            *
117            * <p>
118            * 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query to search with
122            * @param start the lower bound of the range of model instances to return
123            * @param end the upper bound of the range of model instances to return (not inclusive)
124            * @param orderByComparator the comparator to order the results by
125            * @return the ordered range of matching rows
126            * @throws SystemException if a system exception occurred
127            */
128            @SuppressWarnings("rawtypes")
129            public java.util.List dynamicQuery(
130                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
131                    int end,
132                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
133                    throws com.liferay.portal.kernel.exception.SystemException;
134    
135            /**
136            * Counts the number of rows that match the dynamic query.
137            *
138            * @param dynamicQuery the dynamic query to search with
139            * @return the number of rows that match the dynamic query
140            * @throws SystemException if a system exception occurred
141            */
142            public long dynamicQueryCount(
143                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
144                    throws com.liferay.portal.kernel.exception.SystemException;
145    
146            /**
147            * Gets the d l file shortcut with the primary key.
148            *
149            * @param fileShortcutId the primary key of the d l file shortcut to get
150            * @return the d l file shortcut
151            * @throws PortalException if a d l file shortcut with the primary key could not be found
152            * @throws SystemException if a system exception occurred
153            */
154            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155            public com.liferay.portlet.documentlibrary.model.DLFileShortcut getDLFileShortcut(
156                    long fileShortcutId)
157                    throws com.liferay.portal.kernel.exception.PortalException,
158                            com.liferay.portal.kernel.exception.SystemException;
159    
160            /**
161            * Gets the d l file shortcut with the UUID and group id.
162            *
163            * @param uuid the UUID of d l file shortcut to get
164            * @param groupId the group id of the d l file shortcut to get
165            * @return the d l file shortcut
166            * @throws PortalException if a d l file shortcut with the UUID and group id 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.DLFileShortcut getDLFileShortcutByUuidAndGroupId(
171                    java.lang.String uuid, long groupId)
172                    throws com.liferay.portal.kernel.exception.PortalException,
173                            com.liferay.portal.kernel.exception.SystemException;
174    
175            /**
176            * Gets a range of all the d l file shortcuts.
177            *
178            * <p>
179            * 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.
180            * </p>
181            *
182            * @param start the lower bound of the range of d l file shortcuts to return
183            * @param end the upper bound of the range of d l file shortcuts to return (not inclusive)
184            * @return the range of d l file shortcuts
185            * @throws SystemException if a system exception occurred
186            */
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileShortcut> getDLFileShortcuts(
189                    int start, int end)
190                    throws com.liferay.portal.kernel.exception.SystemException;
191    
192            /**
193            * Gets the number of d l file shortcuts.
194            *
195            * @return the number of d l file shortcuts
196            * @throws SystemException if a system exception occurred
197            */
198            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
199            public int getDLFileShortcutsCount()
200                    throws com.liferay.portal.kernel.exception.SystemException;
201    
202            /**
203            * Updates the d l file shortcut in the database. Also notifies the appropriate model listeners.
204            *
205            * @param dlFileShortcut the d l file shortcut to update
206            * @return the d l file shortcut that was updated
207            * @throws SystemException if a system exception occurred
208            */
209            public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateDLFileShortcut(
210                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
211                    throws com.liferay.portal.kernel.exception.SystemException;
212    
213            /**
214            * Updates the d l file shortcut in the database. Also notifies the appropriate model listeners.
215            *
216            * @param dlFileShortcut the d l file shortcut to update
217            * @param merge whether to merge the d l file shortcut 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.
218            * @return the d l file shortcut that was updated
219            * @throws SystemException if a system exception occurred
220            */
221            public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateDLFileShortcut(
222                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut,
223                    boolean merge)
224                    throws com.liferay.portal.kernel.exception.SystemException;
225    
226            public com.liferay.portlet.documentlibrary.model.DLFileShortcut addFileShortcut(
227                    long userId, long groupId, long folderId, long toFolderId,
228                    java.lang.String toName,
229                    com.liferay.portal.service.ServiceContext serviceContext)
230                    throws com.liferay.portal.kernel.exception.PortalException,
231                            com.liferay.portal.kernel.exception.SystemException;
232    
233            public void addFileShortcutResources(
234                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut,
235                    boolean addCommunityPermissions, boolean addGuestPermissions)
236                    throws com.liferay.portal.kernel.exception.PortalException,
237                            com.liferay.portal.kernel.exception.SystemException;
238    
239            public void addFileShortcutResources(
240                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut,
241                    java.lang.String[] communityPermissions,
242                    java.lang.String[] guestPermissions)
243                    throws com.liferay.portal.kernel.exception.PortalException,
244                            com.liferay.portal.kernel.exception.SystemException;
245    
246            public void addFileShortcutResources(long fileShortcutId,
247                    boolean addCommunityPermissions, boolean addGuestPermissions)
248                    throws com.liferay.portal.kernel.exception.PortalException,
249                            com.liferay.portal.kernel.exception.SystemException;
250    
251            public void addFileShortcutResources(long fileShortcutId,
252                    java.lang.String[] communityPermissions,
253                    java.lang.String[] guestPermissions)
254                    throws com.liferay.portal.kernel.exception.PortalException,
255                            com.liferay.portal.kernel.exception.SystemException;
256    
257            public void deleteFileShortcut(
258                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut)
259                    throws com.liferay.portal.kernel.exception.PortalException,
260                            com.liferay.portal.kernel.exception.SystemException;
261    
262            public void deleteFileShortcut(long fileShortcutId)
263                    throws com.liferay.portal.kernel.exception.PortalException,
264                            com.liferay.portal.kernel.exception.SystemException;
265    
266            public void deleteFileShortcuts(long groupId, long toFolderId,
267                    java.lang.String toName)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException;
270    
271            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
272            public com.liferay.portlet.documentlibrary.model.DLFileShortcut getFileShortcut(
273                    long fileShortcutId)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException;
276    
277            public void updateAsset(long userId,
278                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut,
279                    long[] assetCategoryIds, java.lang.String[] assetTagNames)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException;
282    
283            public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateFileShortcut(
284                    long userId, long fileShortcutId, long folderId, long toFolderId,
285                    java.lang.String toName,
286                    com.liferay.portal.service.ServiceContext serviceContext)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException;
289    
290            public void updateFileShortcuts(long groupId, long oldToFolderId,
291                    java.lang.String oldToName, long newToFolderId,
292                    java.lang.String newToName)
293                    throws com.liferay.portal.kernel.exception.SystemException;
294    }