Liferay 6.2.0

com.liferay.portal.model
Interface BackgroundTaskModel

All Superinterfaces:
AuditedModel, BaseModel<BackgroundTask>, ClassedModel, Cloneable, Comparable<BackgroundTask>, GroupedModel, Serializable
All Known Subinterfaces:
BackgroundTask
All Known Implementing Classes:
BackgroundTaskBaseImpl, BackgroundTaskImpl, BackgroundTaskModelImpl, BackgroundTaskWrapper

@ProviderType
public interface BackgroundTaskModel
extends BaseModel<BackgroundTask>, GroupedModel

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 BackgroundTaskModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in BackgroundTaskImpl.

See Also:
BackgroundTask, BackgroundTaskImpl, BackgroundTaskModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
abstract  Object clone()
          Creates a shallow clone of this model instance.
abstract  int compareTo(BackgroundTask backgroundTask)
           
abstract  long getBackgroundTaskId()
          Returns the background task ID of this background task.
abstract  long getCompanyId()
          Returns the company ID of this background task.
abstract  boolean getCompleted()
          Returns the completed of this background task.
abstract  Date getCompletionDate()
          Returns the completion date of this background task.
abstract  Date getCreateDate()
          Returns the create date of this background task.
abstract  ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
abstract  long getGroupId()
          Returns the group ID of this background task.
abstract  Date getModifiedDate()
          Returns the modified date of this background task.
abstract  String getName()
          Returns the name of this background task.
abstract  long getPrimaryKey()
          Returns the primary key of this background task.
abstract  Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
abstract  String getServletContextNames()
          Returns the servlet context names of this background task.
abstract  int getStatus()
          Returns the status of this background task.
abstract  String getStatusMessage()
          Returns the status message of this background task.
abstract  String getTaskContext()
          Returns the task context of this background task.
abstract  String getTaskExecutorClassName()
          Returns the task executor class name of this background task.
abstract  long getUserId()
          Returns the user ID of this background task.
abstract  String getUserName()
          Returns the user name of this background task.
abstract  String getUserUuid()
          Returns the user uuid of this background task.
abstract  int hashCode()
           
abstract  boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
abstract  boolean isCompleted()
          Returns true if this background task is completed.
abstract  boolean isEscapedModel()
          Returns true if this model instance is escaped.
abstract  boolean isNew()
          Returns true if this model instance does not yet exist in the database.
abstract  void setBackgroundTaskId(long backgroundTaskId)
          Sets the background task ID of this background task.
abstract  void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
abstract  void setCompanyId(long companyId)
          Sets the company ID of this background task.
abstract  void setCompleted(boolean completed)
          Sets whether this background task is completed.
abstract  void setCompletionDate(Date completionDate)
          Sets the completion date of this background task.
abstract  void setCreateDate(Date createDate)
          Sets the create date of this background task.
abstract  void setExpandoBridgeAttributes(BaseModel<?> baseModel)
           
abstract  void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
           
abstract  void setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
abstract  void setGroupId(long groupId)
          Sets the group ID of this background task.
abstract  void setModifiedDate(Date modifiedDate)
          Sets the modified date of this background task.
abstract  void setName(String name)
          Sets the name of this background task.
abstract  void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
abstract  void setPrimaryKey(long primaryKey)
          Sets the primary key of this background task.
abstract  void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
abstract  void setServletContextNames(String servletContextNames)
          Sets the servlet context names of this background task.
abstract  void setStatus(int status)
          Sets the status of this background task.
abstract  void setStatusMessage(String statusMessage)
          Sets the status message of this background task.
abstract  void setTaskContext(String taskContext)
          Sets the task context of this background task.
abstract  void setTaskExecutorClassName(String taskExecutorClassName)
          Sets the task executor class name of this background task.
abstract  void setUserId(long userId)
          Sets the user ID of this background task.
abstract  void setUserName(String userName)
          Sets the user name of this background task.
abstract  void setUserUuid(String userUuid)
          Sets the user uuid of this background task.
abstract  CacheModel<BackgroundTask> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
abstract  BackgroundTask toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
abstract  String toString()
           
abstract  BackgroundTask toUnescapedModel()
           
abstract  String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from interface com.liferay.portal.model.BaseModel
getModelAttributes, resetOriginalValues, setModelAttributes
 
Methods inherited from interface com.liferay.portal.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

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 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 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 AuditedModel
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 AuditedModel
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 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 AuditedModel
Parameters:
userId - the user ID of this background task

getUserUuid

String getUserUuid()
                   throws SystemException
Returns the user uuid of this background task.

Specified by:
getUserUuid in interface AuditedModel
Returns:
the user uuid of this background task
Throws:
SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)
Sets the user uuid of this background task.

Specified by:
setUserUuid in interface AuditedModel
Parameters:
userUuid - the user uuid of this background task

getUserName

@AutoEscape
String getUserName()
Returns the user name of this background task.

Specified by:
getUserName in interface AuditedModel
Returns:
the user name of this background task

setUserName

void setUserName(String userName)
Sets the user name of this background task.

Specified by:
setUserName in interface AuditedModel
Parameters:
userName - the user name of this background task

getCreateDate

Date getCreateDate()
Returns the create date of this background task.

Specified by:
getCreateDate in interface AuditedModel
Returns:
the create date of this background task

setCreateDate

void setCreateDate(Date createDate)
Sets the create date of this background task.

