Liferay 7.0-ce-m3

com.liferay.portal.model
Class BackgroundTaskWrapper

java.lang.Object
  extended by com.liferay.portal.model.BackgroundTaskWrapper
All Implemented Interfaces:
AuditedModel, BackgroundTask, BackgroundTaskModel, BaseModel<BackgroundTask>, ClassedModel, GroupedModel, ModelWrapper<BackgroundTask>, MVCCModel, PersistedModel, Serializable, Cloneable, Comparable<BackgroundTask>

@ProviderType
public class BackgroundTaskWrapper
extends Object
implements BackgroundTask, ModelWrapper<BackgroundTask>

This class is a wrapper for BackgroundTask.

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

Constructor Summary
BackgroundTaskWrapper(BackgroundTask backgroundTask)
           
 
Method Summary
 Folder addAttachmentsFolder()
           
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(BackgroundTask backgroundTask)
           
 boolean equals(Object obj)
           
 List<FileEntry> getAttachmentsFileEntries()
           
 List<FileEntry> getAttachmentsFileEntries(int start, int end)
           
 int getAttachmentsFileEntriesCount()
           
 long getAttachmentsFolderId()
           
 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.
 Date getCompletionDate()
          Returns the completion date of this background task.
 Date getCreateDate()
          Returns the create date of this background task.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 long getGroupId()
          Returns the group ID of this background task.
 Map<String,Object> getModelAttributes()
           
 Class<?> getModelClass()
           
 String getModelClassName()
           
 Date getModifiedDate()
          Returns the modified date of this background task.
 long getMvccVersion()
          Returns the mvcc version of this background task.
 String getName()
          Returns the name of this background task.
 long getPrimaryKey()
          Returns the primary key of this background task.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 String getServletContextNames()
          Returns the servlet context names of this background task.
 int getStatus()
          Returns the status of this background task.
 String getStatusLabel()
           
 String getStatusMessage()
          Returns the status message of this background task.
 Map<String,Serializable> getTaskContextMap()
          Returns the task context map of this background task.
 String getTaskExecutorClassName()
          Returns the task executor class name of this background task.
 long getUserId()
          Returns the user ID of this background task.
 String getUserName()
          Returns the user name of this background task.
 String getUserUuid()
          Returns the user uuid of this background task.
 BackgroundTask getWrappedBackgroundTask()
          Deprecated. As of 6.1.0, replaced by getWrappedModel()
 BackgroundTask getWrappedModel()
           
 int hashCode()
           
 boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
 boolean isCompleted()
          Returns true if this background task is completed.
 boolean isEntityCacheEnabled()
          Returns true if this model's entity cache is enabled.
 boolean isEscapedModel()
          Returns true if this model instance is escaped.
 boolean isFinderCacheEnabled()
          Returns true if this model's finder cache is enabled.
 boolean isInProgress()
           
 boolean isNew()
          Returns true if this model instance does not yet exist in the database.
 void persist()
          Updates this model instance in the database or adds it if it does not yet exist.
 void resetOriginalValues()
          Reset all original fields to current values.
 void setBackgroundTaskId(long backgroundTaskId)
          Sets the background task ID of this background task.
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 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(Date completionDate)
          Sets the completion date of this background task.
 void setCreateDate(Date createDate)
          Sets the create date of this background task.
 void setExpandoBridgeAttributes(BaseModel<?> baseModel)
           
 void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
           
 void setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
 void setGroupId(long groupId)
          Sets the group ID of this background task.
 void setModelAttributes(Map<String,Object> attributes)
           
 void setModifiedDate(Date modifiedDate)
          Sets the modified date of this background task.
 void setMvccVersion(long mvccVersion)
          Sets the mvcc version of this background task.
 void setName(String name)
          Sets the name of this background task.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setPrimaryKey(long primaryKey)
          Sets the primary key of this background task.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setServletContextNames(String servletContextNames)
          Sets the servlet context names of this background task.
 void setStatus(int status)
          Sets the status of this background task.
 void setStatusMessage(String statusMessage)
          Sets the status message of this background task.
 void setTaskContextMap(Map<String,Serializable> taskContextMap)
          Sets the task context map of this background task.
 void setTaskExecutorClassName(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(String userName)
          Sets the user name of this background task.
 void setUserUuid(String userUuid)
          Sets the user uuid of this background task.
 CacheModel<BackgroundTask> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 BackgroundTask toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 BackgroundTask toUnescapedModel()
           
 String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BackgroundTaskWrapper

public BackgroundTaskWrapper(BackgroundTask backgroundTask)
Method Detail

getModelClass

public Class<?> getModelClass()
Specified by:
getModelClass in interface ClassedModel

getModelClassName

public String getModelClassName()
Specified by:
getModelClassName in interface ClassedModel

getModelAttributes

public Map<String,Object> getModelAttributes()
Specified by:
getModelAttributes in interface BaseModel<BackgroundTask>

setModelAttributes

public void setModelAttributes(Map<String,Object> attributes)
Specified by:
setModelAttributes in interface BaseModel<BackgroundTask>

addAttachmentsFolder

public Folder addAttachmentsFolder()
                            throws PortalException
Specified by:
addAttachmentsFolder in interface BackgroundTask
Throws:
PortalException

clone

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

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

compareTo

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

getAttachmentsFileEntries

public List<FileEntry> getAttachmentsFileEntries()
Specified by:
getAttachmentsFileEntries in interface BackgroundTask

getAttachmentsFileEntries

public List<FileEntry> getAttachmentsFileEntries(int start,
                                                 int end)
Specified by:
getAttachmentsFileEntries in interface BackgroundTask

getAttachmentsFileEntriesCount

public int getAttachmentsFileEntriesCount()
Specified by:
getAttachmentsFileEntriesCount in interface BackgroundTask

getAttachmentsFolderId

public long getAttachmentsFolderId()
Specified by:
getAttachmentsFolderId in interface BackgroundTask

getBackgroundTaskId

public long getBackgroundTaskId()
Returns the background task ID of this background task.

Specified by:
getBackgroundTaskId in interface BackgroundTaskModel
Returns:
the background task ID of this background task

getCompanyId

public long getCompanyId()
Returns the company ID of this background task.

Specified by:
getCompanyId in interface AuditedModel
Specified by:
getCompanyId in interface BackgroundTaskModel
Returns:
the company ID of this background task

getCompleted

public boolean getCompleted()
Returns the completed of this background task.

Specified by:
getCompleted in interface BackgroundTaskModel
Returns:
the completed of this background task

getCompletionDate

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

Specified by:
getCompletionDate in interface BackgroundTaskModel
Returns:
the completion date of this background task

getCreateDate

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

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

getExpandoBridge

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

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

getGroupId

public long getGroupId()
Returns the group ID of this background task.

Specified by:
getGroupId in interface BackgroundTaskModel
Specified by:
getGroupId in interface GroupedModel
Returns:
the group ID of this background task

getModifiedDate

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

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

getMvccVersion

public long getMvccVersion()
Returns the mvcc version of this background task.

Specified by:
getMvccVersion in interface BackgroundTaskModel
Specified by:
getMvccVersion in interface MVCCModel
Returns:
the mvcc version of this background task

getName

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

Specified by:
getName in interface BackgroundTaskModel
Returns:
the name of this background task

getPrimaryKey

public long getPrimaryKey()
Returns the primary key of this background task.

Specified by:
getPrimaryKey in interface BackgroundTaskModel
Returns:
the primary key of this background task

getPrimaryKeyObj

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

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

getServletContextNames

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

Specified by:
getServletContextNames in interface BackgroundTaskModel
Returns:
the servlet context names of this background task

getStatus

public int getStatus()
Returns the status of this background task.

Specified by:
getStatus in interface BackgroundTaskModel
Returns:
the status of this background task

getStatusLabel

public String getStatusLabel()
Specified by:
getStatusLabel in interface BackgroundTask

getStatusMessage

public String getStatusMessage()
Returns the status message of this background task.

Specified by:
getStatusMessage in interface BackgroundTaskModel
Returns:
the status message of this background task

getTaskContextMap

public Map<String,Serializable> getTaskContextMap()
Returns the task context map of this background task.

Specified by:
getTaskContextMap in interface BackgroundTaskModel
Returns:
the task context map of this background task

getTaskExecutorClassName

public String getTaskExecutorClassName()
Returns the task executor class name of this background task.

Specified by:
getTaskExecutorClassName in interface BackgroundTaskModel
Returns:
the task executor class name of this background task

getUserId

public long getUserId()
Returns the user ID of this background task.

Specified by:
getUserId in interface AuditedModel
Specified by:
getUserId in interface BackgroundTaskModel
Returns:
the user ID of this background task

getUserName

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

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

getUserUuid

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

Specified by:
getUserUuid in interface AuditedModel
Specified by:
getUserUuid in interface BackgroundTaskModel
Returns:
the user uuid of this background task

hashCode

public int hashCode()
Specified by:
hashCode in interface BackgroundTaskModel
Overrides:
hashCode in class Object

isCachedModel

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

Specified by:
isCachedModel in interface BackgroundTaskModel
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)

