Interface BackgroundTaskModel

All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel, com.liferay.portal.kernel.model.BaseModel<BackgroundTask>, com.liferay.portal.kernel.model.ClassedModel, Cloneable, Comparable<BackgroundTask>, com.liferay.portal.kernel.model.GroupedModel, com.liferay.portal.kernel.model.MVCCModel, Serializable, com.liferay.portal.kernel.model.ShardedModel
All Known Subinterfaces:
BackgroundTask
All Known Implementing Classes:
BackgroundTaskWrapper

@ProviderType public interface BackgroundTaskModel extends com.liferay.portal.kernel.model.BaseModel<BackgroundTask>, com.liferay.portal.kernel.model.GroupedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel
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 com.liferay.portal.background.task.model.impl.BackgroundTaskModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in com.liferay.portal.background.task.model.impl.BackgroundTaskImpl.

See Also:
Generated:
  • Method Summary

    Modifier and Type
    Method
    Description
     
    long
    Returns the background task ID of this background task.
    long
    Returns the company ID of this background task.
    boolean
    Returns the completed of this background task.
    Returns the completion date of this background task.
    Returns the create date of this background task.
    long
    Returns the group ID of this background task.
    Returns the modified date of this background task.
    long
    Returns the mvcc version of this background task.
    Returns the name of this background task.
    long
    Returns the primary key of this background task.
    Returns the servlet context names of this background task.
    int
    Returns the status of this background task.
    Returns the status message of this background task.
    Returns the task context map of this background task.
    Returns the task executor class name of this background task.
    long
    Returns the user ID of this background task.
    Returns the user name of this background task.
    Returns the user uuid of this background task.
    boolean
    Returns true if this background task is completed.
    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(Date completionDate)
    Sets the completion date of this background task.
    void
    setCreateDate(Date createDate)
    Sets the create date of this background task.
    void
    setGroupId(long groupId)
    Sets the group ID of this background task.
    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
    Sets the name of this background task.
    void
    setPrimaryKey(long primaryKey)
    Sets the primary key of this background task.
    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
    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.
    default String
     

    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

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

    getModelClass, getModelClassName

    Methods inherited from interface java.lang.Comparable

    compareTo
  • Method Details

    • 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
    • getMvccVersion

      long getMvccVersion()
      Returns the mvcc version of this background task.
      Specified by:
      getMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel
      Returns:
      the mvcc version of this background task
    • setMvccVersion

      void setMvccVersion(long mvccVersion)
      Sets the mvcc version of this background task.
      Specified by:
      setMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel
      Parameters:
      mvccVersion - the mvcc version 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 com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.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 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
    • setCompanyId

      void setCompanyId(long companyId)
      Sets the company ID of this background task.
      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
    • getUserId

      long getUserId()
      Returns the user ID of this background task.
      Specified by:
      getUserId in interface com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.AuditedModel
      Parameters:
      userId - the user ID of this background task
    • getUserUuid

      String getUserUuid()
      Returns the user uuid of this background task.
      Specified by:
      getUserUuid in interface com.liferay.portal.kernel.model.AuditedModel
      Returns:
      the user uuid of this background task
    • setUserUuid

      void setUserUuid(String userUuid)
      Sets the user uuid of this background task.
      Specified by:
      setUserUuid in interface com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.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
    • getTaskContextMap

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

      void setTaskContextMap(Map<String,Serializable> taskContextMap)
      Sets the task context map of this background task.
      Parameters:
      taskContextMap - the task context map 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
    • cloneWithOriginalValues

      BackgroundTask cloneWithOriginalValues()
      Specified by:
      cloneWithOriginalValues in interface com.liferay.portal.kernel.model.BaseModel<BackgroundTask>
    • toXmlString

      default String toXmlString()