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