com.liferay.portal.background.task.model

Interface BackgroundTask

All Superinterfaces:

AuditedModel, BackgroundTaskModel, BaseModel<BackgroundTask>, ClassedModel, java.lang.Cloneable, java.lang.Comparable<BackgroundTask>, GroupedModel, MVCCModel, PersistedModel, java.io.Serializable, ShardedModel

All Known Implementing Classes:

BackgroundTaskWrapper

@ProviderType
public interface BackgroundTask
extends BackgroundTaskModel, PersistedModel

The extended model interface for the BackgroundTask service. Represents a row in the "BackgroundTask" database table, with each column mapped to a property of this class.

See Also:

BackgroundTaskModel

Field Summary

Fields

Modifier and Type	Field and Description
static Accessor<BackgroundTask,java.lang.Long>	BACKGROUND_TASK_ID_ACCESSOR

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)
Folder	addAttachmentsFolder()
java.util.List<FileEntry>	getAttachmentsFileEntries()
java.util.List<FileEntry>	getAttachmentsFileEntries(int start, int end)
int	getAttachmentsFileEntriesCount()
long	getAttachmentsFolderId()
java.lang.String	getStatusLabel()
boolean	isInProgress()

Methods inherited from interface com.liferay.portal.background.task.model.BackgroundTaskModel

getBackgroundTaskId, getCompanyId, getCompleted, getCompletionDate, getCreateDate, getGroupId, getModifiedDate, getMvccVersion, getName, getPrimaryKey, getServletContextNames, getStatus, getStatusMessage, getTaskContextMap, getTaskExecutorClassName, getUserId, getUserName, getUserUuid, isCompleted, setBackgroundTaskId, setCompanyId, setCompleted, setCompletionDate, setCreateDate, setGroupId, setModifiedDate, setMvccVersion, setName, setPrimaryKey, setServletContextNames, setStatus, setStatusMessage, setTaskContextMap, setTaskExecutorClassName, setUserId, setUserName, setUserUuid

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

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

persist

Field Detail

BACKGROUND_TASK_ID_ACCESSOR

static final Accessor<BackgroundTask,java.lang.Long> BACKGROUND_TASK_ID_ACCESSOR

Method Detail

addAttachment

void addAttachment(long userId,
                   java.lang.String fileName,
                   java.io.File file)
            throws PortalException

Throws:

PortalException

addAttachment

void addAttachment(long userId,
                   java.lang.String fileName,
                   java.io.InputStream inputStream)
            throws PortalException

Throws:

PortalException

addAttachmentsFolder

Folder addAttachmentsFolder()
                     throws PortalException

Throws:

PortalException

getAttachmentsFileEntries

java.util.List<FileEntry> getAttachmentsFileEntries()
                                             throws PortalException

Throws:

PortalException

getAttachmentsFileEntries

java.util.List<FileEntry> getAttachmentsFileEntries(int start,
                                                    int end)
                                             throws PortalException

Throws:

PortalException

getAttachmentsFileEntriesCount

int getAttachmentsFileEntriesCount()
                            throws PortalException

Throws:

PortalException

getAttachmentsFolderId

long getAttachmentsFolderId()

getStatusLabel

java.lang.String getStatusLabel()

isInProgress

boolean isInProgress()