001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.service;
016    
017    import com.liferay.portal.kernel.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.transaction.Isolation;
020    import com.liferay.portal.kernel.transaction.Propagation;
021    import com.liferay.portal.kernel.transaction.Transactional;
022    
023    /**
024     * Provides the local service interface for BackgroundTask. Methods of this
025     * service will not have security checks based on the propagated JAAS
026     * credentials because this service can only be accessed from within the same
027     * VM.
028     *
029     * @author Brian Wing Shun Chan
030     * @see BackgroundTaskLocalServiceUtil
031     * @see com.liferay.portal.service.base.BackgroundTaskLocalServiceBaseImpl
032     * @see com.liferay.portal.service.impl.BackgroundTaskLocalServiceImpl
033     * @generated
034     */
035    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
036            PortalException.class, SystemException.class})
037    public interface BackgroundTaskLocalService extends BaseLocalService,
038            PersistedModelLocalService {
039            /*
040             * NOTE FOR DEVELOPERS:
041             *
042             * 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.
043             */
044    
045            /**
046            * Adds the background task to the database. Also notifies the appropriate model listeners.
047            *
048            * @param backgroundTask the background task
049            * @return the background task that was added
050            * @throws SystemException if a system exception occurred
051            */
052            public com.liferay.portal.model.BackgroundTask addBackgroundTask(
053                    com.liferay.portal.model.BackgroundTask backgroundTask)
054                    throws com.liferay.portal.kernel.exception.SystemException;
055    
056            /**
057            * Creates a new background task with the primary key. Does not add the background task to the database.
058            *
059            * @param backgroundTaskId the primary key for the new background task
060            * @return the new background task
061            */
062            public com.liferay.portal.model.BackgroundTask createBackgroundTask(
063                    long backgroundTaskId);
064    
065            /**
066            * Deletes the background task with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param backgroundTaskId the primary key of the background task
069            * @return the background task that was removed
070            * @throws PortalException if a background task with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public com.liferay.portal.model.BackgroundTask deleteBackgroundTask(
074                    long backgroundTaskId)
075                    throws com.liferay.portal.kernel.exception.PortalException,
076                            com.liferay.portal.kernel.exception.SystemException;
077    
078            /**
079            * Deletes the background task from the database. Also notifies the appropriate model listeners.
080            *
081            * @param backgroundTask the background task
082            * @return the background task that was removed
083            * @throws PortalException
084            * @throws SystemException if a system exception occurred
085            */
086            public com.liferay.portal.model.BackgroundTask deleteBackgroundTask(
087                    com.liferay.portal.model.BackgroundTask backgroundTask)
088                    throws com.liferay.portal.kernel.exception.PortalException,
089                            com.liferay.portal.kernel.exception.SystemException;
090    
091            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
092    
093            /**
094            * Performs a dynamic query on the database and returns the matching rows.
095            *
096            * @param dynamicQuery the dynamic query
097            * @return the matching rows
098            * @throws SystemException if a system exception occurred
099            */
100            @SuppressWarnings("rawtypes")
101            public java.util.List dynamicQuery(
102                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
103                    throws com.liferay.portal.kernel.exception.SystemException;
104    
105            /**
106            * Performs a dynamic query on the database and returns a range of the matching rows.
107            *
108            * <p>
109            * 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.
110            * </p>
111            *
112            * @param dynamicQuery the dynamic query
113            * @param start the lower bound of the range of model instances
114            * @param end the upper bound of the range of model instances (not inclusive)
115            * @return the range of matching rows
116            * @throws SystemException if a system exception occurred
117            */
118            @SuppressWarnings("rawtypes")
119            public java.util.List dynamicQuery(
120                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
121                    int end) throws com.liferay.portal.kernel.exception.SystemException;
122    
123            /**
124            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
125            *
126            * <p>
127            * 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.
128            * </p>
129            *
130            * @param dynamicQuery the dynamic query
131            * @param start the lower bound of the range of model instances
132            * @param end the upper bound of the range of model instances (not inclusive)
133            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
134            * @return the ordered range of matching rows
135            * @throws SystemException if a system exception occurred
136            */
137            @SuppressWarnings("rawtypes")
138            public java.util.List dynamicQuery(
139                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
140                    int end,
141                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
142                    throws com.liferay.portal.kernel.exception.SystemException;
143    
144            /**
145            * Returns the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException;
154    
155            /**
156            * Returns the number of rows that match the dynamic query.
157            *
158            * @param dynamicQuery the dynamic query
159            * @param projection the projection to apply to the query
160            * @return the number of rows that match the dynamic query
161            * @throws SystemException if a system exception occurred
162            */
163            public long dynamicQueryCount(
164                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
165                    com.liferay.portal.kernel.dao.orm.Projection projection)
166                    throws com.liferay.portal.kernel.exception.SystemException;
167    
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portal.model.BackgroundTask fetchBackgroundTask(
170                    long backgroundTaskId)
171                    throws com.liferay.portal.kernel.exception.SystemException;
172    
173            /**
174            * Returns the background task with the primary key.
175            *
176            * @param backgroundTaskId the primary key of the background task
177            * @return the background task
178            * @throws PortalException if a background task with the primary key could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
182            public com.liferay.portal.model.BackgroundTask getBackgroundTask(
183                    long backgroundTaskId)
184                    throws com.liferay.portal.kernel.exception.PortalException,
185                            com.liferay.portal.kernel.exception.SystemException;
186    
187            @Override
188            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
189            public com.liferay.portal.model.PersistedModel getPersistedModel(
190                    java.io.Serializable primaryKeyObj)
191                    throws com.liferay.portal.kernel.exception.PortalException,
192                            com.liferay.portal.kernel.exception.SystemException;
193    
194            /**
195            * Returns a range of all the background tasks.
196            *
197            * <p>
198            * 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.
199            * </p>
200            *
201            * @param start the lower bound of the range of background tasks
202            * @param end the upper bound of the range of background tasks (not inclusive)
203            * @return the range of background tasks
204            * @throws SystemException if a system exception occurred
205            */
206            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
207            public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
208                    int start, int end)
209                    throws com.liferay.portal.kernel.exception.SystemException;
210    
211            /**
212            * Returns the number of background tasks.
213            *
214            * @return the number of background tasks
215            * @throws SystemException if a system exception occurred
216            */
217            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
218            public int getBackgroundTasksCount()
219                    throws com.liferay.portal.kernel.exception.SystemException;
220    
221            /**
222            * Updates the background task in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
223            *
224            * @param backgroundTask the background task
225            * @return the background task that was updated
226            * @throws SystemException if a system exception occurred
227            */
228            public com.liferay.portal.model.BackgroundTask updateBackgroundTask(
229                    com.liferay.portal.model.BackgroundTask backgroundTask)
230                    throws com.liferay.portal.kernel.exception.SystemException;
231    
232            /**
233            * Returns the Spring bean ID for this bean.
234            *
235            * @return the Spring bean ID for this bean
236            */
237            public java.lang.String getBeanIdentifier();
238    
239            /**
240            * Sets the Spring bean ID for this bean.
241            *
242            * @param beanIdentifier the Spring bean ID for this bean
243            */
244            public void setBeanIdentifier(java.lang.String beanIdentifier);
245    
246            public com.liferay.portal.model.BackgroundTask addBackgroundTask(
247                    long userId, long groupId, java.lang.String name,
248                    java.lang.String[] servletContextNames,
249                    java.lang.Class<?> taskExecutorClass,
250                    java.util.Map<java.lang.String, java.io.Serializable> taskContextMap,
251                    com.liferay.portal.service.ServiceContext serviceContext)
252                    throws com.liferay.portal.kernel.exception.PortalException,
253                            com.liferay.portal.kernel.exception.SystemException;
254    
255            public void addBackgroundTaskAttachment(long userId, long backgroundTaskId,
256                    java.lang.String fileName, java.io.File file)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException;
259    
260            public void addBackgroundTaskAttachment(long userId, long backgroundTaskId,
261                    java.lang.String fileName, java.io.InputStream inputStream)
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException;
264    
265            public com.liferay.portal.model.BackgroundTask amendBackgroundTask(
266                    long backgroundTaskId,
267                    java.util.Map<java.lang.String, java.io.Serializable> taskContextMap,
268                    int status, com.liferay.portal.service.ServiceContext serviceContext)
269                    throws com.liferay.portal.kernel.exception.SystemException;
270    
271            public com.liferay.portal.model.BackgroundTask amendBackgroundTask(
272                    long backgroundTaskId,
273                    java.util.Map<java.lang.String, java.io.Serializable> taskContextMap,
274                    int status, java.lang.String statusMessage,
275                    com.liferay.portal.service.ServiceContext serviceContext)
276                    throws com.liferay.portal.kernel.exception.SystemException;
277    
278            public void cleanUpBackgroundTask(
279                    com.liferay.portal.model.BackgroundTask backgroundTask, int status);
280    
281            public void cleanUpBackgroundTasks()
282                    throws com.liferay.portal.kernel.exception.SystemException;
283    
284            public void deleteCompanyBackgroundTasks(long companyId)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException;
287    
288            public void deleteGroupBackgroundTasks(long groupId)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException;
291    
292            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
293            public com.liferay.portal.model.BackgroundTask fetchFirstBackgroundTask(
294                    java.lang.String taskExecutorClassName, int status)
295                    throws com.liferay.portal.kernel.exception.SystemException;
296    
297            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
298            public com.liferay.portal.model.BackgroundTask fetchFirstBackgroundTask(
299                    java.lang.String taskExecutorClassName, int status,
300                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
301                    throws com.liferay.portal.kernel.exception.SystemException;
302    
303            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
304            public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
305                    long groupId, int status)
306                    throws com.liferay.portal.kernel.exception.SystemException;
307    
308            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
309            public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
310                    long groupId, java.lang.String taskExecutorClassName)
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, java.lang.String taskExecutorClassName, 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, int start,
321                    int end,
322                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
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 name,
328                    java.lang.String taskExecutorClassName, int start, int end,
329                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
330                    throws com.liferay.portal.kernel.exception.SystemException;
331    
332            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
333            public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
334                    long groupId, java.lang.String[] taskExecutorClassNames)
335                    throws com.liferay.portal.kernel.exception.SystemException;
336    
337            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
338            public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
339                    long groupId, java.lang.String[] taskExecutorClassNames, int status)
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, int start,
345                    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                    java.lang.String taskExecutorClassName, int status)
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                    java.lang.String taskExecutorClassName, int status, int start, int end,
357                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
358                    throws com.liferay.portal.kernel.exception.SystemException;
359    
360            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
361            public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
362                    java.lang.String[] taskExecutorClassNames, int status)
363                    throws com.liferay.portal.kernel.exception.SystemException;
364    
365            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
366            public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
367                    java.lang.String[] taskExecutorClassNames, int status, int start,
368                    int end,
369                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
370                    throws com.liferay.portal.kernel.exception.SystemException;
371    
372            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
373            public int getBackgroundTasksCount(long groupId,
374                    java.lang.String taskExecutorClassName)
375                    throws com.liferay.portal.kernel.exception.SystemException;
376    
377            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
378            public int getBackgroundTasksCount(long groupId,
379                    java.lang.String taskExecutorClassName, boolean completed)
380                    throws com.liferay.portal.kernel.exception.SystemException;
381    
382            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
383            public int getBackgroundTasksCount(long groupId, java.lang.String name,
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, java.lang.String name,
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,
394                    java.lang.String[] taskExecutorClassNames)
395                    throws com.liferay.portal.kernel.exception.SystemException;
396    
397            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
398            public int getBackgroundTasksCount(long groupId,
399                    java.lang.String[] taskExecutorClassNames, boolean completed)
400                    throws com.liferay.portal.kernel.exception.SystemException;
401    
402            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
403            public java.lang.String getBackgroundTaskStatusJSON(long backgroundTaskId);
404    
405            public void resumeBackgroundTask(long backgroundTaskId)
406                    throws com.liferay.portal.kernel.exception.SystemException;
407    
408            public void triggerBackgroundTask(long backgroundTaskId);
409    }