com.liferay.portal.kernel.backgroundtask

Interface BackgroundTask

public interface BackgroundTask

Author:

Michael C. Han

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()
int	getAttachmentsFileEntriesCount()
long	getAttachmentsFolderId()
long	getBackgroundTaskId()
long	getCompanyId()
java.util.Date	getCompletionDate()
java.util.Date	getCreateDate()
long	getGroupId()
BaseModel<?>	getModel()
java.lang.String	getName()
java.lang.String	getServletContextNames()
int	getStatus()
java.lang.String	getStatusLabel()
java.lang.String	getStatusMessage()
java.util.Map<java.lang.String,java.io.Serializable>	getTaskContextMap()
java.lang.String	getTaskExecutorClassName()
long	getUserId()
boolean	isCompleted()
boolean	isInProgress()
void	setTaskContextMap(java.util.Map<java.lang.String,java.io.Serializable> taskContextMap)

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

getAttachmentsFileEntriesCount

int getAttachmentsFileEntriesCount()
                            throws PortalException

Throws:

PortalException

getAttachmentsFolderId

long getAttachmentsFolderId()

getBackgroundTaskId

long getBackgroundTaskId()

getCompanyId

long getCompanyId()

getCompletionDate

java.util.Date getCompletionDate()

getCreateDate

java.util.Date getCreateDate()

getGroupId

long getGroupId()

getModel

BaseModel<?> getModel()

getName

java.lang.String getName()

getServletContextNames

java.lang.String getServletContextNames()

getStatus

int getStatus()

getStatusLabel

java.lang.String getStatusLabel()

getStatusMessage

java.lang.String getStatusMessage()

getTaskContextMap

java.util.Map<java.lang.String,java.io.Serializable> getTaskContextMap()

getTaskExecutorClassName

java.lang.String getTaskExecutorClassName()

getUserId

long getUserId()

isCompleted

boolean isCompleted()

isInProgress

boolean isInProgress()

setTaskContextMap

void setTaskContextMap(java.util.Map<java.lang.String,java.io.Serializable> taskContextMap)