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