com.liferay.portal.background.task.model

Class BackgroundTaskWrapper

java.lang.Object

com.liferay.portal.kernel.model.wrapper.BaseModelWrapper<BackgroundTask>

com.liferay.portal.background.task.model.BackgroundTaskWrapper

All Implemented Interfaces:

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

public class BackgroundTaskWrapper
extends com.liferay.portal.kernel.model.wrapper.BaseModelWrapper<BackgroundTask>
implements BackgroundTask, com.liferay.portal.kernel.model.ModelWrapper<BackgroundTask>

This class is a wrapper for BackgroundTask.

See Also:

BackgroundTask, Serialized Form

Generated:

Field Summary

Fields inherited from class com.liferay.portal.kernel.model.wrapper.BaseModelWrapper

model

Fields inherited from interface com.liferay.portal.background.task.model.BackgroundTask

BACKGROUND_TASK_ID_ACCESSOR

Constructor Summary

Constructors

Constructor and Description
BackgroundTaskWrapper(BackgroundTask backgroundTask)

Method Summary

Modifier and Type	Method and Description
void	addAttachment(long userId, java.lang.String fileName, java.io.File file)
void	addAttachment(long userId, java.lang.String fileName, java.io.InputStream inputStream)
com.liferay.portal.kernel.repository.model.Folder	addAttachmentsFolder()
java.util.List<com.liferay.portal.kernel.repository.model.FileEntry>	getAttachmentsFileEntries()
java.util.List<com.liferay.portal.kernel.repository.model.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.
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.Map<java.lang.String,java.lang.Object>	getModelAttributes()
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	getStatusLabel()
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.
boolean	isInProgress()
void	persist() NOTE FOR DEVELOPERS: Never modify or reference this class directly.
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	setModelAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)
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.
protected BackgroundTaskWrapper	wrap(BackgroundTask backgroundTask)

Methods inherited from class com.liferay.portal.kernel.model.wrapper.BaseModelWrapper

clone, compareTo, equals, getExpandoBridge, getModelClass, getModelClassName, getPrimaryKeyObj, getWrappedModel, hashCode, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toString, toUnescapedModel, toXmlString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

clone, getExpandoBridge, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, 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

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

getWrappedModel

Constructor Detail

BackgroundTaskWrapper

public BackgroundTaskWrapper(BackgroundTask backgroundTask)

Method Detail

getModelAttributes

public java.util.Map<java.lang.String,java.lang.Object> getModelAttributes()

Specified by:

getModelAttributes in interface com.liferay.portal.kernel.model.BaseModel<BackgroundTask>

setModelAttributes

public void setModelAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)

Specified by:

setModelAttributes in interface com.liferay.portal.kernel.model.BaseModel<BackgroundTask>

addAttachment

public void addAttachment(long userId,
                          java.lang.String fileName,
                          java.io.File file)
                   throws com.liferay.portal.kernel.exception.PortalException

Specified by:

addAttachment in interface BackgroundTask

Throws:

com.liferay.portal.kernel.exception.PortalException

addAttachment

public void addAttachment(long userId,
                          java.lang.String fileName,
                          java.io.InputStream inputStream)
                   throws com.liferay.portal.kernel.exception.PortalException

Specified by:

addAttachment in interface BackgroundTask

Throws:

com.liferay.portal.kernel.exception.PortalException

addAttachmentsFolder

public com.liferay.portal.kernel.repository.model.Folder addAttachmentsFolder()
                                                                       throws com.liferay.portal.kernel.exception.PortalException

Specified by:

addAttachmentsFolder in interface BackgroundTask

Throws:

com.liferay.portal.kernel.exception.PortalException

getAttachmentsFileEntries

public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getAttachmentsFileEntries()
                                                                                               throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getAttachmentsFileEntries in interface BackgroundTask

Throws:

com.liferay.portal.kernel.exception.PortalException

getAttachmentsFileEntries

public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getAttachmentsFileEntries(int start,
                                                                                                      int end)
                                                                                               throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getAttachmentsFileEntries in interface BackgroundTask

Throws:

com.liferay.portal.kernel.exception.PortalException

getAttachmentsFileEntriesCount

public int getAttachmentsFileEntriesCount()
                                   throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getAttachmentsFileEntriesCount in interface BackgroundTask

Throws:

com.liferay.portal.kernel.exception.PortalException

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 BackgroundTaskModel

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

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 java.util.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 java.util.Date getCreateDate()