isCompleted

public boolean isCompleted()
Returns true if this background task is completed.

Specified by:
isCompleted in interface BackgroundTaskModel
Returns:
true if this background task is completed; false otherwise

isEscapedModel

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

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

isInProgress

public boolean isInProgress()
Specified by:
isInProgress in interface BackgroundTask

isNew

public 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 BackgroundTaskModel
Specified by:
isNew in interface BaseModel<BackgroundTask>
Returns:
true if this model instance does not yet exist in the database; false otherwise

persist

public void persist()
Description copied from interface: PersistedModel
Updates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Specified by:
persist in interface PersistedModel

setBackgroundTaskId

public void setBackgroundTaskId(long backgroundTaskId)
Sets the background task ID of this background task.

Specified by:
setBackgroundTaskId in interface BackgroundTaskModel
Parameters:
backgroundTaskId - the background task ID of this background task

setCachedModel

public 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 BackgroundTaskModel
Specified by:
setCachedModel in interface BaseModel<BackgroundTask>
Parameters:
cachedModel - whether this model instance was retrieved from the entity cache
See Also:
EntityCache

setCompanyId

public void setCompanyId(long companyId)
Sets the company ID of this background task.

Specified by:
setCompanyId in interface AuditedModel
Specified by:
setCompanyId in interface BackgroundTaskModel
Parameters:
companyId - the company ID of this background task

