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