Returns the create date of this background task.

Specified by:

getCreateDate in interface BackgroundTaskModel

Specified by:

getCreateDate in interface com.liferay.portal.kernel.model.AuditedModel

Returns:

the create date of this background task

getGroupId

public long getGroupId()

Returns the group ID of this background task.

Specified by:

getGroupId in interface BackgroundTaskModel

Specified by:

getGroupId in interface com.liferay.portal.kernel.model.GroupedModel

Returns:

the group ID of this background task

getModifiedDate

public java.util.Date getModifiedDate()

Returns the modified date of this background task.

Specified by:

getModifiedDate in interface BackgroundTaskModel

Specified by:

getModifiedDate in interface com.liferay.portal.kernel.model.AuditedModel

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 com.liferay.portal.kernel.model.MVCCModel

Returns:

the mvcc version of this background task

getName

public java.lang.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

getServletContextNames

public java.lang.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 java.lang.String getStatusLabel()

Specified by:

getStatusLabel in interface BackgroundTask

getStatusMessage

public java.lang.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 java.util.Map<java.lang.String,java.io.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 java.lang.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 BackgroundTaskModel

Specified by:

getUserId in interface com.liferay.portal.kernel.model.AuditedModel

Returns:

the user ID of this background task

getUserName

public java.lang.String getUserName()

Returns the user name of this background task.

Specified by:

getUserName in interface BackgroundTaskModel

Specified by:

getUserName in interface com.liferay.portal.kernel.model.AuditedModel

Returns:

the user name of this background task

getUserUuid

public java.lang.String getUserUuid()

Returns the user uuid of this background task.

Specified by:

getUserUuid in interface BackgroundTaskModel

Specified by:

getUserUuid in interface com.liferay.portal.kernel.model.AuditedModel

Returns:

the user uuid of this background task

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

isInProgress

public boolean isInProgress()

Specified by:

isInProgress in interface BackgroundTask

persist

public void persist()

NOTE FOR DEVELOPERS: Never modify or reference this class directly. All methods that expect a background task model instance should use the BackgroundTask interface instead.

Specified by:

persist in interface com.liferay.portal.kernel.model.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

setCompanyId

public void setCompanyId(long companyId)

Sets the company ID of this background task.

Specified by:

setCompanyId in interface BackgroundTaskModel

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

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(java.util.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(java.util.Date createDate)

Sets the create date of this background task.

Specified by:

setCreateDate in interface BackgroundTaskModel

Specified by:

setCreateDate in interface com.liferay.portal.kernel.model.AuditedModel

Parameters:

createDate - the create date of this background task

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 com.liferay.portal.kernel.model.GroupedModel

Parameters:

groupId - the group ID of this background task

setModifiedDate

public void setModifiedDate(java.util.Date modifiedDate)

Sets the modified date of this background task.

Specified by:

setModifiedDate in interface BackgroundTaskModel

Specified by:

setModifiedDate in interface com.liferay.portal.kernel.model.AuditedModel

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 com.liferay.portal.kernel.model.MVCCModel

Parameters:

mvccVersion - the mvcc version of this background task

setName

public void setName(java.lang.String name)

Sets the name of this background task.

Specified by:

setName in interface BackgroundTaskModel

Parameters:

name - the name of this background task

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

setServletContextNames

public void setServletContextNames(java.lang.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(java.lang.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(java.util.Map<java.lang.String,java.io.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(java.lang.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 BackgroundTaskModel

Specified by:

setUserId in interface com.liferay.portal.kernel.model.AuditedModel

Parameters:

userId - the user ID of this background task

setUserName

public void setUserName(java.lang.String userName)

Sets the user name of this background task.

Specified by:

setUserName in interface BackgroundTaskModel

Specified by:

setUserName in interface com.liferay.portal.kernel.model.AuditedModel

Parameters:

userName - the user name of this background task

setUserUuid

public void setUserUuid(java.lang.String userUuid)

Sets the user uuid of this background task.

Specified by:

setUserUuid in interface BackgroundTaskModel

Specified by:

setUserUuid in interface com.liferay.portal.kernel.model.AuditedModel

Parameters:

userUuid - the user uuid of this background task

wrap

protected BackgroundTaskWrapper wrap(BackgroundTask backgroundTask)

Specified by:

wrap in class com.liferay.portal.kernel.model.wrapper.BaseModelWrapper<BackgroundTask>