setCompleted

public void setCompleted(boolean completed)
Sets whether this background task is completed.

Specified by:
setCompleted in interface BackgroundTaskModel
Parameters:
completed - the completed of this background task

setCompletionDate

public void setCompletionDate(Date completionDate)
Sets the completion date of this background task.

Specified by:
setCompletionDate in interface BackgroundTaskModel
Parameters:
completionDate - the completion date of this background task

setCreateDate

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

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

setExpandoBridgeAttributes

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

setExpandoBridgeAttributes

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

setExpandoBridgeAttributes

public 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 BackgroundTaskModel
Specified by:
setExpandoBridgeAttributes in interface BaseModel<BackgroundTask>
Parameters:
serviceContext - the service context to be applied
See Also:
ServiceContext.getExpandoBridgeAttributes( )

setGroupId

public void setGroupId(long groupId)
Sets the group ID of this background task.

Specified by:
setGroupId in interface BackgroundTaskModel
Specified by:
setGroupId in interface GroupedModel
Parameters:
groupId - the group ID of this background task

setModifiedDate

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

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

setMvccVersion

public void setMvccVersion(long mvccVersion)
Sets the mvcc version of this background task.

Specified by:
setMvccVersion in interface BackgroundTaskModel
Specified by:
setMvccVersion in interface MVCCModel
Parameters:
mvccVersion - the mvcc version of this background task

setName

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

Specified by:
setName in interface BackgroundTaskModel
Parameters:
name - the name of this background task

setNew

public 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 BackgroundTaskModel
Specified by:
setNew in interface BaseModel<BackgroundTask>
Parameters:
n - whether this model instance does not yet exist in the database

setPrimaryKey

public void setPrimaryKey(long primaryKey)
Sets the primary key of this background task.

Specified by:
setPrimaryKey in interface BackgroundTaskModel
Parameters:
primaryKey - the primary key of this background task

setPrimaryKeyObj

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

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

setServletContextNames

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

Specified by:
setServletContextNames in interface BackgroundTaskModel
Parameters:
servletContextNames - the servlet context names of this background task

setStatus

public void setStatus(int status)
Sets the status of this background task.

Specified by:
setStatus in interface BackgroundTaskModel
Parameters:
status - the status of this background task

setStatusMessage

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

Specified by:
setStatusMessage in interface BackgroundTaskModel
Parameters:
statusMessage - the status message of this background task

setTaskContextMap

public void setTaskContextMap(Map<String,Serializable> taskContextMap)
Sets the task context map of this background task.

Specified by:
setTaskContextMap in interface BackgroundTaskModel
Parameters:
taskContextMap - the task context map of this background task

setTaskExecutorClassName

public void setTaskExecutorClassName(String taskExecutorClassName)
Sets the task executor class name of this background task.

Specified by:
setTaskExecutorClassName in interface BackgroundTaskModel
Parameters:
taskExecutorClassName - the task executor class name of this background task

setUserId

public void setUserId(long userId)
Sets the user ID of this background task.

Specified by:
setUserId in interface AuditedModel
Specified by:
setUserId in interface BackgroundTaskModel
Parameters:
userId - the user ID of this background task

setUserName

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

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

setUserUuid

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

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

toCacheModel

public 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 BackgroundTaskModel
Specified by:
toCacheModel in interface BaseModel<BackgroundTask>
Returns:
the cache model object

toEscapedModel

public 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 BackgroundTaskModel
Specified by:
toEscapedModel in interface BaseModel<BackgroundTask>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toString

public String toString()
Specified by:
toString in interface BackgroundTaskModel
Overrides:
toString in class Object

toUnescapedModel

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

toXmlString

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

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

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

getWrappedBackgroundTask

@Deprecated
public BackgroundTask getWrappedBackgroundTask()
Deprecated. As of 6.1.0, replaced by getWrappedModel()


getWrappedModel

public BackgroundTask getWrappedModel()
Specified by:
getWrappedModel in interface ModelWrapper<BackgroundTask>

isEntityCacheEnabled

public boolean isEntityCacheEnabled()
Description copied from interface: BaseModel
Returns true if this model's entity cache is enabled.

Specified by:
isEntityCacheEnabled in interface BaseModel<BackgroundTask>
Returns:
true if this model's entity cache is enabled; false otherwise

isFinderCacheEnabled

public boolean isFinderCacheEnabled()
Description copied from interface: BaseModel
Returns true if this model's finder cache is enabled.

Specified by:
isFinderCacheEnabled in interface BaseModel<BackgroundTask>
Returns:
true if this model's finder cache is enabled; false otherwise

resetOriginalValues

public void resetOriginalValues()
Description copied from interface: BaseModel
Reset all original fields to current values.

Specified by:
resetOriginalValues in interface BaseModel<BackgroundTask>

Liferay 7.0-ce-m3