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.model;
016    
017    import com.liferay.portal.kernel.bean.AutoEscape;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.service.ServiceContext;
020    
021    import com.liferay.portlet.expando.model.ExpandoBridge;
022    
023    import java.io.Serializable;
024    
025    import java.util.Date;
026    
027    /**
028     * 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.
029     *
030     * <p>
031     * 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}.
032     * </p>
033     *
034     * @author Brian Wing Shun Chan
035     * @see BackgroundTask
036     * @see com.liferay.portal.model.impl.BackgroundTaskImpl
037     * @see com.liferay.portal.model.impl.BackgroundTaskModelImpl
038     * @generated
039     */
040    public interface BackgroundTaskModel extends BaseModel<BackgroundTask>,
041            GroupedModel {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * Never modify or reference this interface directly. All methods that expect a background task model instance should use the {@link BackgroundTask} interface instead.
046             */
047    
048            /**
049             * Returns the primary key of this background task.
050             *
051             * @return the primary key of this background task
052             */
053            public long getPrimaryKey();
054    
055            /**
056             * Sets the primary key of this background task.
057             *
058             * @param primaryKey the primary key of this background task
059             */
060            public void setPrimaryKey(long primaryKey);
061    
062            /**
063             * Returns the background task ID of this background task.
064             *
065             * @return the background task ID of this background task
066             */
067            public long getBackgroundTaskId();
068    
069            /**
070             * Sets the background task ID of this background task.
071             *
072             * @param backgroundTaskId the background task ID of this background task
073             */
074            public void setBackgroundTaskId(long backgroundTaskId);
075    
076            /**
077             * Returns the group ID of this background task.
078             *
079             * @return the group ID of this background task
080             */
081            @Override
082            public long getGroupId();
083    
084            /**
085             * Sets the group ID of this background task.
086             *
087             * @param groupId the group ID of this background task
088             */
089            @Override
090            public void setGroupId(long groupId);
091    
092            /**
093             * Returns the company ID of this background task.
094             *
095             * @return the company ID of this background task
096             */
097            @Override
098            public long getCompanyId();
099    
100            /**
101             * Sets the company ID of this background task.
102             *
103             * @param companyId the company ID of this background task
104             */
105            @Override
106            public void setCompanyId(long companyId);
107    
108            /**
109             * Returns the user ID of this background task.
110             *
111             * @return the user ID of this background task
112             */
113            @Override
114            public long getUserId();
115    
116            /**
117             * Sets the user ID of this background task.
118             *
119             * @param userId the user ID of this background task
120             */
121            @Override
122            public void setUserId(long userId);
123    
124            /**
125             * Returns the user uuid of this background task.
126             *
127             * @return the user uuid of this background task
128             * @throws SystemException if a system exception occurred
129             */
130            @Override
131            public String getUserUuid() throws SystemException;
132    
133            /**
134             * Sets the user uuid of this background task.
135             *
136             * @param userUuid the user uuid of this background task
137             */
138            @Override
139            public void setUserUuid(String userUuid);
140    
141            /**
142             * Returns the user name of this background task.
143             *
144             * @return the user name of this background task
145             */
146            @AutoEscape
147            @Override
148            public String getUserName();
149    
150            /**
151             * Sets the user name of this background task.
152             *
153             * @param userName the user name of this background task
154             */
155            @Override
156            public void setUserName(String userName);
157    
158            /**
159             * Returns the create date of this background task.
160             *
161             * @return the create date of this background task
162             */
163            @Override
164            public Date getCreateDate();
165    
166            /**
167             * Sets the create date of this background task.
168             *
169             * @param createDate the create date of this background task
170             */
171            @Override
172            public void setCreateDate(Date createDate);
173    
174            /**
175             * Returns the modified date of this background task.
176             *
177             * @return the modified date of this background task
178             */
179            @Override
180            public Date getModifiedDate();
181    
182            /**
183             * Sets the modified date of this background task.
184             *
185             * @param modifiedDate the modified date of this background task
186             */
187            @Override
188            public void setModifiedDate(Date modifiedDate);
189    
190            /**
191             * Returns the name of this background task.
192             *
193             * @return the name of this background task
194             */
195            @AutoEscape
196            public String getName();
197    
198            /**
199             * Sets the name of this background task.
200             *
201             * @param name the name of this background task
202             */
203            public void setName(String name);
204    
205            /**
206             * Returns the servlet context names of this background task.
207             *
208             * @return the servlet context names of this background task
209             */
210            @AutoEscape
211            public String getServletContextNames();
212    
213            /**
214             * Sets the servlet context names of this background task.
215             *
216             * @param servletContextNames the servlet context names of this background task
217             */
218            public void setServletContextNames(String servletContextNames);
219    
220            /**
221             * Returns the task executor class name of this background task.
222             *
223             * @return the task executor class name of this background task
224             */
225            @AutoEscape
226            public String getTaskExecutorClassName();
227    
228            /**
229             * Sets the task executor class name of this background task.
230             *
231             * @param taskExecutorClassName the task executor class name of this background task
232             */
233            public void setTaskExecutorClassName(String taskExecutorClassName);
234    
235            /**
236             * Returns the task context of this background task.
237             *
238             * @return the task context of this background task
239             */
240            @AutoEscape
241            public String getTaskContext();
242    
243            /**
244             * Sets the task context of this background task.
245             *
246             * @param taskContext the task context of this background task
247             */
248            public void setTaskContext(String taskContext);
249    
250            /**
251             * Returns the completed of this background task.
252             *
253             * @return the completed of this background task
254             */
255            public boolean getCompleted();
256    
257            /**
258             * Returns <code>true</code> if this background task is completed.
259             *
260             * @return <code>true</code> if this background task is completed; <code>false</code> otherwise
261             */
262            public boolean isCompleted();
263    
264            /**
265             * Sets whether this background task is completed.
266             *
267             * @param completed the completed of this background task
268             */
269            public void setCompleted(boolean completed);
270    
271            /**
272             * Returns the completion date of this background task.
273             *
274             * @return the completion date of this background task
275             */
276            public Date getCompletionDate();
277    
278            /**
279             * Sets the completion date of this background task.
280             *
281             * @param completionDate the completion date of this background task
282             */
283            public void setCompletionDate(Date completionDate);
284    
285            /**
286             * Returns the status of this background task.
287             *
288             * @return the status of this background task
289             */
290            public int getStatus();
291    
292            /**
293             * Sets the status of this background task.
294             *
295             * @param status the status of this background task
296             */
297            public void setStatus(int status);
298    
299            /**
300             * Returns the status message of this background task.
301             *
302             * @return the status message of this background task
303             */
304            @AutoEscape
305            public String getStatusMessage();
306    
307            /**
308             * Sets the status message of this background task.
309             *
310             * @param statusMessage the status message of this background task
311             */
312            public void setStatusMessage(String statusMessage);
313    
314            @Override
315            public boolean isNew();
316    
317            @Override
318            public void setNew(boolean n);
319    
320            @Override
321            public boolean isCachedModel();
322    
323            @Override
324            public void setCachedModel(boolean cachedModel);
325    
326            @Override
327            public boolean isEscapedModel();
328    
329            @Override
330            public Serializable getPrimaryKeyObj();
331    
332            @Override
333            public void setPrimaryKeyObj(Serializable primaryKeyObj);
334    
335            @Override
336            public ExpandoBridge getExpandoBridge();
337    
338            @Override
339            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
340    
341            @Override
342            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
343    
344            @Override
345            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
346    
347            @Override
348            public Object clone();
349    
350            @Override
351            public int compareTo(BackgroundTask backgroundTask);
352    
353            @Override
354            public int hashCode();
355    
356            @Override
357            public CacheModel<BackgroundTask> toCacheModel();
358    
359            @Override
360            public BackgroundTask toEscapedModel();
361    
362            @Override
363            public BackgroundTask toUnescapedModel();
364    
365            @Override
366            public String toString();
367    
368            @Override
369            public String toXmlString();
370    }