001    /**
002     * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.model;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.bean.AutoEscape;
020    import com.liferay.portal.service.ServiceContext;
021    
022    import com.liferay.portlet.expando.model.ExpandoBridge;
023    
024    import java.io.Serializable;
025    
026    import java.util.Date;
027    import java.util.Map;
028    
029    /**
030     * The base model interface for the BackgroundTask service. Represents a row in the "BackgroundTask" database table, with each column mapped to a property of this class.
031     *
032     * <p>
033     * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.BackgroundTaskModelImpl} exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in {@link com.liferay.portal.model.impl.BackgroundTaskImpl}.
034     * </p>
035     *
036     * @author Brian Wing Shun Chan
037     * @see BackgroundTask
038     * @see com.liferay.portal.model.impl.BackgroundTaskImpl
039     * @see com.liferay.portal.model.impl.BackgroundTaskModelImpl
040     * @generated
041     */
042    @ProviderType
043    public interface BackgroundTaskModel extends BaseModel<BackgroundTask>,
044            GroupedModel, MVCCModel {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. All methods that expect a background task model instance should use the {@link BackgroundTask} interface instead.
049             */
050    
051            /**
052             * Returns the primary key of this background task.
053             *
054             * @return the primary key of this background task
055             */
056            public long getPrimaryKey();
057    
058            /**
059             * Sets the primary key of this background task.
060             *
061             * @param primaryKey the primary key of this background task
062             */
063            public void setPrimaryKey(long primaryKey);
064    
065            /**
066             * Returns the mvcc version of this background task.
067             *
068             * @return the mvcc version of this background task
069             */
070            @Override
071            public long getMvccVersion();
072    
073            /**
074             * Sets the mvcc version of this background task.
075             *
076             * @param mvccVersion the mvcc version of this background task
077             */
078            @Override
079            public void setMvccVersion(long mvccVersion);
080    
081            /**
082             * Returns the background task ID of this background task.
083             *
084             * @return the background task ID of this background task
085             */
086            public long getBackgroundTaskId();
087    
088            /**
089             * Sets the background task ID of this background task.
090             *
091             * @param backgroundTaskId the background task ID of this background task
092             */
093            public void setBackgroundTaskId(long backgroundTaskId);
094    
095            /**
096             * Returns the group ID of this background task.
097             *
098             * @return the group ID of this background task
099             */
100            @Override
101            public long getGroupId();
102    
103            /**
104             * Sets the group ID of this background task.
105             *
106             * @param groupId the group ID of this background task
107             */
108            @Override
109            public void setGroupId(long groupId);
110    
111            /**
112             * Returns the company ID of this background task.
113             *
114             * @return the company ID of this background task
115             */
116            @Override
117            public long getCompanyId();
118    
119            /**
120             * Sets the company ID of this background task.
121             *
122             * @param companyId the company ID of this background task
123             */
124            @Override
125            public void setCompanyId(long companyId);
126    
127            /**
128             * Returns the user ID of this background task.
129             *
130             * @return the user ID of this background task
131             */
132            @Override
133            public long getUserId();
134    
135            /**
136             * Sets the user ID of this background task.
137             *
138             * @param userId the user ID of this background task
139             */
140            @Override
141            public void setUserId(long userId);
142    
143            /**
144             * Returns the user uuid of this background task.
145             *
146             * @return the user uuid of this background task
147             */
148            @Override
149            public String getUserUuid();
150    
151            /**
152             * Sets the user uuid of this background task.
153             *
154             * @param userUuid the user uuid of this background task
155             */
156            @Override
157            public void setUserUuid(String userUuid);
158    
159            /**
160             * Returns the user name of this background task.
161             *
162             * @return the user name of this background task
163             */
164            @AutoEscape
165            @Override
166            public String getUserName();
167    
168            /**
169             * Sets the user name of this background task.
170             *
171             * @param userName the user name of this background task
172             */
173            @Override
174            public void setUserName(String userName);
175    
176            /**
177             * Returns the create date of this background task.
178             *
179             * @return the create date of this background task
180             */
181            @Override
182            public Date getCreateDate();
183    
184            /**
185             * Sets the create date of this background task.
186             *
187             * @param createDate the create date of this background task
188             */
189            @Override
190            public void setCreateDate(Date createDate);
191    
192            /**
193             * Returns the modified date of this background task.
194             *
195             * @return the modified date of this background task
196             */
197            @Override
198            public Date getModifiedDate();
199    
200            /**
201             * Sets the modified date of this background task.
202             *
203             * @param modifiedDate the modified date of this background task
204             */
205            @Override
206            public void setModifiedDate(Date modifiedDate);
207    
208            /**
209             * Returns the name of this background task.
210             *
211             * @return the name of this background task
212             */
213            @AutoEscape
214            public String getName();
215    
216            /**
217             * Sets the name of this background task.
218             *
219             * @param name the name of this background task
220             */
221            public void setName(String name);
222    
223            /**
224             * Returns the servlet context names of this background task.
225             *
226             * @return the servlet context names of this background task
227             */
228            @AutoEscape
229            public String getServletContextNames();
230    
231            /**
232             * Sets the servlet context names of this background task.
233             *
234             * @param servletContextNames the servlet context names of this background task
235             */
236            public void setServletContextNames(String servletContextNames);
237    
238            /**
239             * Returns the task executor class name of this background task.
240             *
241             * @return the task executor class name of this background task
242             */
243            @AutoEscape
244            public String getTaskExecutorClassName();
245    
246            /**
247             * Sets the task executor class name of this background task.
248             *
249             * @param taskExecutorClassName the task executor class name of this background task
250             */
251            public void setTaskExecutorClassName(String taskExecutorClassName);
252    
253            /**
254             * Returns the task context map of this background task.
255             *
256             * @return the task context map of this background task
257             */
258            public Map<String, Serializable> getTaskContextMap();
259    
260            /**
261             * Sets the task context map of this background task.
262             *
263             * @param taskContextMap the task context map of this background task
264             */
265            public void setTaskContextMap(Map<String, Serializable> taskContextMap);
266    
267            /**
268             * Returns the completed of this background task.
269             *
270             * @return the completed of this background task
271             */
272            public boolean getCompleted();
273    
274            /**
275             * Returns <code>true</code> if this background task is completed.
276             *
277             * @return <code>true</code> if this background task is completed; <code>false</code> otherwise
278             */
279            public boolean isCompleted();
280    
281            /**
282             * Sets whether this background task is completed.
283             *
284             * @param completed the completed of this background task
285             */
286            public void setCompleted(boolean completed);
287    
288            /**
289             * Returns the completion date of this background task.
290             *
291             * @return the completion date of this background task
292             */
293            public Date getCompletionDate();
294    
295            /**
296             * Sets the completion date of this background task.
297             *
298             * @param completionDate the completion date of this background task
299             */
300            public void setCompletionDate(Date completionDate);
301    
302            /**
303             * Returns the status of this background task.
304             *
305             * @return the status of this background task
306             */
307            public int getStatus();
308    
309            /**
310             * Sets the status of this background task.
311             *
312             * @param status the status of this background task
313             */
314            public void setStatus(int status);
315    
316            /**
317             * Returns the status message of this background task.
318             *
319             * @return the status message of this background task
320             */
321            @AutoEscape
322            public String getStatusMessage();
323    
324            /**
325             * Sets the status message of this background task.
326             *
327             * @param statusMessage the status message of this background task
328             */
329            public void setStatusMessage(String statusMessage);
330    
331            @Override
332            public boolean isNew();
333    
334            @Override
335            public void setNew(boolean n);
336    
337            @Override
338            public boolean isCachedModel();
339    
340            @Override
341            public void setCachedModel(boolean cachedModel);
342    
343            @Override
344            public boolean isEscapedModel();
345    
346            @Override
347            public Serializable getPrimaryKeyObj();
348    
349            @Override
350            public void setPrimaryKeyObj(Serializable primaryKeyObj);
351    
352            @Override
353            public ExpandoBridge getExpandoBridge();
354    
355            @Override
356            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
357    
358            @Override
359            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
360    
361            @Override
362            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
363    
364            @Override
365            public Object clone();
366    
367            @Override
368            public int compareTo(com.liferay.portal.model.BackgroundTask backgroundTask);
369    
370            @Override
371            public int hashCode();
372    
373            @Override
374            public CacheModel<com.liferay.portal.model.BackgroundTask> toCacheModel();
375    
376            @Override
377            public com.liferay.portal.model.BackgroundTask toEscapedModel();
378    
379            @Override
380            public com.liferay.portal.model.BackgroundTask toUnescapedModel();
381    
382            @Override
383            public String toString();
384    
385            @Override
386            public String toXmlString();
387    }