001    /**
002     * Copyright (c) 2000-present 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.exportimport.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 ExportImportConfiguration. This utility wraps
024     * {@link com.liferay.portlet.exportimport.service.impl.ExportImportConfigurationLocalServiceImpl} 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 ExportImportConfigurationLocalService
032     * @see com.liferay.portlet.exportimport.service.base.ExportImportConfigurationLocalServiceBaseImpl
033     * @see com.liferay.portlet.exportimport.service.impl.ExportImportConfigurationLocalServiceImpl
034     * @generated
035     */
036    @ProviderType
037    public class ExportImportConfigurationLocalServiceUtil {
038            /*
039             * NOTE FOR DEVELOPERS:
040             *
041             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.exportimport.service.impl.ExportImportConfigurationLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
042             */
043            public static com.liferay.portlet.exportimport.model.ExportImportConfiguration addDraftExportImportConfiguration(
044                    long userId, java.lang.String name, int type,
045                    java.util.Map<java.lang.String, java.io.Serializable> settingsMap)
046                    throws com.liferay.portal.kernel.exception.PortalException {
047                    return getService()
048                                       .addDraftExportImportConfiguration(userId, name, type,
049                            settingsMap);
050            }
051    
052            public static com.liferay.portlet.exportimport.model.ExportImportConfiguration addDraftExportImportConfiguration(
053                    long userId, int type,
054                    java.util.Map<java.lang.String, java.io.Serializable> settingsMap)
055                    throws com.liferay.portal.kernel.exception.PortalException {
056                    return getService()
057                                       .addDraftExportImportConfiguration(userId, type, settingsMap);
058            }
059    
060            /**
061            * Adds the export import configuration to the database. Also notifies the appropriate model listeners.
062            *
063            * @param exportImportConfiguration the export import configuration
064            * @return the export import configuration that was added
065            */
066            public static com.liferay.portlet.exportimport.model.ExportImportConfiguration addExportImportConfiguration(
067                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration) {
068                    return getService()
069                                       .addExportImportConfiguration(exportImportConfiguration);
070            }
071    
072            public static com.liferay.portlet.exportimport.model.ExportImportConfiguration addExportImportConfiguration(
073                    long userId, long groupId, java.lang.String name,
074                    java.lang.String description, int type,
075                    java.util.Map<java.lang.String, java.io.Serializable> settingsMap,
076                    com.liferay.portal.service.ServiceContext serviceContext)
077                    throws com.liferay.portal.kernel.exception.PortalException {
078                    return getService()
079                                       .addExportImportConfiguration(userId, groupId, name,
080                            description, type, settingsMap, serviceContext);
081            }
082    
083            public static com.liferay.portlet.exportimport.model.ExportImportConfiguration addExportImportConfiguration(
084                    long userId, long groupId, java.lang.String name,
085                    java.lang.String description, int type,
086                    java.util.Map<java.lang.String, java.io.Serializable> settingsMap,
087                    int status, com.liferay.portal.service.ServiceContext serviceContext)
088                    throws com.liferay.portal.kernel.exception.PortalException {
089                    return getService()
090                                       .addExportImportConfiguration(userId, groupId, name,
091                            description, type, settingsMap, status, serviceContext);
092            }
093    
094            /**
095            * Creates a new export import configuration with the primary key. Does not add the export import configuration to the database.
096            *
097            * @param exportImportConfigurationId the primary key for the new export import configuration
098            * @return the new export import configuration
099            */
100            public static com.liferay.portlet.exportimport.model.ExportImportConfiguration createExportImportConfiguration(
101                    long exportImportConfigurationId) {
102                    return getService()
103                                       .createExportImportConfiguration(exportImportConfigurationId);
104            }
105    
106            /**
107            * Deletes the export import configuration from the database. Also notifies the appropriate model listeners.
108            *
109            * @param exportImportConfiguration the export import configuration
110            * @return the export import configuration that was removed
111            */
112            public static com.liferay.portlet.exportimport.model.ExportImportConfiguration deleteExportImportConfiguration(
113                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration) {
114                    return getService()
115                                       .deleteExportImportConfiguration(exportImportConfiguration);
116            }
117    
118            /**
119            * Deletes the export import configuration with the primary key from the database. Also notifies the appropriate model listeners.
120            *
121            * @param exportImportConfigurationId the primary key of the export import configuration
122            * @return the export import configuration that was removed
123            * @throws PortalException if a export import configuration with the primary key could not be found
124            */
125            public static com.liferay.portlet.exportimport.model.ExportImportConfiguration deleteExportImportConfiguration(
126                    long exportImportConfigurationId)
127                    throws com.liferay.portal.kernel.exception.PortalException {
128                    return getService()
129                                       .deleteExportImportConfiguration(exportImportConfigurationId);
130            }
131    
132            public static void deleteExportImportConfigurations(long groupId) {
133                    getService().deleteExportImportConfigurations(groupId);
134            }
135    
136            /**
137            * @throws PortalException
138            */
139            public static com.liferay.portal.model.PersistedModel deletePersistedModel(
140                    com.liferay.portal.model.PersistedModel persistedModel)
141                    throws com.liferay.portal.kernel.exception.PortalException {
142                    return getService().deletePersistedModel(persistedModel);
143            }
144    
145            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
146                    return getService().dynamicQuery();
147            }
148    
149            /**
150            * Performs a dynamic query on the database and returns the matching rows.
151            *
152            * @param dynamicQuery the dynamic query
153            * @return the matching rows
154            */
155            public static <T> java.util.List<T> dynamicQuery(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
157                    return getService().dynamicQuery(dynamicQuery);
158            }
159    
160            /**
161            * Performs a dynamic query on the database and returns a range of the matching rows.
162            *
163            * <p>
164            * 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.portlet.exportimport.model.impl.ExportImportConfigurationModelImpl}. 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.
165            * </p>
166            *
167            * @param dynamicQuery the dynamic query
168            * @param start the lower bound of the range of model instances
169            * @param end the upper bound of the range of model instances (not inclusive)
170            * @return the range of matching rows
171            */
172            public static <T> java.util.List<T> dynamicQuery(
173                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
174                    int end) {
175                    return getService().dynamicQuery(dynamicQuery, start, end);
176            }
177    
178            /**
179            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
180            *
181            * <p>
182            * 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.portlet.exportimport.model.impl.ExportImportConfigurationModelImpl}. 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.
183            * </p>
184            *
185            * @param dynamicQuery the dynamic query
186            * @param start the lower bound of the range of model instances
187            * @param end the upper bound of the range of model instances (not inclusive)
188            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
189            * @return the ordered range of matching rows
190            */
191            public static <T> java.util.List<T> dynamicQuery(
192                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
193                    int end,
194                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) {
195                    return getService()
196                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
197            }
198    
199            /**
200            * Returns the number of rows matching the dynamic query.
201            *
202            * @param dynamicQuery the dynamic query
203            * @return the number of rows matching the dynamic query
204            */
205            public static long dynamicQueryCount(
206                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
207                    return getService().dynamicQueryCount(dynamicQuery);
208            }
209    
210            /**
211            * Returns the number of rows matching the dynamic query.
212            *
213            * @param dynamicQuery the dynamic query
214            * @param projection the projection to apply to the query
215            * @return the number of rows matching the dynamic query
216            */
217            public static long dynamicQueryCount(
218                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
219                    com.liferay.portal.kernel.dao.orm.Projection projection) {
220                    return getService().dynamicQueryCount(dynamicQuery, projection);
221            }
222    
223            public static com.liferay.portlet.exportimport.model.ExportImportConfiguration fetchExportImportConfiguration(
224                    long exportImportConfigurationId) {
225                    return getService()
226                                       .fetchExportImportConfiguration(exportImportConfigurationId);
227            }
228    
229            public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() {
230                    return getService().getActionableDynamicQuery();
231            }
232    
233            /**
234            * Returns the export import configuration with the primary key.
235            *
236            * @param exportImportConfigurationId the primary key of the export import configuration
237            * @return the export import configuration
238            * @throws PortalException if a export import configuration with the primary key could not be found
239            */
240            public static com.liferay.portlet.exportimport.model.ExportImportConfiguration getExportImportConfiguration(
241                    long exportImportConfigurationId)
242                    throws com.liferay.portal.kernel.exception.PortalException {
243                    return getService()
244                                       .getExportImportConfiguration(exportImportConfigurationId);
245            }
246    
247            public static java.util.List<com.liferay.portlet.exportimport.model.ExportImportConfiguration> getExportImportConfigurations(
248                    long groupId, int type) {
249                    return getService().getExportImportConfigurations(groupId, type);
250            }
251    
252            public static java.util.List<com.liferay.portlet.exportimport.model.ExportImportConfiguration> getExportImportConfigurations(
253                    long groupId, int type, int start, int end,
254                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.exportimport.model.ExportImportConfiguration> orderByComparator) {
255                    return getService()
256                                       .getExportImportConfigurations(groupId, type, start, end,
257                            orderByComparator);
258            }
259    
260            public static java.util.List<com.liferay.portlet.exportimport.model.ExportImportConfiguration> getExportImportConfigurations(
261                    com.liferay.portal.kernel.search.Hits hits)
262                    throws com.liferay.portal.kernel.exception.PortalException {
263                    return getService().getExportImportConfigurations(hits);
264            }
265    
266            /**
267            * Returns a range of all the export import configurations.
268            *
269            * <p>
270            * 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.portlet.exportimport.model.impl.ExportImportConfigurationModelImpl}. 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.
271            * </p>
272            *
273            * @param start the lower bound of the range of export import configurations
274            * @param end the upper bound of the range of export import configurations (not inclusive)
275            * @return the range of export import configurations
276            */
277            public static java.util.List<com.liferay.portlet.exportimport.model.ExportImportConfiguration> getExportImportConfigurations(
278                    int start, int end) {
279                    return getService().getExportImportConfigurations(start, end);
280            }
281    
282            /**
283            * Returns the number of export import configurations.
284            *
285            * @return the number of export import configurations
286            */
287            public static int getExportImportConfigurationsCount() {
288                    return getService().getExportImportConfigurationsCount();
289            }
290    
291            public static int getExportImportConfigurationsCount(long groupId) {
292                    return getService().getExportImportConfigurationsCount(groupId);
293            }
294    
295            public static int getExportImportConfigurationsCount(long groupId, int type) {
296                    return getService().getExportImportConfigurationsCount(groupId, type);
297            }
298    
299            /**
300            * Returns the OSGi service identifier.
301            *
302            * @return the OSGi service identifier
303            */
304            public static java.lang.String getOSGiServiceIdentifier() {
305                    return getService().getOSGiServiceIdentifier();
306            }
307    
308            public static com.liferay.portal.model.PersistedModel getPersistedModel(
309                    java.io.Serializable primaryKeyObj)
310                    throws com.liferay.portal.kernel.exception.PortalException {
311                    return getService().getPersistedModel(primaryKeyObj);
312            }
313    
314            public static com.liferay.portlet.exportimport.model.ExportImportConfiguration moveExportImportConfigurationToTrash(
315                    long userId, long exportImportConfigurationId)
316                    throws com.liferay.portal.kernel.exception.PortalException {
317                    return getService()
318                                       .moveExportImportConfigurationToTrash(userId,
319                            exportImportConfigurationId);
320            }
321    
322            public static com.liferay.portlet.exportimport.model.ExportImportConfiguration restoreExportImportConfigurationFromTrash(
323                    long userId, long exportImportConfigurationId)
324                    throws com.liferay.portal.kernel.exception.PortalException {
325                    return getService()
326                                       .restoreExportImportConfigurationFromTrash(userId,
327                            exportImportConfigurationId);
328            }
329    
330            public static com.liferay.portal.kernel.search.BaseModelSearchResult<com.liferay.portlet.exportimport.model.ExportImportConfiguration> searchExportImportConfigurations(
331                    long companyId, long groupId, int type, java.lang.String keywords,
332                    int start, int end, com.liferay.portal.kernel.search.Sort sort)
333                    throws com.liferay.portal.kernel.exception.PortalException {
334                    return getService()
335                                       .searchExportImportConfigurations(companyId, groupId, type,
336                            keywords, start, end, sort);
337            }
338    
339            public static com.liferay.portal.kernel.search.BaseModelSearchResult<com.liferay.portlet.exportimport.model.ExportImportConfiguration> searchExportImportConfigurations(
340                    long companyId, long groupId, int type, java.lang.String name,
341                    java.lang.String description, boolean andSearch, int start, int end,
342                    com.liferay.portal.kernel.search.Sort sort)
343                    throws com.liferay.portal.kernel.exception.PortalException {
344                    return getService()
345                                       .searchExportImportConfigurations(companyId, groupId, type,
346                            name, description, andSearch, start, end, sort);
347            }
348    
349            /**
350            * Updates the export import configuration in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
351            *
352            * @param exportImportConfiguration the export import configuration
353            * @return the export import configuration that was updated
354            */
355            public static com.liferay.portlet.exportimport.model.ExportImportConfiguration updateExportImportConfiguration(
356                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration) {
357                    return getService()
358                                       .updateExportImportConfiguration(exportImportConfiguration);
359            }
360    
361            public static com.liferay.portlet.exportimport.model.ExportImportConfiguration updateExportImportConfiguration(
362                    long userId, long exportImportConfigurationId, java.lang.String name,
363                    java.lang.String description,
364                    java.util.Map<java.lang.String, java.io.Serializable> settingsMap,
365                    com.liferay.portal.service.ServiceContext serviceContext)
366                    throws com.liferay.portal.kernel.exception.PortalException {
367                    return getService()
368                                       .updateExportImportConfiguration(userId,
369                            exportImportConfigurationId, name, description, settingsMap,
370                            serviceContext);
371            }
372    
373            public static com.liferay.portlet.exportimport.model.ExportImportConfiguration updateStatus(
374                    long userId, long exportImportConfigurationId, int status)
375                    throws com.liferay.portal.kernel.exception.PortalException {
376                    return getService()
377                                       .updateStatus(userId, exportImportConfigurationId, status);
378            }
379    
380            public static ExportImportConfigurationLocalService getService() {
381                    if (_service == null) {
382                            _service = (ExportImportConfigurationLocalService)PortalBeanLocatorUtil.locate(ExportImportConfigurationLocalService.class.getName());
383    
384                            ReferenceRegistry.registerReference(ExportImportConfigurationLocalServiceUtil.class,
385                                    "_service");
386                    }
387    
388                    return _service;
389            }
390    
391            /**
392             * @deprecated As of 6.2.0
393             */
394            @Deprecated
395            public void setService(ExportImportConfigurationLocalService service) {
396            }
397    
398            private static ExportImportConfigurationLocalService _service;
399    }