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.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    
026    /**
027     * Provides the local service interface for BackgroundTask. Methods of this
028     * service will not have security checks based on the propagated JAAS
029     * credentials because this service can only be accessed from within the same
030     * VM.
031     *
032     * @author Brian Wing Shun Chan
033     * @see BackgroundTaskLocalServiceUtil
034     * @see com.liferay.portal.service.base.BackgroundTaskLocalServiceBaseImpl
035     * @see com.liferay.portal.service.impl.BackgroundTaskLocalServiceImpl
036     * @generated
037     */
038    @ProviderType
039    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
040            PortalException.class, SystemException.class})
041    public interface BackgroundTaskLocalService extends BaseLocalService,
042            PersistedModelLocalService {
043            /*
044             * NOTE FOR DEVELOPERS:
045             *
046             * Never modify or reference this interface directly. Always use {@link BackgroundTaskLocalServiceUtil} to access the background task local service. Add custom service methods to {@link com.liferay.portal.service.impl.BackgroundTaskLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
047             */
048    
049            /**
050            * Adds the background task to the database. Also notifies the appropriate model listeners.
051            *
052            * @param backgroundTask the background task
053            * @return the background task that was added
054            * @throws SystemException if a system exception occurred
055            */
056            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
057            public com.liferay.portal.model.BackgroundTask addBackgroundTask(
058                    com.liferay.portal.model.BackgroundTask backgroundTask)
059                    throws com.liferay.portal.kernel.exception.SystemException;
060    
061            /**
062            * Creates a new background task with the primary key. Does not add the background task to the database.
063            *
064            * @param backgroundTaskId the primary key for the new background task
065            * @return the new background task
066            */
067            public com.liferay.portal.model.BackgroundTask createBackgroundTask(
068                    long backgroundTaskId);
069    
070            /**
071            * Deletes the background task with the primary key from the database. Also notifies the appropriate model listeners.
072            *
073            * @param backgroundTaskId the primary key of the background task
074            * @return the background task that was removed
075            * @throws PortalException if a background task with the primary key could not be found
076            * @throws SystemException if a system exception occurred
077            */
078            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
079            public com.liferay.portal.model.BackgroundTask deleteBackgroundTask(
080                    long backgroundTaskId)
081                    throws com.liferay.portal.kernel.exception.PortalException,
082                            com.liferay.portal.kernel.exception.SystemException;
083    
084            /**
085            * Deletes the background task from the database. Also notifies the appropriate model listeners.
086            *
087            * @param backgroundTask the background task
088            * @return the background task that was removed
089            * @throws PortalException
090            * @throws SystemException if a system exception occurred
091            */
092            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
093            public com.liferay.portal.model.BackgroundTask deleteBackgroundTask(
094                    com.liferay.portal.model.BackgroundTask backgroundTask)
095                    throws com.liferay.portal.kernel.exception.PortalException,
096                            com.liferay.portal.kernel.exception.SystemException;
097    
098            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
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 java.util.List dynamicQuery(
109                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
110                    throws com.liferay.portal.kernel.exception.SystemException;
111    
112            /**
113            * Performs a dynamic query on the database and returns a range of the matching rows.
114            *
115            * <p>
116            * 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.BackgroundTaskModelImpl}. 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.
117            * </p>
118            *
119            * @param dynamicQuery the dynamic query
120            * @param start the lower bound of the range of model instances
121            * @param end the upper bound of the range of model instances (not inclusive)
122            * @return the range of matching rows
123            * @throws SystemException if a system exception occurred
124            */
125            @SuppressWarnings("rawtypes")
126            public java.util.List dynamicQuery(
127                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
128                    int end) throws com.liferay.portal.kernel.exception.SystemException;
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.BackgroundTaskModelImpl}. 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 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    
151            /**
152            * Returns the number of rows that match the dynamic query.
153            *
154            * @param dynamicQuery the dynamic query
155            * @return the number of rows that match the dynamic query
156            * @throws SystemException if a system exception occurred
157            */
158            public long dynamicQueryCount(
159                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
160                    throws com.liferay.portal.kernel.exception.SystemException;
161    
162            /**
163            * Returns the number of rows that match the dynamic query.
164            *
165            * @param dynamicQuery the dynamic query
166            * @param projection the projection to apply to the query
167            * @return the number of rows that match the dynamic query
168            * @throws SystemException if a system exception occurred
169            */
170            public long dynamicQueryCount(
171                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
172                    com.liferay.portal.kernel.dao.orm.Projection projection)
173                    throws com.liferay.portal.kernel.exception.SystemException;
174    
175            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176            public com.liferay.portal.model.BackgroundTask fetchBackgroundTask(
177                    long backgroundTaskId)
178                    throws com.liferay.portal.kernel.exception.SystemException;
179    
180            /**
181            * Returns the background task with the primary key.
182            *
183            * @param backgroundTaskId the primary key of the background task
184            * @return the background task
185            * @throws PortalException if a background task with the primary key could not be found
186            * @throws SystemException if a system exception occurred
187            */
188            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
189            public com.liferay.portal.model.BackgroundTask getBackgroundTask(
190                    long backgroundTaskId)
191                    throws com.liferay.portal.kernel.exception.PortalException,
192                            com.liferay.portal.kernel.exception.SystemException;
193    
194            @Override
195            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
196            public com.liferay.portal.model.PersistedModel getPersistedModel(
197                    java.io.Serializable primaryKeyObj)
198                    throws com.liferay.portal.kernel.exception.PortalException,
199                            com.liferay.portal.kernel.exception.SystemException;
200    
201            /**
202            * Returns a range of all the background tasks.
203            *
204            * <p>
205            * 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.BackgroundTaskModelImpl}. 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.
206            * </p>
207            *
208            * @param start the lower bound of the range of background tasks
209            * @param end the upper bound of the range of background tasks (not inclusive)
210            * @return the range of background tasks
211            * @throws SystemException if a system exception occurred
212            */
213            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
214            public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
215                    int start, int end)
216                    throws com.liferay.portal.kernel.exception.SystemException;
217    
218            /**
219            * Returns the number of background tasks.
220            *
221            * @return the number of background tasks
222            * @throws SystemException if a system exception occurred
223            */
224            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
225            public int getBackgroundTasksCount()
226                    throws com.liferay.portal.kernel.exception.SystemException;
227    
228            /**
229            * Updates the background task in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
230            *
231            * @param backgroundTask the background task
232            * @return the background task that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
236            public com.liferay.portal.model.BackgroundTask updateBackgroundTask(
237                    com.liferay.portal.model.BackgroundTask backgroundTask)
238                    throws com.liferay.portal.kernel.exception.SystemException;
239    
240            /**
241            * Returns the Spring bean ID for this bean.
242            *
243            * @return the Spring bean ID for this bean
244            */
245            public java.lang.String getBeanIdentifier();
246    
247            /**
248            * Sets the Spring bean ID for this bean.
249            *
250            * @param beanIdentifier the Spring bean ID for this bean
251            */
252            public void setBeanIdentifier(java.lang.String beanIdentifier);
253    
254            public com.liferay.portal.model.BackgroundTask addBackgroundTask(
255                    long userId, long groupId, java.lang.String name,
256                    java.lang.String[] servletContextNames,
257                    java.lang.Class<?> taskExecutorClass,
258                    java.util.Map<java.lang.String, java.io.Serializable> taskContextMap,
259                    com.liferay.portal.service.ServiceContext serviceContext)
260                    throws com.liferay.portal.kernel.exception.PortalException,
261                            com.liferay.portal.kernel.exception.SystemException;
262    
263            public void addBackgroundTaskAttachment(long userId, long backgroundTaskId,
264                    java.lang.String fileName, java.io.File file)
265                    throws com.liferay.portal.kernel.exception.PortalException,
266                            com.liferay.portal.kernel.exception.SystemException;
267    
268            public void addBackgroundTaskAttachment(long userId, long backgroundTaskId,
269                    java.lang.String fileName, java.io.InputStream inputStream)
270                    throws com.liferay.portal.kernel.exception.PortalException,
271                            com.liferay.portal.kernel.exception.SystemException;
272    
273            public com.liferay.portal.model.BackgroundTask amendBackgroundTask(
274                    long backgroundTaskId,
275                    java.util.Map<java.lang.String, java.io.Serializable> taskContextMap,
276                    int status, com.liferay.portal.service.ServiceContext serviceContext)
277                    throws com.liferay.portal.kernel.exception.SystemException;
278    
279            public com.liferay.portal.model.BackgroundTask amendBackgroundTask(
280                    long backgroundTaskId,
281                    java.util.Map<java.lang.String, java.io.Serializable> taskContextMap,
282                    int status, java.lang.String statusMessage,
283                    com.liferay.portal.service.ServiceContext serviceContext)
284                    throws com.liferay.portal.kernel.exception.SystemException;
285    
286            @com.liferay.portal.kernel.cluster.Clusterable(onMaster = true)
287            public void cleanUpBackgroundTask(
288                    com.liferay.portal.model.BackgroundTask backgroundTask, int status);
289    
290            @com.liferay.portal.kernel.cluster.Clusterable(onMaster = true)
291            public void cleanUpBackgroundTasks()
292                    throws com.liferay.portal.kernel.exception.SystemException;
293    
294            public void deleteCompanyBackgroundTasks(long companyId)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException;
297    
298            public void deleteGroupBackgroundTasks(long groupId)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException;
301    
302            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
303            public com.liferay.portal.model.BackgroundTask fetchFirstBackgroundTask(
304                    long groupId, java.lang.String taskExecutorClassName,
305                    boolean completed,
306                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
307                    throws com.liferay.portal.kernel.exception.SystemException;
308    
309            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
310            public com.liferay.portal.model.BackgroundTask fetchFirstBackgroundTask(
311                    java.lang.String taskExecutorClassName, int status)
312                    throws com.liferay.portal.kernel.exception.SystemException;
313    
314            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
315            public com.liferay.portal.model.BackgroundTask fetchFirstBackgroundTask(
316                    java.lang.String taskExecutorClassName, int status,
317                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
318                    throws com.liferay.portal.kernel.exception.SystemException;
319    
320            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
321            public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
322                    long groupId, int status)
323                    throws com.liferay.portal.kernel.exception.SystemException;
324    
325            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
326            public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
327                    long groupId, java.lang.String taskExecutorClassName)
328                    throws com.liferay.portal.kernel.exception.SystemException;
329    
330            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
331            public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
332                    long groupId, java.lang.String taskExecutorClassName, int status)
333                    throws com.liferay.portal.kernel.exception.SystemException;
334    
335            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
336            public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
337                    long groupId, java.lang.String taskExecutorClassName, int start,
338                    int end,
339                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
340                    throws com.liferay.portal.kernel.exception.SystemException;
341    
342            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
343            public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
344                    long groupId, java.lang.String name,
345                    java.lang.String taskExecutorClassName, int start, int end,
346                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
347                    throws com.liferay.portal.kernel.exception.SystemException;
348    
349            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
350            public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
351                    long groupId, java.lang.String[] taskExecutorClassNames)
352                    throws com.liferay.portal.kernel.exception.SystemException;
353    
354            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
355            public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
356                    long groupId, java.lang.String[] taskExecutorClassNames, int status)
357                    throws com.liferay.portal.kernel.exception.SystemException;
358    
359            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
360            public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
361                    long groupId, java.lang.String[] taskExecutorClassNames, int start,
362                    int end,
363                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
364                    throws com.liferay.portal.kernel.exception.SystemException;
365    
366            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
367            public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
368                    java.lang.String taskExecutorClassName, int status)
369                    throws com.liferay.portal.kernel.exception.SystemException;
370    
371            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
372            public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
373                    java.lang.String taskExecutorClassName, int status, int start, int end,
374                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
375                    throws com.liferay.portal.kernel.exception.SystemException;
376    
377            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
378            public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
379                    java.lang.String[] taskExecutorClassNames, int status)
380                    throws com.liferay.portal.kernel.exception.SystemException;
381    
382            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
383            public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
384                    java.lang.String[] taskExecutorClassNames, int status, int start,
385                    int end,
386                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
387                    throws com.liferay.portal.kernel.exception.SystemException;
388    
389            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
390            public int getBackgroundTasksCount(long groupId,
391                    java.lang.String taskExecutorClassName)
392                    throws com.liferay.portal.kernel.exception.SystemException;
393    
394            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
395            public int getBackgroundTasksCount(long groupId,
396                    java.lang.String taskExecutorClassName, boolean completed)
397                    throws com.liferay.portal.kernel.exception.SystemException;
398    
399            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
400            public int getBackgroundTasksCount(long groupId, java.lang.String name,
401                    java.lang.String taskExecutorClassName)
402                    throws com.liferay.portal.kernel.exception.SystemException;
403    
404            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
405            public int getBackgroundTasksCount(long groupId, java.lang.String name,
406                    java.lang.String taskExecutorClassName, boolean completed)
407                    throws com.liferay.portal.kernel.exception.SystemException;
408    
409            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
410            public int getBackgroundTasksCount(long groupId,
411                    java.lang.String[] taskExecutorClassNames)
412                    throws com.liferay.portal.kernel.exception.SystemException;
413    
414            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
415            public int getBackgroundTasksCount(long groupId,
416                    java.lang.String[] taskExecutorClassNames, boolean completed)
417                    throws com.liferay.portal.kernel.exception.SystemException;
418    
419            @com.liferay.portal.kernel.cluster.Clusterable(onMaster = true)
420            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
421            public java.lang.String getBackgroundTaskStatusJSON(long backgroundTaskId);
422    
423            @com.liferay.portal.kernel.cluster.Clusterable(onMaster = true)
424            public void resumeBackgroundTask(long backgroundTaskId)
425                    throws com.liferay.portal.kernel.exception.SystemException;
426    
427            @com.liferay.portal.kernel.cluster.Clusterable(onMaster = true)
428            public void triggerBackgroundTask(long backgroundTaskId);
429    }