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.portal.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    
023    /**
024     * Provides the local service interface for Repository. Methods of this
025     * service will not have security checks based on the propagated JAAS
026     * credentials because this service can only be accessed from within the same
027     * VM.
028     *
029     * @author Brian Wing Shun Chan
030     * @see RepositoryLocalServiceUtil
031     * @see com.liferay.portal.service.base.RepositoryLocalServiceBaseImpl
032     * @see com.liferay.portal.service.impl.RepositoryLocalServiceImpl
033     * @generated
034     */
035    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
036            PortalException.class, SystemException.class})
037    public interface RepositoryLocalService extends BaseLocalService,
038            PersistedModelLocalService {
039            /*
040             * NOTE FOR DEVELOPERS:
041             *
042             * Never modify or reference this interface directly. Always use {@link RepositoryLocalServiceUtil} to access the repository local service. Add custom service methods to {@link com.liferay.portal.service.impl.RepositoryLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
043             */
044    
045            /**
046            * Adds the repository to the database. Also notifies the appropriate model listeners.
047            *
048            * @param repository the repository
049            * @return the repository that was added
050            * @throws SystemException if a system exception occurred
051            */
052            public com.liferay.portal.model.Repository addRepository(
053                    com.liferay.portal.model.Repository repository)
054                    throws com.liferay.portal.kernel.exception.SystemException;
055    
056            /**
057            * Creates a new repository with the primary key. Does not add the repository to the database.
058            *
059            * @param repositoryId the primary key for the new repository
060            * @return the new repository
061            */
062            public com.liferay.portal.model.Repository createRepository(
063                    long repositoryId);
064    
065            /**
066            * Deletes the repository with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param repositoryId the primary key of the repository
069            * @return the repository that was removed
070            * @throws PortalException if a repository with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public com.liferay.portal.model.Repository deleteRepository(
074                    long repositoryId)
075                    throws com.liferay.portal.kernel.exception.PortalException,
076                            com.liferay.portal.kernel.exception.SystemException;
077    
078            /**
079            * Deletes the repository from the database. Also notifies the appropriate model listeners.
080            *
081            * @param repository the repository
082            * @return the repository that was removed
083            * @throws SystemException if a system exception occurred
084            */
085            public com.liferay.portal.model.Repository deleteRepository(
086                    com.liferay.portal.model.Repository repository)
087                    throws com.liferay.portal.kernel.exception.SystemException;
088    
089            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
090    
091            /**
092            * Performs a dynamic query on the database and returns the matching rows.
093            *
094            * @param dynamicQuery the dynamic query
095            * @return the matching rows
096            * @throws SystemException if a system exception occurred
097            */
098            @SuppressWarnings("rawtypes")
099            public java.util.List dynamicQuery(
100                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
101                    throws com.liferay.portal.kernel.exception.SystemException;
102    
103            /**
104            * Performs a dynamic query on the database and returns a range of the matching rows.
105            *
106            * <p>
107            * 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.portal.model.impl.RepositoryModelImpl}. 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.
108            * </p>
109            *
110            * @param dynamicQuery the dynamic query
111            * @param start the lower bound of the range of model instances
112            * @param end the upper bound of the range of model instances (not inclusive)
113            * @return the range of matching rows
114            * @throws SystemException if a system exception occurred
115            */
116            @SuppressWarnings("rawtypes")
117            public java.util.List dynamicQuery(
118                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
119                    int end) throws com.liferay.portal.kernel.exception.SystemException;
120    
121            /**
122            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
123            *
124            * <p>
125            * 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.portal.model.impl.RepositoryModelImpl}. 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.
126            * </p>
127            *
128            * @param dynamicQuery the dynamic query
129            * @param start the lower bound of the range of model instances
130            * @param end the upper bound of the range of model instances (not inclusive)
131            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
132            * @return the ordered range of matching rows
133            * @throws SystemException if a system exception occurred
134            */
135            @SuppressWarnings("rawtypes")
136            public java.util.List dynamicQuery(
137                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
138                    int end,
139                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
140                    throws com.liferay.portal.kernel.exception.SystemException;
141    
142            /**
143            * Returns the number of rows that match the dynamic query.
144            *
145            * @param dynamicQuery the dynamic query
146            * @return the number of rows that match the dynamic query
147            * @throws SystemException if a system exception occurred
148            */
149            public long dynamicQueryCount(
150                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
151                    throws com.liferay.portal.kernel.exception.SystemException;
152    
153            /**
154            * Returns the number of rows that match the dynamic query.
155            *
156            * @param dynamicQuery the dynamic query
157            * @param projection the projection to apply to the query
158            * @return the number of rows that match the dynamic query
159            * @throws SystemException if a system exception occurred
160            */
161            public long dynamicQueryCount(
162                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
163                    com.liferay.portal.kernel.dao.orm.Projection projection)
164                    throws com.liferay.portal.kernel.exception.SystemException;
165    
166            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
167            public com.liferay.portal.model.Repository fetchRepository(
168                    long repositoryId)
169                    throws com.liferay.portal.kernel.exception.SystemException;
170    
171            /**
172            * Returns the repository with the matching UUID and company.
173            *
174            * @param uuid the repository's UUID
175            * @param companyId the primary key of the company
176            * @return the matching repository, or <code>null</code> if a matching repository could not be found
177            * @throws SystemException if a system exception occurred
178            */
179            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
180            public com.liferay.portal.model.Repository fetchRepositoryByUuidAndCompanyId(
181                    java.lang.String uuid, long companyId)
182                    throws com.liferay.portal.kernel.exception.SystemException;
183    
184            /**
185            * Returns the repository matching the UUID and group.
186            *
187            * @param uuid the repository's UUID
188            * @param groupId the primary key of the group
189            * @return the matching repository, or <code>null</code> if a matching repository could not be found
190            * @throws SystemException if a system exception occurred
191            */
192            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
193            public com.liferay.portal.model.Repository fetchRepositoryByUuidAndGroupId(
194                    java.lang.String uuid, long groupId)
195                    throws com.liferay.portal.kernel.exception.SystemException;
196    
197            /**
198            * Returns the repository with the primary key.
199            *
200            * @param repositoryId the primary key of the repository
201            * @return the repository
202            * @throws PortalException if a repository with the primary key could not be found
203            * @throws SystemException if a system exception occurred
204            */
205            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
206            public com.liferay.portal.model.Repository getRepository(long repositoryId)
207                    throws com.liferay.portal.kernel.exception.PortalException,
208                            com.liferay.portal.kernel.exception.SystemException;
209    
210            @Override
211            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
212            public com.liferay.portal.model.PersistedModel getPersistedModel(
213                    java.io.Serializable primaryKeyObj)
214                    throws com.liferay.portal.kernel.exception.PortalException,
215                            com.liferay.portal.kernel.exception.SystemException;
216    
217            /**
218            * Returns the repository with the matching UUID and company.
219            *
220            * @param uuid the repository's UUID
221            * @param companyId the primary key of the company
222            * @return the matching repository
223            * @throws PortalException if a matching repository could not be found
224            * @throws SystemException if a system exception occurred
225            */
226            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
227            public com.liferay.portal.model.Repository getRepositoryByUuidAndCompanyId(
228                    java.lang.String uuid, long companyId)
229                    throws com.liferay.portal.kernel.exception.PortalException,
230                            com.liferay.portal.kernel.exception.SystemException;
231    
232            /**
233            * Returns the repository matching the UUID and group.
234            *
235            * @param uuid the repository's UUID
236            * @param groupId the primary key of the group
237            * @return the matching repository
238            * @throws PortalException if a matching repository could not be found
239            * @throws SystemException if a system exception occurred
240            */
241            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
242            public com.liferay.portal.model.Repository getRepositoryByUuidAndGroupId(
243                    java.lang.String uuid, long groupId)
244                    throws com.liferay.portal.kernel.exception.PortalException,
245                            com.liferay.portal.kernel.exception.SystemException;
246    
247            /**
248            * Returns a range of all the repositories.
249            *
250            * <p>
251            * 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.portal.model.impl.RepositoryModelImpl}. 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.
252            * </p>
253            *
254            * @param start the lower bound of the range of repositories
255            * @param end the upper bound of the range of repositories (not inclusive)
256            * @return the range of repositories
257            * @throws SystemException if a system exception occurred
258            */
259            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
260            public java.util.List<com.liferay.portal.model.Repository> getRepositories(
261                    int start, int end)
262                    throws com.liferay.portal.kernel.exception.SystemException;
263    
264            /**
265            * Returns the number of repositories.
266            *
267            * @return the number of repositories
268            * @throws SystemException if a system exception occurred
269            */
270            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
271            public int getRepositoriesCount()
272                    throws com.liferay.portal.kernel.exception.SystemException;
273    
274            /**
275            * Updates the repository in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
276            *
277            * @param repository the repository
278            * @return the repository that was updated
279            * @throws SystemException if a system exception occurred
280            */
281            public com.liferay.portal.model.Repository updateRepository(
282                    com.liferay.portal.model.Repository repository)
283                    throws com.liferay.portal.kernel.exception.SystemException;
284    
285            /**
286            * Returns the Spring bean ID for this bean.
287            *
288            * @return the Spring bean ID for this bean
289            */
290            public java.lang.String getBeanIdentifier();
291    
292            /**
293            * Sets the Spring bean ID for this bean.
294            *
295            * @param beanIdentifier the Spring bean ID for this bean
296            */
297            public void setBeanIdentifier(java.lang.String beanIdentifier);
298    
299            public com.liferay.portal.model.Repository addRepository(long userId,
300                    long groupId, long classNameId, long parentFolderId,
301                    java.lang.String name, java.lang.String description,
302                    java.lang.String portletId,
303                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties,
304                    boolean hidden, com.liferay.portal.service.ServiceContext serviceContext)
305                    throws com.liferay.portal.kernel.exception.PortalException,
306                            com.liferay.portal.kernel.exception.SystemException;
307    
308            /**
309            * @deprecated As of 6.2.0, replaced by {@link #addRepository(long, long,
310            long, long, String, String, String, UnicodeProperties,
311            boolean, ServiceContext)}
312            */
313            public com.liferay.portal.model.Repository addRepository(long userId,
314                    long groupId, long classNameId, long parentFolderId,
315                    java.lang.String name, java.lang.String description,
316                    java.lang.String portletId,
317                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties,
318                    com.liferay.portal.service.ServiceContext serviceContext)
319                    throws com.liferay.portal.kernel.exception.PortalException,
320                            com.liferay.portal.kernel.exception.SystemException;
321    
322            public void checkRepository(long repositoryId)
323                    throws com.liferay.portal.kernel.exception.SystemException;
324    
325            public void deleteRepositories(long groupId)
326                    throws com.liferay.portal.kernel.exception.PortalException,
327                            com.liferay.portal.kernel.exception.SystemException;
328    
329            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
330            public com.liferay.portal.model.Repository fetchRepository(long groupId,
331                    java.lang.String portletId)
332                    throws com.liferay.portal.kernel.exception.SystemException;
333    
334            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
335            public com.liferay.portal.model.Repository fetchRepository(long groupId,
336                    java.lang.String name, java.lang.String portletId)
337                    throws com.liferay.portal.kernel.exception.SystemException;
338    
339            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
340            public com.liferay.portal.kernel.repository.LocalRepository getLocalRepositoryImpl(
341                    long repositoryId)
342                    throws com.liferay.portal.kernel.exception.PortalException,
343                            com.liferay.portal.kernel.exception.SystemException;
344    
345            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
346            public com.liferay.portal.kernel.repository.LocalRepository getLocalRepositoryImpl(
347                    long folderId, long fileEntryId, long fileVersionId)
348                    throws com.liferay.portal.kernel.exception.PortalException,
349                            com.liferay.portal.kernel.exception.SystemException;
350    
351            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
352            public com.liferay.portal.model.Repository getRepository(long groupId,
353                    java.lang.String portletId)
354                    throws com.liferay.portal.kernel.exception.PortalException,
355                            com.liferay.portal.kernel.exception.SystemException;
356    
357            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
358            public com.liferay.portal.model.Repository getRepository(long groupId,
359                    java.lang.String name, java.lang.String portletId)
360                    throws com.liferay.portal.kernel.exception.PortalException,
361                            com.liferay.portal.kernel.exception.SystemException;
362    
363            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
364            public com.liferay.portal.kernel.repository.Repository getRepositoryImpl(
365                    long repositoryId)
366                    throws com.liferay.portal.kernel.exception.PortalException,
367                            com.liferay.portal.kernel.exception.SystemException;
368    
369            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
370            public com.liferay.portal.kernel.repository.Repository getRepositoryImpl(
371                    long folderId, long fileEntryId, long fileVersionId)
372                    throws com.liferay.portal.kernel.exception.PortalException,
373                            com.liferay.portal.kernel.exception.SystemException;
374    
375            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
376            public com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties(
377                    long repositoryId)
378                    throws com.liferay.portal.kernel.exception.PortalException,
379                            com.liferay.portal.kernel.exception.SystemException;
380    
381            public void updateRepository(long repositoryId, java.lang.String name,
382                    java.lang.String description)
383                    throws com.liferay.portal.kernel.exception.PortalException,
384                            com.liferay.portal.kernel.exception.SystemException;
385    }