BackgroundTaskModel (Liferay CE Portal Background Task 4.0.12 API)

All Superinterfaces:

com.liferay.portal.kernel.model.AuditedModel, com.liferay.portal.kernel.model.BaseModel<BackgroundTask>, com.liferay.portal.kernel.model.ClassedModel, java.lang.Cloneable, java.lang.Comparable<BackgroundTask>, com.liferay.portal.kernel.model.GroupedModel, com.liferay.portal.kernel.model.MVCCModel, java.io.Serializable, com.liferay.portal.kernel.model.ShardedModel

All Known Subinterfaces:

BackgroundTask

All Known Implementing Classes:

BackgroundTaskWrapper
```
@ProviderType
public interface BackgroundTaskModel
extends com.liferay.portal.kernel.model.BaseModel<BackgroundTask>, com.liferay.portal.kernel.model.GroupedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel
```
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.
This interface and its corresponding implementation com.liferay.portal.background.task.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 com.liferay.portal.background.task.model.impl.BackgroundTaskImpl.

See Also:

BackgroundTask

Generated:

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BackgroundTask`	`cloneWithOriginalValues()`
`long`	`getBackgroundTaskId()` Returns the background task ID of this background task.
`long`	`getCompanyId()` Returns the company ID of this background task.
`boolean`	`getCompleted()` Returns the completed of this background task.
`java.util.Date`	`getCompletionDate()` Returns the completion date of this background task.
`java.util.Date`	`getCreateDate()` Returns the create date of this background task.
`long`	`getGroupId()` Returns the group ID of this background task.
`java.util.Date`	`getModifiedDate()` Returns the modified date of this background task.
`long`	`getMvccVersion()` Returns the mvcc version of this background task.
`java.lang.String`	`getName()` Returns the name of this background task.
`long`	`getPrimaryKey()` Returns the primary key of this background task.
`java.lang.String`	`getServletContextNames()` Returns the servlet context names of this background task.
`int`	`getStatus()` Returns the status of this background task.
`java.lang.String`	`getStatusMessage()` Returns the status message of this background task.
`java.util.Map<java.lang.String,java.io.Serializable>`	`getTaskContextMap()` Returns the task context map of this background task.
`java.lang.String`	`getTaskExecutorClassName()` Returns the task executor class name of this background task.
`long`	`getUserId()` Returns the user ID of this background task.
`java.lang.String`	`getUserName()` Returns the user name of this background task.
`java.lang.String`	`getUserUuid()` Returns the user uuid of this background task.
`boolean`	`isCompleted()` Returns `true` if this background task is completed.
`void`	`setBackgroundTaskId(long backgroundTaskId)` Sets the background task ID of this background task.
`void`	`setCompanyId(long companyId)` Sets the company ID of this background task.
`void`	`setCompleted(boolean completed)` Sets whether this background task is completed.
`void`	`setCompletionDate(java.util.Date completionDate)` Sets the completion date of this background task.
`void`	`setCreateDate(java.util.Date createDate)` Sets the create date of this background task.
`void`	`setGroupId(long groupId)` Sets the group ID of this background task.
`void`	`setModifiedDate(java.util.Date modifiedDate)` Sets the modified date of this background task.
`void`	`setMvccVersion(long mvccVersion)` Sets the mvcc version of this background task.
`void`	`setName(java.lang.String name)` Sets the name of this background task.
`void`	`setPrimaryKey(long primaryKey)` Sets the primary key of this background task.
`void`	`setServletContextNames(java.lang.String servletContextNames)` Sets the servlet context names of this background task.
`void`	`setStatus(int status)` Sets the status of this background task.
`void`	`setStatusMessage(java.lang.String statusMessage)` Sets the status message of this background task.
`void`	`setTaskContextMap(java.util.Map<java.lang.String,java.io.Serializable> taskContextMap)` Sets the task context map of this background task.
`void`	`setTaskExecutorClassName(java.lang.String taskExecutorClassName)` Sets the task executor class name of this background task.
`void`	`setUserId(long userId)` Sets the user ID of this background task.
`void`	`setUserName(java.lang.String userName)` Sets the user name of this background task.
`void`	`setUserUuid(java.lang.String userUuid)` Sets the user uuid of this background task.

Methods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel, toXmlString

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName

- Method Detail
  - getPrimaryKey
```
long getPrimaryKey()
```
    Returns the primary key of this background task.
    
    Returns:
    
    the primary key of this background task
  - setPrimaryKey
```
void setPrimaryKey(long primaryKey)
```
    Sets the primary key of this background task.
    
    Parameters:
    
    primaryKey - the primary key of this background task
  - getMvccVersion
```
long getMvccVersion()
```
    Returns the mvcc version of this background task.
    
    Specified by:
    
    getMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel
    
    Returns:
    
    the mvcc version of this background task
  - setMvccVersion
```
void setMvccVersion(long mvccVersion)
```
    Sets the mvcc version of this background task.
    
    Specified by:
    
    setMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel
    
    Parameters:
    
    mvccVersion - the mvcc version of this background task
  - getBackgroundTaskId
```
long getBackgroundTaskId()
```
    Returns the background task ID of this background task.
    
    Returns:
    
    the background task ID of this background task
  - setBackgroundTaskId
```
void setBackgroundTaskId(long backgroundTaskId)
```
    Sets the background task ID of this background task.
    
    Parameters:
    
    backgroundTaskId - the background task ID of this background task
  - getGroupId
```
long getGroupId()
```
    Returns the group ID of this background task.
    
    Specified by:
    
    getGroupId in interface com.liferay.portal.kernel.model.GroupedModel
    
    Returns:
    
    the group ID of this background task
  - setGroupId
```
void setGroupId(long groupId)
```
    Sets the group ID of this background task.
    
    Specified by:
    
    setGroupId in interface com.liferay.portal.kernel.model.GroupedModel
    
    Parameters:
    
    groupId - the group ID of this background task
  - getCompanyId
```
long getCompanyId()
```
    Returns the company ID of this background task.
    
    Specified by:
    
    getCompanyId in interface com.liferay.portal.kernel.model.AuditedModel
    
    Specified by:
    
    getCompanyId in interface com.liferay.portal.kernel.model.ShardedModel
    
    Returns:
    
    the company ID of this background task
  - setCompanyId
```
void setCompanyId(long companyId)
```
    Sets the company ID of this background task.
    
    Specified by:
    
    setCompanyId in interface com.liferay.portal.kernel.model.AuditedModel
    
    Specified by:
    
    setCompanyId in interface com.liferay.portal.kernel.model.ShardedModel
    
    Parameters:
    
    companyId - the company ID of this background task
  - getUserId
```
long getUserId()
```
    Returns the user ID of this background task.
    
    Specified by:
    
    getUserId in interface com.liferay.portal.kernel.model.AuditedModel
    
    Returns:
    
    the user ID of this background task
  - setUserId
```
void setUserId(long userId)
```
    Sets the user ID of this background task.
    
    Specified by:
    
    setUserId in interface com.liferay.portal.kernel.model.AuditedModel
    
    Parameters:
    
    userId - the user ID of this background task
  - getUserUuid
```
java.lang.String getUserUuid()
```
    Returns the user uuid of this background task.
    
    Specified by:
    
    getUserUuid in interface com.liferay.portal.kernel.model.AuditedModel
    
    Returns:
    
    the user uuid of this background task
  - setUserUuid
```
void setUserUuid(java.lang.String userUuid)
```
    Sets the user uuid of this background task.
    
    Specified by:
    
    setUserUuid in interface com.liferay.portal.kernel.model.AuditedModel
    
    Parameters:
    
    userUuid - the user uuid of this background task
  - getUserName
```
@AutoEscape
java.lang.String getUserName()
```
    Returns the user name of this background task.
    
    Specified by:
    
    getUserName in interface com.liferay.portal.kernel.model.AuditedModel
    
    Returns:
    
    the user name of this background task
  - setUserName
```
void setUserName(java.lang.String userName)
```
    Sets the user name of this background task.
    
    Specified by:
    
    setUserName in interface com.liferay.portal.kernel.model.AuditedModel
    
    Parameters:
    
    userName - the user name of this background task
  - getCreateDate
```
java.util.Date getCreateDate()
```
    Returns the create date of this background task.
    
    Specified by:
    
    getCreateDate in interface com.liferay.portal.kernel.model.AuditedModel
    
    Returns:
    
    the create date of this background task
  - setCreateDate
```
void setCreateDate(java.util.Date createDate)
```
    Sets the create date of this background task.
    
    Specified by:
    
    setCreateDate in interface com.liferay.portal.kernel.model.AuditedModel
    
    Parameters:
    
    createDate - the create date of this background task
  - getModifiedDate
```
java.util.Date getModifiedDate()
```
    Returns the modified date of this background task.
    
    Specified by:
    
    getModifiedDate in interface com.liferay.portal.kernel.model.AuditedModel
    
    Returns:
    
    the modified date of this background task
  - setModifiedDate
```
void setModifiedDate(java.util.Date modifiedDate)
```
    Sets the modified date of this background task.
    
    Specified by:
    
    setModifiedDate in interface com.liferay.portal.kernel.model.AuditedModel
    
    Parameters:
    
    modifiedDate - the modified date of this background task
  - getName
```
@AutoEscape
java.lang.String getName()
```
    Returns the name of this background task.
    
    Returns:
    
    the name of this background task
  - setName
```
void setName(java.lang.String name)
```
    Sets the name of this background task.
    
    Parameters:
    
    name - the name of this background task
  - getServletContextNames
```
@AutoEscape
java.lang.String getServletContextNames()
```
    Returns the servlet context names of this background task.
    
    Returns:
    
    the servlet context names of this background task
  - setServletContextNames
```
void setServletContextNames(java.lang.String servletContextNames)
```
    Sets the servlet context names of this background task.
    
    Parameters:
    
    servletContextNames - the servlet context names of this background task
  - getTaskExecutorClassName
```
@AutoEscape
java.lang.String getTaskExecutorClassName()
```
    Returns the task executor class name of this background task.
    
    Returns:
    
    the task executor class name of this background task
  - setTaskExecutorClassName
```
void setTaskExecutorClassName(java.lang.String taskExecutorClassName)
```
    Sets the task executor class name of this background task.
    
    Parameters:
    
    taskExecutorClassName - the task executor class name of this background task
  - getTaskContextMap
```
java.util.Map<java.lang.String,java.io.Serializable> getTaskContextMap()
```
    Returns the task context map of this background task.
    
    Returns:
    
    the task context map of this background task
  - setTaskContextMap
```
void setTaskContextMap(java.util.Map<java.lang.String,java.io.Serializable> taskContextMap)
```
    Sets the task context map of this background task.
    
    Parameters:
    
    taskContextMap - the task context map of this background task
  - getCompleted
```
boolean getCompleted()
```
    Returns the completed of this background task.
    
    Returns:
    
    the completed of this background task
  - isCompleted
```
boolean isCompleted()
```
    Returns true if this background task is completed.
    
    Returns:
    
    true if this background task is completed; false otherwise
  - setCompleted
```
void setCompleted(boolean completed)
```
    Sets whether this background task is completed.
    
    Parameters:
    
    completed - the completed of this background task
  - getCompletionDate
```
java.util.Date getCompletionDate()
```
    Returns the completion date of this background task.
    
    Returns:
    
    the completion date of this background task
  - setCompletionDate
```
void setCompletionDate(java.util.Date completionDate)
```
    Sets the completion date of this background task.
    
    Parameters:
    
    completionDate - the completion date of this background task
  - getStatus
```
int getStatus()
```
    Returns the status of this background task.
    
    Returns:
    
    the status of this background task
  - setStatus
```
void setStatus(int status)
```
    Sets the status of this background task.
    
    Parameters:
    
    status - the status of this background task
  - getStatusMessage
```
@AutoEscape
java.lang.String getStatusMessage()
```
    Returns the status message of this background task.
    
    Returns:
    
    the status message of this background task
  - setStatusMessage
```
void setStatusMessage(java.lang.String statusMessage)
```
    Sets the status message of this background task.
    
    Parameters:
    
    statusMessage - the status message of this background task
  - cloneWithOriginalValues
```
BackgroundTask cloneWithOriginalValues()
```
    Specified by:
    
    cloneWithOriginalValues in interface com.liferay.portal.kernel.model.BaseModel<BackgroundTask>

Interface BackgroundTaskModel

Method Summary

Methods inherited from interface com.liferay.portal.kernel.model.BaseModel

Methods inherited from interface java.lang.Comparable

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

Method Detail

getPrimaryKey

setPrimaryKey

getMvccVersion

setMvccVersion

getBackgroundTaskId

setBackgroundTaskId

getGroupId

setGroupId

getCompanyId

setCompanyId

getUserId

setUserId

getUserUuid

setUserUuid

getUserName

setUserName

getCreateDate

setCreateDate

getModifiedDate

setModifiedDate

getName

setName

getServletContextNames

setServletContextNames

getTaskExecutorClassName

setTaskExecutorClassName

getTaskContextMap

setTaskContextMap

getCompleted

isCompleted

setCompleted

getCompletionDate

setCompletionDate

getStatus

setStatus

getStatusMessage

setStatusMessage

cloneWithOriginalValues