Class DLFolderWrapper

Object
com.liferay.portal.kernel.model.wrapper.BaseModelWrapper<DLFolder>
com.liferay.document.library.kernel.model.DLFolderWrapper
All Implemented Interfaces:
DLFolder, DLFolderModel, AuditedModel, BaseModel<DLFolder>, CTModel<DLFolder>, ClassedModel, ContainerModel, ExternalReferenceCodeModel, GroupedModel, ModelWrapper<DLFolder>, MVCCModel, PersistedModel, ShardedModel, StagedGroupedModel, StagedModel, TrashedModel, TreeModel, WorkflowedModel, Serializable, Cloneable, Comparable<DLFolder>

public class DLFolderWrapper extends BaseModelWrapper<DLFolder> implements DLFolder, ModelWrapper<DLFolder>

This class is a wrapper for DLFolder.

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

    • DLFolderWrapper

      public DLFolderWrapper(DLFolder dlFolder)
  • Method Details

    • getModelAttributes

      public Map<String,Object> getModelAttributes()
      Specified by:
      getModelAttributes in interface BaseModel<DLFolder>
    • setModelAttributes

      public void setModelAttributes(Map<String,Object> attributes)
      Specified by:
      setModelAttributes in interface BaseModel<DLFolder>
    • buildTreePath

      public String buildTreePath() throws PortalException
      Specified by:
      buildTreePath in interface TreeModel
      Throws:
      PortalException
    • cloneWithOriginalValues

      public DLFolder cloneWithOriginalValues()
      Specified by:
      cloneWithOriginalValues in interface BaseModel<DLFolder>
      Specified by:
      cloneWithOriginalValues in interface DLFolderModel
    • getAncestorFolderIds

      public List<Long> getAncestorFolderIds() throws PortalException
      Specified by:
      getAncestorFolderIds in interface DLFolder
      Throws:
      PortalException
    • getAncestors

      public List<DLFolder> getAncestors() throws PortalException
      Specified by:
      getAncestors in interface DLFolder
      Throws:
      PortalException
    • getCompanyId

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

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

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

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

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

      public long getDefaultFileEntryTypeId()
      Returns the default file entry type ID of this document library folder.
      Specified by:
      getDefaultFileEntryTypeId in interface DLFolderModel
      Returns:
      the default file entry type ID of this document library folder
    • getDescription

      public String getDescription()
      Returns the description of this document library folder.
      Specified by:
      getDescription in interface DLFolderModel
      Returns:
      the description of this document library folder
    • getExternalReferenceCode

      public String getExternalReferenceCode()
      Returns the external reference code of this document library folder.
      Specified by:
      getExternalReferenceCode in interface DLFolderModel
      Specified by:
      getExternalReferenceCode in interface ExternalReferenceCodeModel
      Returns:
      the external reference code of this document library folder
    • getFolderId

      public long getFolderId()
      Returns the folder ID of this document library folder.
      Specified by:
      getFolderId in interface DLFolderModel
      Returns:
      the folder ID of this document library folder
    • getGroupId

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

      public boolean getHidden()
      Returns the hidden of this document library folder.
      Specified by:
      getHidden in interface DLFolderModel
      Returns:
      the hidden of this document library folder
    • getLastPostDate

      public Date getLastPostDate()
      Returns the last post date of this document library folder.
      Specified by:
      getLastPostDate in interface DLFolderModel
      Returns:
      the last post date of this document library folder
    • getLastPublishDate

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

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

      public boolean getMountPoint()
      Returns the mount point of this document library folder.
      Specified by:
      getMountPoint in interface DLFolderModel
      Returns:
      the mount point of this document library folder
    • getMvccVersion

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

      public String getName()
      Returns the name of this document library folder.
      Specified by:
      getName in interface DLFolderModel
      Returns:
      the name of this document library folder
    • getParentContainerModelId

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

      public DLFolder getParentFolder() throws PortalException
      Specified by:
      getParentFolder in interface DLFolder
      Throws:
      PortalException
    • getParentFolderId

      public long getParentFolderId()
      Returns the parent folder ID of this document library folder.
      Specified by:
      getParentFolderId in interface DLFolderModel
      Returns:
      the parent folder ID of this document library folder
    • getPath

      public String getPath() throws PortalException
      Specified by:
      getPath in interface DLFolder
      Throws:
      PortalException
    • getPathArray

      public String[] getPathArray() throws PortalException
      Specified by:
      getPathArray in interface DLFolder
      Throws:
      PortalException
    • getPrimaryKey

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

      public long getRepositoryId()
      Returns the repository ID of this document library folder.
      Specified by:
      getRepositoryId in interface DLFolderModel
      Returns:
      the repository ID of this document library folder
    • getRestrictionType

      public int getRestrictionType()
      Returns the restriction type of this document library folder.
      Specified by:
      getRestrictionType in interface DLFolderModel
      Returns:
      the restriction type of this document library folder
    • getStatus

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

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

      public String getStatusByUserName()
      Returns the status by user name of this document library folder.
      Specified by:
      getStatusByUserName in interface DLFolderModel
      Specified by:
      getStatusByUserName in interface WorkflowedModel
      Returns:
      the status by user name of this document library folder
    • getStatusByUserUuid

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

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

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

      public String getTreePath()
      Returns the tree path of this document library folder.
      Specified by:
      getTreePath in interface DLFolderModel
      Specified by:
      getTreePath in interface TreeModel
      Returns:
      the tree path of this document library folder
    • getUserId

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

      public String getUserName()
      Returns the user name of this document library folder.
      Specified by:
      getUserName in interface AuditedModel
      Specified by:
      getUserName in interface DLFolderModel
      Returns:
      the user name of this document library folder
    • getUserUuid

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

      public String getUuid()
      Returns the uuid of this document library folder.
      Specified by:
      getUuid in interface DLFolderModel
      Specified by:
      getUuid in interface StagedModel
      Returns:
      the uuid of this document library folder
    • hasInheritableLock

      public boolean hasInheritableLock()
      Specified by:
      hasInheritableLock in interface DLFolder
    • hasLock

      public boolean hasLock()
      Specified by:
      hasLock in interface DLFolder
    • isApproved

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

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

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

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

      public boolean isHidden()
      Returns true if this document library folder is hidden.
      Specified by:
      isHidden in interface DLFolderModel
      Returns:
      true if this document library folder is hidden; false otherwise
    • isInactive

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

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

      public boolean isInHiddenFolder()
      Specified by:
      isInHiddenFolder in interface DLFolder
    • isInTrash

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

      public boolean isLocked()
      Specified by:
      isLocked in interface DLFolder
    • isMountPoint

      public boolean isMountPoint()
      Returns true if this document library folder is mount point.
      Specified by:
      isMountPoint in interface DLFolderModel
      Returns:
      true if this document library folder is mount point; false otherwise
    • isPending

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

      public boolean isRoot()
      Specified by:
      isRoot in interface DLFolder
    • isScheduled

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

      public void persist()
      Description copied from interface: PersistedModel
      Updates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
      Specified by:
      persist in interface PersistedModel
    • setCompanyId

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

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

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

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

      public void setDefaultFileEntryTypeId(long defaultFileEntryTypeId)
      Sets the default file entry type ID of this document library folder.
      Specified by:
      setDefaultFileEntryTypeId in interface DLFolderModel
      Parameters:
      defaultFileEntryTypeId - the default file entry type ID of this document library folder
    • setDescription

      public void setDescription(String description)
      Sets the description of this document library folder.
      Specified by:
      setDescription in interface DLFolderModel
      Parameters:
      description - the description of this document library folder
    • setExternalReferenceCode

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

      public void setFolderId(long folderId)
      Sets the folder ID of this document library folder.
      Specified by:
      setFolderId in interface DLFolderModel
      Parameters:
      folderId - the folder ID of this document library folder
    • setGroupId

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

      public void setHidden(boolean hidden)
      Sets whether this document library folder is hidden.
      Specified by:
      setHidden in interface DLFolderModel
      Parameters:
      hidden - the hidden of this document library folder
    • setLastPostDate

      public void setLastPostDate(Date lastPostDate)
      Sets the last post date of this document library folder.
      Specified by:
      setLastPostDate in interface DLFolderModel
      Parameters:
      lastPostDate - the last post date of this document library folder
    • setLastPublishDate

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

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

      public void setMountPoint(boolean mountPoint)
      Sets whether this document library folder is mount point.
      Specified by:
      setMountPoint in interface DLFolderModel
      Parameters:
      mountPoint - the mount point of this document library folder
    • setMvccVersion

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

      public void setName(String name)
      Sets the name of this document library folder.
      Specified by:
      setName in interface DLFolderModel
      Parameters:
      name - the name of this document library folder
    • setParentContainerModelId

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

      public void setParentFolderId(long parentFolderId)
      Sets the parent folder ID of this document library folder.
      Specified by:
      setParentFolderId in interface DLFolderModel
      Parameters:
      parentFolderId - the parent folder ID of this document library folder
    • setPrimaryKey

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

      public void setRepositoryId(long repositoryId)
      Sets the repository ID of this document library folder.
      Specified by:
      setRepositoryId in interface DLFolderModel
      Parameters:
      repositoryId - the repository ID of this document library folder
    • setRestrictionType

      public void setRestrictionType(int restrictionType)
      Sets the restriction type of this document library folder.
      Specified by:
      setRestrictionType in interface DLFolderModel
      Parameters:
      restrictionType - the restriction type of this document library folder
    • setStatus

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

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

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

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

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

      public void setTreePath(String treePath)
      Sets the tree path of this document library folder.
      Specified by:
      setTreePath in interface DLFolderModel
      Parameters:
      treePath - the tree path of this document library folder
    • setUserId

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

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

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

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

      public String toXmlString()
      Specified by:
      toXmlString in interface DLFolderModel
    • updateTreePath

      public void updateTreePath(String treePath)
      Specified by:
      updateTreePath in interface TreeModel
    • getAttributeGetterFunctions

      public Map<String,Function<DLFolder,Object>> getAttributeGetterFunctions()
      Specified by:
      getAttributeGetterFunctions in interface BaseModel<DLFolder>
    • getAttributeSetterBiConsumers

      public Map<String,BiConsumer<DLFolder,Object>> getAttributeSetterBiConsumers()
      Specified by:
      getAttributeSetterBiConsumers in interface BaseModel<DLFolder>
    • getStagedModelType

      public StagedModelType getStagedModelType()
      Specified by:
      getStagedModelType in interface StagedModel
    • wrap

      protected DLFolderWrapper wrap(DLFolder dlFolder)
      Specified by:
      wrap in class BaseModelWrapper<DLFolder>