Interface DLFolderModel

All Superinterfaces:
AuditedModel, BaseModel<DLFolder>, ClassedModel, Cloneable, Comparable<DLFolder>, ContainerModel, CTModel<DLFolder>, ExternalReferenceCodeModel, GroupedModel, MVCCModel, Serializable, ShardedModel, StagedGroupedModel, StagedModel, TrashedModel, WorkflowedModel
All Known Subinterfaces:
DLFolder
All Known Implementing Classes:
DLFolderWrapper

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

This interface and its corresponding implementation com.liferay.portlet.documentlibrary.model.impl.DLFolderModelImpl 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.portlet.documentlibrary.model.impl.DLFolderImpl.

Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Method Details

    • getPrimaryKey

      long getPrimaryKey()
      Returns the primary key of this document library folder.
      Specified by:
      getPrimaryKey in interface CTModel<DLFolder>
      Returns:
      the primary key of this document library folder
    • setPrimaryKey

      void setPrimaryKey(long primaryKey)
      Sets the primary key of this document library folder.
      Specified by:
      setPrimaryKey in interface CTModel<DLFolder>
      Parameters:
      primaryKey - the primary key of this document library folder
    • getMvccVersion

      long getMvccVersion()
      Returns the mvcc version of this document library folder.
      Specified by:
      getMvccVersion in interface MVCCModel
      Returns:
      the mvcc version of this document library folder
    • setMvccVersion

      void setMvccVersion(long mvccVersion)
      Sets the mvcc version of this document library folder.
      Specified by:
      setMvccVersion in interface MVCCModel
      Parameters:
      mvccVersion - the mvcc version of this document library folder
    • getCtCollectionId

      long getCtCollectionId()
      Returns the ct collection ID of this document library folder.
      Specified by:
      getCtCollectionId in interface CTModel<DLFolder>
      Returns:
      the ct collection ID of this document library folder
    • setCtCollectionId

      void setCtCollectionId(long ctCollectionId)
      Sets the ct collection ID of this document library folder.
      Specified by:
      setCtCollectionId in interface CTModel<DLFolder>
      Parameters:
      ctCollectionId - the ct collection ID of this document library folder
    • getUuid

      @AutoEscape String getUuid()
      Returns the uuid of this document library folder.
      Specified by:
      getUuid in interface StagedModel
      Returns:
      the uuid of this document library folder
    • setUuid

      void setUuid(String uuid)
      Sets the uuid of this document library folder.
      Specified by:
      setUuid in interface StagedModel
      Parameters:
      uuid - the uuid of this document library folder
    • getExternalReferenceCode

      @AutoEscape String getExternalReferenceCode()
      Returns the external reference code of this document library folder.
      Specified by:
      getExternalReferenceCode in interface ExternalReferenceCodeModel
      Returns:
      the external reference code of this document library folder
    • setExternalReferenceCode

      void setExternalReferenceCode(String externalReferenceCode)
      Sets the external reference code of this document library folder.
      Specified by:
      setExternalReferenceCode in interface ExternalReferenceCodeModel
      Parameters:
      externalReferenceCode - the external reference code of this document library folder
    • getFolderId

      long getFolderId()
      Returns the folder ID of this document library folder.
      Returns:
      the folder ID of this document library folder
    • setFolderId

      void setFolderId(long folderId)
      Sets the folder ID of this document library folder.
      Parameters:
      folderId - the folder ID of this document library folder
    • getGroupId

      long getGroupId()
      Returns the group ID of this document library folder.
      Specified by:
      getGroupId in interface GroupedModel
      Returns:
      the group ID of this document library folder
    • setGroupId

      void setGroupId(long groupId)
      Sets the group ID of this document library folder.
      Specified by:
      setGroupId in interface GroupedModel
      Parameters:
      groupId - the group ID of this document library folder
    • getCompanyId

      long getCompanyId()
      Returns the company ID of this document library folder.
      Specified by:
      getCompanyId in interface AuditedModel
      Specified by:
      getCompanyId in interface ShardedModel
      Specified by:
      getCompanyId in interface StagedModel
      Returns:
      the company ID of this document library folder
    • setCompanyId

      void setCompanyId(long companyId)
      Sets the company ID of this document library folder.
      Specified by:
      setCompanyId in interface AuditedModel
      Specified by:
      setCompanyId in interface ShardedModel
      Specified by:
      setCompanyId in interface StagedModel
      Parameters:
      companyId - the company ID of this document library folder
    • getUserId

      long getUserId()
      Returns the user ID of this document library folder.
      Specified by:
      getUserId in interface AuditedModel
      Returns:
      the user ID of this document library folder
    • setUserId

      void setUserId(long userId)
      Sets the user ID of this document library folder.
      Specified by:
      setUserId in interface AuditedModel
      Parameters:
      userId - the user ID of this document library folder
    • getUserUuid

      String getUserUuid()
      Returns the user uuid of this document library folder.
      Specified by:
      getUserUuid in interface AuditedModel
      Returns:
      the user uuid of this document library folder
    • setUserUuid

      void setUserUuid(String userUuid)
      Sets the user uuid of this document library folder.
      Specified by:
      setUserUuid in interface AuditedModel
      Parameters:
      userUuid - the user uuid of this document library folder
    • getUserName

      @AutoEscape String getUserName()
      Returns the user name of this document library folder.
      Specified by:
      getUserName in interface AuditedModel
      Returns:
      the user name of this document library folder
    • setUserName

      void setUserName(String userName)
      Sets the user name of this document library folder.
      Specified by:
      setUserName in interface AuditedModel
      Parameters:
      userName - the user name of this document library folder
    • getCreateDate

      Date getCreateDate()
      Returns the create date of this document library folder.
      Specified by:
      getCreateDate in interface AuditedModel
      Specified by:
      getCreateDate in interface StagedModel
      Returns:
      the create date of this document library folder
    • setCreateDate

      void setCreateDate(Date createDate)
      Sets the create date of this document library folder.
      Specified by:
      setCreateDate in interface AuditedModel
      Specified by:
      setCreateDate in interface StagedModel
      Parameters:
      createDate - the create date of this document library folder
    • getModifiedDate

      Date getModifiedDate()
      Returns the modified date of this document library folder.
      Specified by:
      getModifiedDate in interface AuditedModel
      Specified by:
      getModifiedDate in interface StagedModel
      Returns:
      the modified date of this document library folder
    • setModifiedDate

      void setModifiedDate(Date modifiedDate)
      Sets the modified date of this document library folder.
      Specified by:
      setModifiedDate in interface AuditedModel
      Specified by:
      setModifiedDate in interface StagedModel
      Parameters:
      modifiedDate - the modified date of this document library folder
    • getRepositoryId

      long getRepositoryId()
      Returns the repository ID of this document library folder.
      Returns:
      the repository ID of this document library folder
    • setRepositoryId

      void setRepositoryId(long repositoryId)
      Sets the repository ID of this document library folder.
      Parameters:
      repositoryId - the repository ID of this document library folder
    • getMountPoint

      boolean getMountPoint()
      Returns the mount point of this document library folder.
      Returns:
      the mount point of this document library folder
    • isMountPoint

      boolean isMountPoint()
      Returns true if this document library folder is mount point.
      Returns:
      true if this document library folder is mount point; false otherwise
    • setMountPoint

      void setMountPoint(boolean mountPoint)
      Sets whether this document library folder is mount point.
      Parameters:
      mountPoint - the mount point of this document library folder
    • getParentFolderId

      long getParentFolderId()
      Returns the parent folder ID of this document library folder.
      Returns:
      the parent folder ID of this document library folder
    • setParentFolderId

      void setParentFolderId(long parentFolderId)
      Sets the parent folder ID of this document library folder.
      Parameters:
      parentFolderId - the parent folder ID of this document library folder
    • getTreePath

      @AutoEscape String getTreePath()
      Returns the tree path of this document library folder.
      Returns:
      the tree path of this document library folder
    • setTreePath

      void setTreePath(String treePath)
      Sets the tree path of this document library folder.
      Parameters:
      treePath - the tree path of this document library folder
    • getName

      @AutoEscape String getName()
      Returns the name of this document library folder.
      Returns:
      the name of this document library folder
    • setName

      void setName(String name)
      Sets the name of this document library folder.
      Parameters:
      name - the name of this document library folder
    • getDescription

      @AutoEscape String getDescription()
      Returns the description of this document library folder.
      Returns:
      the description of this document library folder
    • setDescription

      void setDescription(String description)
      Sets the description of this document library folder.
      Parameters:
      description - the description of this document library folder
    • getLastPostDate

      Date getLastPostDate()
      Returns the last post date of this document library folder.
      Returns:
      the last post date of this document library folder
    • setLastPostDate

      void setLastPostDate(Date lastPostDate)
      Sets the last post date of this document library folder.
      Parameters:
      lastPostDate - the last post date of this document library folder
    • getDefaultFileEntryTypeId

      long getDefaultFileEntryTypeId()
      Returns the default file entry type ID of this document library folder.
      Returns:
      the default file entry type ID of this document library folder
    • setDefaultFileEntryTypeId

      void setDefaultFileEntryTypeId(long defaultFileEntryTypeId)
      Sets the default file entry type ID of this document library folder.
      Parameters:
      defaultFileEntryTypeId - the default file entry type ID of this document library folder
    • getHidden

      boolean getHidden()
      Returns the hidden of this document library folder.
      Returns:
      the hidden of this document library folder
    • isHidden

      boolean isHidden()
      Returns true if this document library folder is hidden.
      Returns:
      true if this document library folder is hidden; false otherwise
    • setHidden

      void setHidden(boolean hidden)
      Sets whether this document library folder is hidden.
      Parameters:
      hidden - the hidden of this document library folder
    • getRestrictionType

      int getRestrictionType()
      Returns the restriction type of this document library folder.
      Returns:
      the restriction type of this document library folder
    • setRestrictionType

      void setRestrictionType(int restrictionType)
      Sets the restriction type of this document library folder.
      Parameters:
      restrictionType - the restriction type of this document library folder
    • getLastPublishDate

      Date getLastPublishDate()
      Returns the last publish date of this document library folder.
      Specified by:
      getLastPublishDate in interface StagedGroupedModel
      Returns:
      the last publish date of this document library folder
    • setLastPublishDate

      void setLastPublishDate(Date lastPublishDate)
      Sets the last publish date of this document library folder.
      Specified by:
      setLastPublishDate in interface StagedGroupedModel
      Parameters:
      lastPublishDate - the last publish date of this document library folder
    • getStatus

      int getStatus()
      Returns the status of this document library folder.
      Specified by:
      getStatus in interface TrashedModel
      Specified by:
      getStatus in interface WorkflowedModel
      Returns:
      the status of this document library folder
    • setStatus

      void setStatus(int status)
      Sets the status of this document library folder.
      Specified by:
      setStatus in interface WorkflowedModel
      Parameters:
      status - the status of this document library folder
    • getStatusByUserId

      long getStatusByUserId()
      Returns the status by user ID of this document library folder.
      Specified by:
      getStatusByUserId in interface WorkflowedModel
      Returns:
      the status by user ID of this document library folder
    • setStatusByUserId

      void setStatusByUserId(long statusByUserId)
      Sets the status by user ID of this document library folder.
      Specified by:
      setStatusByUserId in interface WorkflowedModel
      Parameters:
      statusByUserId - the status by user ID of this document library folder
    • getStatusByUserUuid

      String getStatusByUserUuid()
      Returns the status by user uuid of this document library folder.
      Specified by:
      getStatusByUserUuid in interface WorkflowedModel
      Returns:
      the status by user uuid of this document library folder
    • setStatusByUserUuid

      void setStatusByUserUuid(String statusByUserUuid)
      Sets the status by user uuid of this document library folder.
      Specified by:
      setStatusByUserUuid in interface WorkflowedModel
      Parameters:
      statusByUserUuid - the status by user uuid of this document library folder
    • getStatusByUserName

      @AutoEscape String getStatusByUserName()
      Returns the status by user name of this document library folder.
      Specified by:
      getStatusByUserName in interface WorkflowedModel
      Returns:
      the status by user name of this document library folder
    • setStatusByUserName

      void setStatusByUserName(String statusByUserName)
      Sets the status by user name of this document library folder.
      Specified by:
      setStatusByUserName in interface WorkflowedModel
      Parameters:
      statusByUserName - the status by user name of this document library folder
    • getStatusDate

      Date getStatusDate()
      Returns the status date of this document library folder.
      Specified by:
      getStatusDate in interface WorkflowedModel
      Returns:
      the status date of this document library folder
    • setStatusDate

      void setStatusDate(Date statusDate)
      Sets the status date of this document library folder.
      Specified by:
      setStatusDate in interface WorkflowedModel
      Parameters:
      statusDate - the status date of this document library folder
    • getTrashEntryClassPK

      long getTrashEntryClassPK()
      Returns the class primary key of the trash entry for this document library folder.
      Specified by:
      getTrashEntryClassPK in interface TrashedModel
      Returns:
      the class primary key of the trash entry for this document library folder
    • isInTrash

      boolean isInTrash()
      Returns true if this document library folder is in the Recycle Bin.
      Specified by:
      isInTrash in interface TrashedModel
      Returns:
      true if this document library folder is in the Recycle Bin; false otherwise
    • isApproved

      boolean isApproved()
      Returns true if this document library folder is approved.
      Specified by:
      isApproved in interface WorkflowedModel
      Returns:
      true if this document library folder is approved; false otherwise
    • isDenied

      boolean isDenied()
      Returns true if this document library folder is denied.
      Specified by:
      isDenied in interface WorkflowedModel
      Returns:
      true if this document library folder is denied; false otherwise
    • isDraft

      boolean isDraft()
      Returns true if this document library folder is a draft.
      Specified by:
      isDraft in interface WorkflowedModel
      Returns:
      true if this document library folder is a draft; false otherwise
    • isExpired

      boolean isExpired()
      Returns true if this document library folder is expired.
      Specified by:
      isExpired in interface WorkflowedModel
      Returns:
      true if this document library folder is expired; false otherwise
    • isInactive

      boolean isInactive()
      Returns true if this document library folder is inactive.
      Specified by:
      isInactive in interface WorkflowedModel
      Returns:
      true if this document library folder is inactive; false otherwise
    • isIncomplete

      boolean isIncomplete()
      Returns true if this document library folder is incomplete.
      Specified by:
      isIncomplete in interface WorkflowedModel
      Returns:
      true if this document library folder is incomplete; false otherwise
    • isPending

      boolean isPending()
      Returns true if this document library folder is pending.
      Specified by:
      isPending in interface WorkflowedModel
      Returns:
      true if this document library folder is pending; false otherwise
    • isScheduled

      boolean isScheduled()
      Returns true if this document library folder is scheduled.
      Specified by:
      isScheduled in interface WorkflowedModel
      Returns:
      true if this document library folder is scheduled; false otherwise
    • getContainerModelId

      long getContainerModelId()
      Returns the container model ID of this document library folder.
      Specified by:
      getContainerModelId in interface ContainerModel
      Returns:
      the container model ID of this document library folder
    • setContainerModelId

      void setContainerModelId(long containerModelId)
      Sets the container model ID of this document library folder.
      Specified by:
      setContainerModelId in interface ContainerModel
      Parameters:
      containerModelId - the container model ID of this document library folder
    • getContainerModelName

      String getContainerModelName()
      Returns the container name of this document library folder.
      Specified by:
      getContainerModelName in interface ContainerModel
      Returns:
      the container name of this document library folder
    • getParentContainerModelId

      long getParentContainerModelId()
      Returns the parent container model ID of this document library folder.
      Specified by:
      getParentContainerModelId in interface ContainerModel
      Returns:
      the parent container model ID of this document library folder
    • setParentContainerModelId

      void setParentContainerModelId(long parentContainerModelId)
      Sets the parent container model ID of this document library folder.
      Specified by:
      setParentContainerModelId in interface ContainerModel
      Parameters:
      parentContainerModelId - the parent container model ID of this document library folder
    • cloneWithOriginalValues

      DLFolder cloneWithOriginalValues()
      Specified by:
      cloneWithOriginalValues in interface BaseModel<DLFolder>
    • toXmlString

      default String toXmlString()