001
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
038 @ProviderType
039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = {
040 PortalException.class, SystemException.class})
041 public interface BackgroundTaskLocalService extends BaseLocalService,
042 PersistedModelLocalService {
043
048
049
055 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
056 public com.liferay.portal.model.BackgroundTask addBackgroundTask(
057 com.liferay.portal.model.BackgroundTask backgroundTask);
058
059 public com.liferay.portal.model.BackgroundTask addBackgroundTask(
060 long userId, long groupId, java.lang.String name,
061 java.lang.String[] servletContextNames,
062 java.lang.Class<?> taskExecutorClass,
063 java.util.Map<java.lang.String, java.io.Serializable> taskContextMap,
064 com.liferay.portal.service.ServiceContext serviceContext)
065 throws PortalException;
066
067 public void addBackgroundTaskAttachment(long userId, long backgroundTaskId,
068 java.lang.String fileName, java.io.File file) throws PortalException;
069
070 public void addBackgroundTaskAttachment(long userId, long backgroundTaskId,
071 java.lang.String fileName, java.io.InputStream inputStream)
072 throws PortalException;
073
074 public com.liferay.portal.model.BackgroundTask amendBackgroundTask(
075 long backgroundTaskId,
076 java.util.Map<java.lang.String, java.io.Serializable> taskContextMap,
077 int status, com.liferay.portal.service.ServiceContext serviceContext);
078
079 public com.liferay.portal.model.BackgroundTask amendBackgroundTask(
080 long backgroundTaskId,
081 java.util.Map<java.lang.String, java.io.Serializable> taskContextMap,
082 int status, java.lang.String statusMessage,
083 com.liferay.portal.service.ServiceContext serviceContext);
084
085 @com.liferay.portal.kernel.cluster.Clusterable(onMaster = true)
086 public void cleanUpBackgroundTask(
087 com.liferay.portal.model.BackgroundTask backgroundTask, int status);
088
089 @com.liferay.portal.kernel.cluster.Clusterable(onMaster = true)
090 public void cleanUpBackgroundTasks();
091
092
098 public com.liferay.portal.model.BackgroundTask createBackgroundTask(
099 long backgroundTaskId);
100
101
108 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
109 public com.liferay.portal.model.BackgroundTask deleteBackgroundTask(
110 com.liferay.portal.model.BackgroundTask backgroundTask)
111 throws PortalException;
112
113
120 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
121 public com.liferay.portal.model.BackgroundTask deleteBackgroundTask(
122 long backgroundTaskId) throws PortalException;
123
124 public void deleteCompanyBackgroundTasks(long companyId)
125 throws PortalException;
126
127 public void deleteGroupBackgroundTasks(long groupId)
128 throws PortalException;
129
130
133 @Override
134 public com.liferay.portal.model.PersistedModel deletePersistedModel(
135 com.liferay.portal.model.PersistedModel persistedModel)
136 throws PortalException;
137
138 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
139
140
146 public <T> java.util.List<T> dynamicQuery(
147 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
148
149
161 public <T> java.util.List<T> dynamicQuery(
162 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
163 int end);
164
165
178 public <T> java.util.List<T> dynamicQuery(
179 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
180 int end,
181 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
182
183
189 public long dynamicQueryCount(
190 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
191
192
199 public long dynamicQueryCount(
200 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
201 com.liferay.portal.kernel.dao.orm.Projection projection);
202
203 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
204 public com.liferay.portal.model.BackgroundTask fetchBackgroundTask(
205 long backgroundTaskId);
206
207 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
208 public com.liferay.portal.model.BackgroundTask fetchFirstBackgroundTask(
209 long groupId, java.lang.String taskExecutorClassName,
210 boolean completed,
211 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.BackgroundTask> orderByComparator);
212
213 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
214 public com.liferay.portal.model.BackgroundTask fetchFirstBackgroundTask(
215 java.lang.String taskExecutorClassName, int status);
216
217 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
218 public com.liferay.portal.model.BackgroundTask fetchFirstBackgroundTask(
219 java.lang.String taskExecutorClassName, int status,
220 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.BackgroundTask> orderByComparator);
221
222 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
223 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
224
225
232 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
233 public com.liferay.portal.model.BackgroundTask getBackgroundTask(
234 long backgroundTaskId) throws PortalException;
235
236 @com.liferay.portal.kernel.cluster.Clusterable(onMaster = true)
237 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
238 public java.lang.String getBackgroundTaskStatusJSON(long backgroundTaskId);
239
240 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
241 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
242 long groupId, java.lang.String name,
243 java.lang.String taskExecutorClassName, int start, int end,
244 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.BackgroundTask> orderByComparator);
245
246 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
247 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
248 long groupId, int status);
249
250 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
251 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
252 long groupId, java.lang.String taskExecutorClassName);
253
254 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
255 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
256 long groupId, java.lang.String taskExecutorClassName, int start,
257 int end,
258 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.BackgroundTask> orderByComparator);
259
260 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
261 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
262 long groupId, java.lang.String taskExecutorClassName, int status);
263
264 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
265 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
266 long groupId, java.lang.String[] taskExecutorClassNames);
267
268 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
269 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
270 long groupId, java.lang.String[] taskExecutorClassNames, int start,
271 int end,
272 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.BackgroundTask> orderByComparator);
273
274 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
275 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
276 long groupId, java.lang.String[] taskExecutorClassNames, int status);
277
278
289 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
290 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
291 int start, int end);
292
293 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
294 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
295 java.lang.String taskExecutorClassName, int status);
296
297 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
298 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
299 java.lang.String taskExecutorClassName, int status, int start, int end,
300 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.BackgroundTask> orderByComparator);
301
302 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
303 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
304 java.lang.String[] taskExecutorClassNames, int status);
305
306 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
307 public java.util.List<com.liferay.portal.model.BackgroundTask> getBackgroundTasks(
308 java.lang.String[] taskExecutorClassNames, int status, int start,
309 int end,
310 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.BackgroundTask> orderByComparator);
311
312
317 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
318 public int getBackgroundTasksCount();
319
320 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
321 public int getBackgroundTasksCount(long groupId, java.lang.String name,
322 java.lang.String taskExecutorClassName);
323
324 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
325 public int getBackgroundTasksCount(long groupId, java.lang.String name,
326 java.lang.String taskExecutorClassName, boolean completed);
327
328 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
329 public int getBackgroundTasksCount(long groupId,
330 java.lang.String taskExecutorClassName);
331
332 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
333 public int getBackgroundTasksCount(long groupId,
334 java.lang.String taskExecutorClassName, boolean completed);
335
336 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
337 public int getBackgroundTasksCount(long groupId,
338 java.lang.String[] taskExecutorClassNames);
339
340 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
341 public int getBackgroundTasksCount(long groupId,
342 java.lang.String[] taskExecutorClassNames, boolean completed);
343
344
349 public java.lang.String getBeanIdentifier();
350
351 @Override
352 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
353 public com.liferay.portal.model.PersistedModel getPersistedModel(
354 java.io.Serializable primaryKeyObj) throws PortalException;
355
356 @com.liferay.portal.kernel.cluster.Clusterable(onMaster = true)
357 public void resumeBackgroundTask(long backgroundTaskId);
358
359
364 public void setBeanIdentifier(java.lang.String beanIdentifier);
365
366 @com.liferay.portal.kernel.cluster.Clusterable(onMaster = true)
367 public void triggerBackgroundTask(long backgroundTaskId);
368
369
375 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
376 public com.liferay.portal.model.BackgroundTask updateBackgroundTask(
377 com.liferay.portal.model.BackgroundTask backgroundTask);
378 }