Specified by:
setCreateDate in interface AuditedModel
Parameters:
createDate - the create date of this background task

getModifiedDate

Date getModifiedDate()
Returns the modified date of this background task.

Specified by:
getModifiedDate in interface AuditedModel
Returns:
the modified date of this background task

setModifiedDate

void setModifiedDate(Date modifiedDate)
Sets the modified date of this background task.

Specified by:
setModifiedDate in interface AuditedModel
Parameters:
modifiedDate - the modified date of this background task

getName

@AutoEscape
String getName()
Returns the name of this background task.

Returns:
the name of this background task

setName

void setName(String name)
Sets the name of this background task.

Parameters:
name - the name of this background task

getServletContextNames

@AutoEscape
String getServletContextNames()
Returns the servlet context names of this background task.

Returns:
the servlet context names of this background task

setServletContextNames

void setServletContextNames(String servletContextNames)
Sets the servlet context names of this background task.

Parameters:
servletContextNames - the servlet context names of this background task

getTaskExecutorClassName

@AutoEscape
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(String taskExecutorClassName)
Sets the task executor class name of this background task.

Parameters:
taskExecutorClassName - the task executor class name of this background task

getTaskContext

@AutoEscape
String getTaskContext()
Returns the task context of this background task.

Returns:
the task context of this background task

setTaskContext

void setTaskContext(String taskContext)
Sets the task context of this background task.

Parameters:
taskContext - the task context 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

Date getCompletionDate()
Returns the completion date of this background task.

Returns:
the completion date of this background task

setCompletionDate

void setCompletionDate(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
String getStatusMessage()
Returns the status message of this background task.

Returns:
the status message of this background task

setStatusMessage

void setStatusMessage(String statusMessage)
Sets the status message of this background task.

Parameters:
statusMessage - the status message of this background task

isNew

boolean isNew()
Description copied from interface: BaseModel
Returns true if this model instance does not yet exist in the database.

Specified by:
isNew in interface BaseModel<BackgroundTask>
Returns:
true if this model instance does not yet exist in the database; false otherwise

setNew

void setNew(boolean n)
Description copied from interface: BaseModel
Sets whether this model instance does not yet exist in the database.

Specified by:
setNew in interface BaseModel<BackgroundTask>
Parameters:
n - whether this model instance does not yet exist in the database

isCachedModel

boolean isCachedModel()
Description copied from interface: BaseModel
Returns true if this model instance was retrieved from the entity cache.

Specified by:
isCachedModel in interface BaseModel<BackgroundTask>
Returns:
true if this model instance was retrieved from the entity cache; false otherwise
See Also:
BaseModel.setCachedModel(boolean)

setCachedModel

void setCachedModel(boolean cachedModel)
Description copied from interface: BaseModel
Sets whether this model instance was retrieved from the entity cache.

Specified by:
setCachedModel in interface BaseModel<BackgroundTask>
Parameters:
cachedModel - whether this model instance was retrieved from the entity cache
See Also:
EntityCache

isEscapedModel

boolean isEscapedModel()
Description copied from interface: BaseModel
Returns true if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<BackgroundTask>
Returns:
true if this model instance is escaped; false otherwise

getPrimaryKeyObj

Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Returns the primary key of this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<BackgroundTask>
Specified by:
getPrimaryKeyObj in interface ClassedModel
Returns:
the primary key of this model instance

setPrimaryKeyObj

void setPrimaryKeyObj(Serializable primaryKeyObj)
Description copied from interface: BaseModel
Sets the primary key of this model instance.

Specified by:
setPrimaryKeyObj in interface BaseModel<BackgroundTask>
Specified by:
setPrimaryKeyObj in interface ClassedModel
Parameters:
primaryKeyObj - the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()
Description copied from interface: BaseModel
Returns the expando bridge for this model instance.

Specified by:
getExpandoBridge in interface BaseModel<BackgroundTask>
Specified by:
getExpandoBridge in interface ClassedModel
Returns:
the expando bridge for this model instance

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(BaseModel<?> baseModel)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<BackgroundTask>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<BackgroundTask>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ServiceContext serviceContext)
Description copied from interface: BaseModel
Sets the expando bridge attributes for this model instance to the attributes stored in the service context.

Specified by:
setExpandoBridgeAttributes in interface BaseModel<BackgroundTask>
Parameters:
serviceContext - the service context to be applied
See Also:
ServiceContext.getExpandoBridgeAttributes( )

clone

Object clone()
Description copied from interface: BaseModel
Creates a shallow clone of this model instance.

Specified by:
clone in interface BaseModel<BackgroundTask>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(BackgroundTask backgroundTask)
Specified by:
compareTo in interface Comparable<BackgroundTask>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

CacheModel<BackgroundTask> toCacheModel()
Description copied from interface: BaseModel
Returns a cache model object for this entity used by entity cache.

Specified by:
toCacheModel in interface BaseModel<BackgroundTask>
Returns:
the cache model object

toEscapedModel

BackgroundTask toEscapedModel()
Description copied from interface: BaseModel
Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:
toEscapedModel in interface BaseModel<BackgroundTask>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

BackgroundTask toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<BackgroundTask>

toString

String toString()
Overrides:
toString in class Object

toXmlString

String toXmlString()
Description copied from interface: BaseModel
Returns the XML representation of this model instance.

Specified by:
toXmlString in interface BaseModel<BackgroundTask>
Returns:
the XML representation of this model instance

Liferay 6.2.0