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