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.exception.PortalException;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.kernel.search.IndexableType;
022    import com.liferay.portal.kernel.transaction.Isolation;
023    import com.liferay.portal.kernel.transaction.Propagation;
024    import com.liferay.portal.kernel.transaction.Transactional;
025    import com.liferay.portal.model.SystemEventConstants;
026    import com.liferay.portal.service.BaseLocalService;
027    import com.liferay.portal.service.PersistedModelLocalService;
028    
029    /**
030     * Provides the local service interface for ExportImportConfiguration. Methods of this
031     * service will not have security checks based on the propagated JAAS
032     * credentials because this service can only be accessed from within the same
033     * VM.
034     *
035     * @author Brian Wing Shun Chan
036     * @see ExportImportConfigurationLocalServiceUtil
037     * @see com.liferay.portlet.exportimport.service.base.ExportImportConfigurationLocalServiceBaseImpl
038     * @see com.liferay.portlet.exportimport.service.impl.ExportImportConfigurationLocalServiceImpl
039     * @generated
040     */
041    @ProviderType
042    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
043            PortalException.class, SystemException.class})
044    public interface ExportImportConfigurationLocalService extends BaseLocalService,
045            PersistedModelLocalService {
046            /*
047             * NOTE FOR DEVELOPERS:
048             *
049             * Never modify or reference this interface directly. Always use {@link ExportImportConfigurationLocalServiceUtil} to access the export import configuration local service. Add custom service methods to {@link com.liferay.portlet.exportimport.service.impl.ExportImportConfigurationLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
050             */
051            public com.liferay.portlet.exportimport.model.ExportImportConfiguration addDraftExportImportConfiguration(
052                    long userId, java.lang.String name, int type,
053                    java.util.Map<java.lang.String, java.io.Serializable> settingsMap)
054                    throws PortalException;
055    
056            public com.liferay.portlet.exportimport.model.ExportImportConfiguration addDraftExportImportConfiguration(
057                    long userId, int type,
058                    java.util.Map<java.lang.String, java.io.Serializable> settingsMap)
059                    throws PortalException;
060    
061            /**
062            * Adds the export import configuration to the database. Also notifies the appropriate model listeners.
063            *
064            * @param exportImportConfiguration the export import configuration
065            * @return the export import configuration that was added
066            */
067            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
068            public com.liferay.portlet.exportimport.model.ExportImportConfiguration addExportImportConfiguration(
069                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration);
070    
071            public com.liferay.portlet.exportimport.model.ExportImportConfiguration addExportImportConfiguration(
072                    long userId, long groupId, java.lang.String name,
073                    java.lang.String description, int type,
074                    java.util.Map<java.lang.String, java.io.Serializable> settingsMap,
075                    com.liferay.portal.service.ServiceContext serviceContext)
076                    throws PortalException;
077    
078            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
079            public com.liferay.portlet.exportimport.model.ExportImportConfiguration addExportImportConfiguration(
080                    long userId, long groupId, java.lang.String name,
081                    java.lang.String description, int type,
082                    java.util.Map<java.lang.String, java.io.Serializable> settingsMap,
083                    int status, com.liferay.portal.service.ServiceContext serviceContext)
084                    throws PortalException;
085    
086            /**
087            * Creates a new export import configuration with the primary key. Does not add the export import configuration to the database.
088            *
089            * @param exportImportConfigurationId the primary key for the new export import configuration
090            * @return the new export import configuration
091            */
092            public com.liferay.portlet.exportimport.model.ExportImportConfiguration createExportImportConfiguration(
093                    long exportImportConfigurationId);
094    
095            /**
096            * Deletes the export import configuration from the database. Also notifies the appropriate model listeners.
097            *
098            * @param exportImportConfiguration the export import configuration
099            * @return the export import configuration that was removed
100            */
101            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
102            @com.liferay.portal.kernel.systemevent.SystemEvent(type = SystemEventConstants.TYPE_DELETE)
103            public com.liferay.portlet.exportimport.model.ExportImportConfiguration deleteExportImportConfiguration(
104                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration);
105    
106            /**
107            * Deletes the export import configuration with the primary key from the database. Also notifies the appropriate model listeners.
108            *
109            * @param exportImportConfigurationId the primary key of the export import configuration
110            * @return the export import configuration that was removed
111            * @throws PortalException if a export import configuration with the primary key could not be found
112            */
113            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
114            public com.liferay.portlet.exportimport.model.ExportImportConfiguration deleteExportImportConfiguration(
115                    long exportImportConfigurationId) throws PortalException;
116    
117            public void deleteExportImportConfigurations(long groupId);
118    
119            /**
120            * @throws PortalException
121            */
122            @Override
123            public com.liferay.portal.model.PersistedModel deletePersistedModel(
124                    com.liferay.portal.model.PersistedModel persistedModel)
125                    throws PortalException;
126    
127            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
128    
129            /**
130            * Performs a dynamic query on the database and returns the matching rows.
131            *
132            * @param dynamicQuery the dynamic query
133            * @return the matching rows
134            */
135            public <T> java.util.List<T> dynamicQuery(
136                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
137    
138            /**
139            * Performs a dynamic query on the database and returns a range of the matching rows.
140            *
141            * <p>
142            * 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.
143            * </p>
144            *
145            * @param dynamicQuery the dynamic query
146            * @param start the lower bound of the range of model instances
147            * @param end the upper bound of the range of model instances (not inclusive)
148            * @return the range of matching rows
149            */
150            public <T> java.util.List<T> dynamicQuery(
151                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
152                    int end);
153    
154            /**
155            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
156            *
157            * <p>
158            * 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.
159            * </p>
160            *
161            * @param dynamicQuery the dynamic query
162            * @param start the lower bound of the range of model instances
163            * @param end the upper bound of the range of model instances (not inclusive)
164            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
165            * @return the ordered range of matching rows
166            */
167            public <T> java.util.List<T> dynamicQuery(
168                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
169                    int end,
170                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
171    
172            /**
173            * Returns the number of rows matching the dynamic query.
174            *
175            * @param dynamicQuery the dynamic query
176            * @return the number of rows matching the dynamic query
177            */
178            public long dynamicQueryCount(
179                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
180    
181            /**
182            * Returns the number of rows matching the dynamic query.
183            *
184            * @param dynamicQuery the dynamic query
185            * @param projection the projection to apply to the query
186            * @return the number of rows matching the dynamic query
187            */
188            public long dynamicQueryCount(
189                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
190                    com.liferay.portal.kernel.dao.orm.Projection projection);
191    
192            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
193            public com.liferay.portlet.exportimport.model.ExportImportConfiguration fetchExportImportConfiguration(
194                    long exportImportConfigurationId);
195    
196            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
197            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
198    
199            /**
200            * Returns the export import configuration with the primary key.
201            *
202            * @param exportImportConfigurationId the primary key of the export import configuration
203            * @return the export import configuration
204            * @throws PortalException if a export import configuration with the primary key could not be found
205            */
206            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
207            public com.liferay.portlet.exportimport.model.ExportImportConfiguration getExportImportConfiguration(
208                    long exportImportConfigurationId) throws PortalException;
209    
210            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
211            public java.util.List<com.liferay.portlet.exportimport.model.ExportImportConfiguration> getExportImportConfigurations(
212                    long groupId, int type);
213    
214            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
215            public java.util.List<com.liferay.portlet.exportimport.model.ExportImportConfiguration> getExportImportConfigurations(
216                    long groupId, int type, int start, int end,
217                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.exportimport.model.ExportImportConfiguration> orderByComparator);
218    
219            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220            public java.util.List<com.liferay.portlet.exportimport.model.ExportImportConfiguration> getExportImportConfigurations(
221                    com.liferay.portal.kernel.search.Hits hits) throws PortalException;
222    
223            /**
224            * Returns a range of all the export import configurations.
225            *
226            * <p>
227            * 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.
228            * </p>
229            *
230            * @param start the lower bound of the range of export import configurations
231            * @param end the upper bound of the range of export import configurations (not inclusive)
232            * @return the range of export import configurations
233            */
234            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
235            public java.util.List<com.liferay.portlet.exportimport.model.ExportImportConfiguration> getExportImportConfigurations(
236                    int start, int end);
237    
238            /**
239            * Returns the number of export import configurations.
240            *
241            * @return the number of export import configurations
242            */
243            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
244            public int getExportImportConfigurationsCount();
245    
246            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
247            public int getExportImportConfigurationsCount(long groupId);
248    
249            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
250            public int getExportImportConfigurationsCount(long groupId, int type);
251    
252            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
253            public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
254    
255            /**
256            * Returns the OSGi service identifier.
257            *
258            * @return the OSGi service identifier
259            */
260            public java.lang.String getOSGiServiceIdentifier();
261    
262            @Override
263            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
264            public com.liferay.portal.model.PersistedModel getPersistedModel(
265                    java.io.Serializable primaryKeyObj) throws PortalException;
266    
267            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
268            public com.liferay.portlet.exportimport.model.ExportImportConfiguration moveExportImportConfigurationToTrash(
269                    long userId, long exportImportConfigurationId)
270                    throws PortalException;
271    
272            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
273            public com.liferay.portlet.exportimport.model.ExportImportConfiguration restoreExportImportConfigurationFromTrash(
274                    long userId, long exportImportConfigurationId)
275                    throws PortalException;
276    
277            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
278            public com.liferay.portal.kernel.search.BaseModelSearchResult<com.liferay.portlet.exportimport.model.ExportImportConfiguration> searchExportImportConfigurations(
279                    long companyId, long groupId, int type, java.lang.String keywords,
280                    int start, int end, com.liferay.portal.kernel.search.Sort sort)
281                    throws PortalException;
282    
283            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
284            public com.liferay.portal.kernel.search.BaseModelSearchResult<com.liferay.portlet.exportimport.model.ExportImportConfiguration> searchExportImportConfigurations(
285                    long companyId, long groupId, int type, java.lang.String name,
286                    java.lang.String description, boolean andSearch, int start, int end,
287                    com.liferay.portal.kernel.search.Sort sort) throws PortalException;
288    
289            /**
290            * Updates the export import configuration in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
291            *
292            * @param exportImportConfiguration the export import configuration
293            * @return the export import configuration that was updated
294            */
295            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
296            public com.liferay.portlet.exportimport.model.ExportImportConfiguration updateExportImportConfiguration(
297                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration);
298    
299            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
300            public com.liferay.portlet.exportimport.model.ExportImportConfiguration updateExportImportConfiguration(
301                    long userId, long exportImportConfigurationId, java.lang.String name,
302                    java.lang.String description,
303                    java.util.Map<java.lang.String, java.io.Serializable> settingsMap,
304                    com.liferay.portal.service.ServiceContext serviceContext)
305                    throws PortalException;
306    
307            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
308            public com.liferay.portlet.exportimport.model.ExportImportConfiguration updateStatus(
309                    long userId, long exportImportConfigurationId, int status)
310                    throws PortalException;
311    }