DLFolderWrapper (Liferay 7.0.10 portal-kernel API)

Object
- com.liferay.document.library.kernel.model.DLFolderWrapper

All Implemented Interfaces:

DLFolder, DLFolderModel, AuditedModel, BaseModel<DLFolder>, ClassedModel, ContainerModel, GroupedModel, ModelWrapper<DLFolder>, PersistedModel, ShardedModel, StagedGroupedModel, StagedModel, TrashedModel, TreeModel, WorkflowedModel, Serializable, Cloneable, Comparable<DLFolder>
```
@ProviderType
public class DLFolderWrapper
extends Object
implements DLFolder, ModelWrapper<DLFolder>
```
This class is a wrapper for DLFolder.

Author:

Brian Wing Shun Chan

See Also:

DLFolder, Serialized Form

{$generated.description}

Field Summary
- Fields inherited from interface com.liferay.document.library.kernel.model.DLFolder
  FOLDER_ID_ACCESSOR

Constructor Summary

Constructors
Constructor and Description

DLFolderWrapper(DLFolder dlFolder)

Constructors
Constructor and Description
`DLFolderWrapper(DLFolder dlFolder)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`buildTreePath()`
`Object`	`clone()` Creates a shallow clone of this model instance.
`int`	`compareTo(DLFolder dlFolder)`
`boolean`	`equals(Object obj)`
`List<Long>`	`getAncestorFolderIds()`
`List<DLFolder>`	`getAncestors()`
`long`	`getCompanyId()` Returns the company ID of this document library folder.
`long`	`getContainerModelId()` Returns the container model ID of this document library folder.
`String`	`getContainerModelName()` Returns the container name of this document library folder.
`Date`	`getCreateDate()` Returns the create date of this document library folder.
`long`	`getDefaultFileEntryTypeId()` Returns the default file entry type ID of this document library folder.
`String`	`getDescription()` Returns the description of this document library folder.
`ExpandoBridge`	`getExpandoBridge()` Returns the expando bridge for this model instance.
`long`	`getFolderId()` Returns the folder ID of this document library folder.
`long`	`getGroupId()` Returns the group ID of this document library folder.
`boolean`	`getHidden()` Returns the hidden of this document library folder.
`Date`	`getLastPostDate()` Returns the last post date of this document library folder.
`Date`	`getLastPublishDate()` Returns the last publish date of this document library folder.
`Map<String,Object>`	`getModelAttributes()`
`Class<?>`	`getModelClass()`
`String`	`getModelClassName()`
`Date`	`getModifiedDate()` Returns the modified date of this document library folder.
`boolean`	`getMountPoint()` Returns the mount point of this document library folder.
`String`	`getName()` Returns the name of this document library folder.
`long`	`getParentContainerModelId()` Returns the parent container model ID of this document library folder.
`DLFolder`	`getParentFolder()`
`long`	`getParentFolderId()` Returns the parent folder ID of this document library folder.
`String`	`getPath()`
`String[]`	`getPathArray()`
`long`	`getPrimaryKey()` Returns the primary key of this document library folder.
`Serializable`	`getPrimaryKeyObj()` Returns the primary key of this model instance.
`long`	`getRepositoryId()` Returns the repository ID of this document library folder.
`int`	`getRestrictionType()` Returns the restriction type of this document library folder.
`StagedModelType`	`getStagedModelType()`
`int`	`getStatus()` Returns the status of this document library folder.
`long`	`getStatusByUserId()` Returns the status by user ID of this document library folder.
`String`	`getStatusByUserName()` Returns the status by user name of this document library folder.
`String`	`getStatusByUserUuid()` Returns the status by user uuid of this document library folder.
`Date`	`getStatusDate()` Returns the status date of this document library folder.
`TrashEntry`	`getTrashEntry()` Returns the trash entry created when this document library folder was moved to the Recycle Bin.
`long`	`getTrashEntryClassPK()` Returns the class primary key of the trash entry for this document library folder.
`TrashHandler`	`getTrashHandler()` Deprecated. As of Judson (7.1.x), with no direct replacement
`String`	`getTreePath()` Returns the tree path of this document library folder.
`long`	`getUserId()` Returns the user ID of this document library folder.
`String`	`getUserName()` Returns the user name of this document library folder.
`String`	`getUserUuid()` Returns the user uuid of this document library folder.
`String`	`getUuid()` Returns the uuid of this document library folder.
`DLFolder`	`getWrappedModel()`
`int`	`hashCode()`
`boolean`	`hasInheritableLock()`
`boolean`	`hasLock()`
`boolean`	`isApproved()` Returns `true` if this document library folder is approved.
`boolean`	`isCachedModel()` Returns `true` if this model instance was retrieved from the entity cache.
`boolean`	`isDenied()` Returns `true` if this document library folder is denied.
`boolean`	`isDraft()` Returns `true` if this document library folder is a draft.
`boolean`	`isEntityCacheEnabled()` Returns `true` if this model's entity cache is enabled.
`boolean`	`isEscapedModel()` Returns `true` if this model instance is escaped.
`boolean`	`isExpired()` Returns `true` if this document library folder is expired.
`boolean`	`isFinderCacheEnabled()` Returns `true` if this model's finder cache is enabled.
`boolean`	`isHidden()` Returns `true` if this document library folder is hidden.
`boolean`	`isInactive()` Returns `true` if this document library folder is inactive.
`boolean`	`isIncomplete()` Returns `true` if this document library folder is incomplete.
`boolean`	`isInHiddenFolder()`
`boolean`	`isInTrash()` Returns `true` if this document library folder is in the Recycle Bin.
`boolean`	`isInTrashContainer()` Returns `true` if the parent of this document library folder is in the Recycle Bin.
`boolean`	`isInTrashExplicitly()`
`boolean`	`isInTrashImplicitly()`
`boolean`	`isLocked()`
`boolean`	`isMountPoint()` Returns `true` if this document library folder is mount point.
`boolean`	`isNew()` Returns `true` if this model instance does not yet exist in the database.
`boolean`	`isPending()` Returns `true` if this document library folder is pending.
`boolean`	`isRoot()`
`boolean`	`isScheduled()` Returns `true` if this document library folder is scheduled.
`void`	`persist()` Updates this model instance in the database or adds it if it does not yet exist.
`void`	`resetOriginalValues()` Reset all original fields to current values.
`void`	`setCachedModel(boolean cachedModel)` Sets whether this model instance was retrieved from the entity cache.
`void`	`setCompanyId(long companyId)` Sets the company ID of this document library folder.
`void`	`setContainerModelId(long containerModelId)` Sets the container model ID of this document library folder.
`void`	`setCreateDate(Date createDate)` Sets the create date of this document library folder.
`void`	`setDefaultFileEntryTypeId(long defaultFileEntryTypeId)` Sets the default file entry type ID of this document library folder.
`void`	`setDescription(String description)` Sets the description of this document library folder.
`void`	`setExpandoBridgeAttributes(BaseModel<?> baseModel)`
`void`	`setExpandoBridgeAttributes(ExpandoBridge expandoBridge)`
`void`	`setExpandoBridgeAttributes(ServiceContext serviceContext)` Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
`void`	`setFolderId(long folderId)` Sets the folder ID of this document library folder.
`void`	`setGroupId(long groupId)` Sets the group ID of this document library folder.
`void`	`setHidden(boolean hidden)` Sets whether this document library folder is hidden.
`void`	`setLastPostDate(Date lastPostDate)` Sets the last post date of this document library folder.
`void`	`setLastPublishDate(Date lastPublishDate)` Sets the last publish date of this document library folder.
`void`	`setModelAttributes(Map<String,Object> attributes)`
`void`	`setModifiedDate(Date modifiedDate)` Sets the modified date of this document library folder.
`void`	`setMountPoint(boolean mountPoint)` Sets whether this document library folder is mount point.
`void`	`setName(String name)` Sets the name of this document library folder.
`void`	`setNew(boolean n)` Sets whether this model instance does not yet exist in the database.
`void`	`setParentContainerModelId(long parentContainerModelId)` Sets the parent container model ID of this document library folder.
`void`	`setParentFolderId(long parentFolderId)` Sets the parent folder ID of this document library folder.
`void`	`setPrimaryKey(long primaryKey)` Sets the primary key of this document library folder.
`void`	`setPrimaryKeyObj(Serializable primaryKeyObj)` Sets the primary key of this model instance.
`void`	`setRepositoryId(long repositoryId)` Sets the repository ID of this document library folder.
`void`	`setRestrictionType(int restrictionType)` Sets the restriction type of this document library folder.
`void`	`setStatus(int status)` Sets the status of this document library folder.
`void`	`setStatusByUserId(long statusByUserId)` Sets the status by user ID of this document library folder.
`void`	`setStatusByUserName(String statusByUserName)` Sets the status by user name of this document library folder.
`void`	`setStatusByUserUuid(String statusByUserUuid)` Sets the status by user uuid of this document library folder.
`void`	`setStatusDate(Date statusDate)` Sets the status date of this document library folder.
`void`	`setTreePath(String treePath)` Sets the tree path of this document library folder.
`void`	`setUserId(long userId)` Sets the user ID of this document library folder.
`void`	`setUserName(String userName)` Sets the user name of this document library folder.
`void`	`setUserUuid(String userUuid)` Sets the user uuid of this document library folder.
`void`	`setUuid(String uuid)` Sets the uuid of this document library folder.
`CacheModel<DLFolder>`	`toCacheModel()` Returns a cache model object for this entity used by entity cache.
`DLFolder`	`toEscapedModel()` Returns a copy of this entity as an escaped model instance by wrapping it with an `AutoEscapeBeanHandler`.
`String`	`toString()`
`DLFolder`	`toUnescapedModel()`
`String`	`toXmlString()` Returns the XML representation of this model instance.
`void`	`updateTreePath(String treePath)`

Methods inherited from class Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DLFolderWrapper
```
public DLFolderWrapper(DLFolder dlFolder)
```
- Method Detail
  - getModelClass
```
public Class<?> getModelClass()
```
    Specified by:
    
    getModelClass in interface ClassedModel
    
    Specified by:
    
    getModelClass in interface ContainerModel
  - getModelClassName
```
public String getModelClassName()
```
    Specified by:
    
    getModelClassName in interface ClassedModel
    
    Specified by:
    
    getModelClassName in interface ContainerModel
  - 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
  - clone
```
public Object clone()
```
    Description copied from interface: BaseModel
    
    Creates a shallow clone of this model instance.
    
    Specified by:
    
    clone in interface DLFolderModel
    
    Specified by:
    
    clone in interface BaseModel<DLFolder>
    
    Specified by:
    
    clone in interface StagedModel
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    the shallow clone of this model instance
  - compareTo
```
public int compareTo(DLFolder dlFolder)
```
    Specified by:
    
    compareTo in interface DLFolderModel
    
    Specified by:
    
    compareTo in interface Comparable<DLFolder>
  - 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 DLFolderModel
    
    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
  - getContainerModelId
```
public long getContainerModelId()
```
    Returns the container model ID of this document library folder.
    
    Specified by:
    
    getContainerModelId in interface DLFolderModel
    
    Specified by:
    
    getContainerModelId in interface ContainerModel
    
    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 DLFolderModel
    
    Specified by:
    
    getContainerModelName in interface ContainerModel
    
    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 DLFolderModel
    
    Specified by:
    
    getCreateDate in interface AuditedModel
    
    Specified by:
    
    getCreateDate in interface StagedModel
    
    Returns:
    
    the create date 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
  - getExpandoBridge
```
public ExpandoBridge getExpandoBridge()
```
    Description copied from interface: BaseModel
    
    Returns the expando bridge for this model instance.
    
    Specified by:
    
    getExpandoBridge in interface DLFolderModel
    
    Specified by:
    
    getExpandoBridge in interface BaseModel<DLFolder>
    
    Specified by:
    
    getExpandoBridge in interface ClassedModel
    
    Returns:
    
    the expando bridge for this model instance
  - 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 DLFolderModel
    
    Specified by:
    
    getModifiedDate in interface AuditedModel
    
    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
  - 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 DLFolderModel
    
    Specified by:
    
    getParentContainerModelId in interface ContainerModel
    
    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 DLFolderModel
    
    Returns:
    
    the primary key of this document library folder
  - getPrimaryKeyObj
```
public Serializable getPrimaryKeyObj()
```
    Description copied from interface: BaseModel
    
    Returns the primary key of this model instance.
    
    Specified by:
    
    getPrimaryKeyObj in interface DLFolderModel
    
    Specified by:
    
    getPrimaryKeyObj in interface BaseModel<DLFolder>
    
    Specified by:
    
    getPrimaryKeyObj in interface ClassedModel
    
    Specified by:
    
    getPrimaryKeyObj in interface TreeModel
    
    Returns:
    
    the primary key of this model instance
  - 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
  - getTrashEntry
```
public TrashEntry getTrashEntry()
                         throws PortalException
```
    Returns the trash entry created when this document library folder was moved to the Recycle Bin. The trash entry may belong to one of the ancestors of this document library folder.
    
    Specified by:
    
    getTrashEntry in interface DLFolderModel
    
    Specified by:
    
    getTrashEntry in interface TrashedModel
    
    Returns:
    
    the trash entry created when this document library folder was moved to the Recycle Bin
    
    Throws:
    
    PortalException
  - 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
  - getTrashHandler
```
@Deprecated
public TrashHandler getTrashHandler()
```
    Deprecated. As of Judson (7.1.x), with no direct replacement
    
    Returns the trash handler for this document library folder.
    
    Specified by:
    
    getTrashHandler in interface DLFolderModel
    
    Specified by:
    
    getTrashHandler in interface TrashedModel
    
    Returns:
    
    the trash handler 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 DLFolderModel
    
    Specified by:
    
    getUserId in interface AuditedModel
    
    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 DLFolderModel
    
    Specified by:
    
    getUserName in interface AuditedModel
    
    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 DLFolderModel
    
    Specified by:
    
    getUserUuid in interface AuditedModel
    
    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
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface DLFolderModel
    
    Overrides:
    
    hashCode in class Object
  - 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
  - isCachedModel
```
public boolean isCachedModel()
```
    Description copied from interface: BaseModel
    
    Returns true if this model instance was retrieved from the entity cache.
    
    Specified by:
    
    isCachedModel in interface DLFolderModel
    
    Specified by:
    
    isCachedModel in interface BaseModel<DLFolder>
    
    Returns:
    
    true if this model instance was retrieved from the entity cache; false otherwise
    
    See Also:
    
    BaseModel.setCachedModel(boolean)
  - 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
  - isEscapedModel
```
public boolean isEscapedModel()
```
    Description copied from interface: BaseModel
    
    Returns true if this model instance is escaped.
    
    Specified by:
    
    isEscapedModel in interface DLFolderModel
    
    Specified by:
    
    isEscapedModel in interface BaseModel<DLFolder>
    
    Returns:
    
    true if this model instance is escaped; 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
  - isInTrashContainer
```
public boolean isInTrashContainer()
```
    Returns true if the parent of this document library folder is in the Recycle Bin.
    
    Specified by:
    
    isInTrashContainer in interface DLFolderModel
    
    Specified by:
    
    isInTrashContainer in interface TrashedModel
    
    Returns:
    
    true if the parent of this document library folder is in the Recycle Bin; false otherwise
  - isInTrashExplicitly
```
public boolean isInTrashExplicitly()
```
    Specified by:
    
    isInTrashExplicitly in interface DLFolderModel
    
    Specified by:
    
    isInTrashExplicitly in interface TrashedModel
  - isInTrashImplicitly
```
public boolean isInTrashImplicitly()
```
    Specified by:
    
    isInTrashImplicitly in interface DLFolderModel
    
    Specified by:
    
    isInTrashImplicitly in interface TrashedModel
  - 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
  - isNew
```
public boolean isNew()
```
    Description copied from interface: BaseModel
    
    Returns true if this model instance does not yet exist in the database.
    
    Specified by:
    
    isNew in interface DLFolderModel
    
    Specified by:
    
    isNew in interface BaseModel<DLFolder>
    
    Returns:
    
    true if this model instance does not yet exist in the database; 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
  - setCachedModel
```
public void setCachedModel(boolean cachedModel)
```
    Description copied from interface: BaseModel
    
    Sets whether this model instance was retrieved from the entity cache.
    
    Specified by:
    
    setCachedModel in interface DLFolderModel
    
    Specified by:
    
    setCachedModel in interface BaseModel<DLFolder>
    
    Parameters:
    
    cachedModel - whether this model instance was retrieved from the entity cache
    
    See Also:
    
    EntityCache
  - setCompanyId
```
public void setCompanyId(long companyId)
```
    Sets the company ID of this document library folder.
    
    Specified by:
    
    setCompanyId in interface DLFolderModel
    
    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
  - setContainerModelId
```
public void setContainerModelId(long containerModelId)
```
    Sets the container model ID of this document library folder.
    
    Specified by:
    
    setContainerModelId in interface DLFolderModel
    
    Specified by:
    
    setContainerModelId in interface ContainerModel
    
    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 DLFolderModel
    
    Specified by:
    
    setCreateDate in interface AuditedModel
    
    Specified by:
    
    setCreateDate in interface StagedModel
    
    Parameters:
    
    createDate - the create date 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
  - setExpandoBridgeAttributes
```
public void setExpandoBridgeAttributes(BaseModel<?> baseModel)
```
    Specified by:
    
    setExpandoBridgeAttributes in interface DLFolderModel
    
    Specified by:
    
    setExpandoBridgeAttributes in interface BaseModel<DLFolder>
  - setExpandoBridgeAttributes
```
public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
```
    Specified by:
    
    setExpandoBridgeAttributes in interface DLFolderModel
    
    Specified by:
    
    setExpandoBridgeAttributes in interface BaseModel<DLFolder>
  - setExpandoBridgeAttributes
```
public void setExpandoBridgeAttributes(ServiceContext serviceContext)
```
    Description copied from interface: BaseModel
    
    Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
    
    Specified by:
    
    setExpandoBridgeAttributes in interface DLFolderModel
    
    Specified by:
    
    setExpandoBridgeAttributes in interface BaseModel<DLFolder>
    
    Parameters:
    
    serviceContext - the service context to be applied
    
    See Also:
    
    ServiceContext.getExpandoBridgeAttributes()
  - 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 DLFolderModel
    
    Specified by:
    
    setModifiedDate in interface AuditedModel
    
    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
  - 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
  - setNew
```
public void setNew(boolean n)
```
    Description copied from interface: BaseModel
    
    Sets whether this model instance does not yet exist in the database.
    
    Specified by:
    
    setNew in interface DLFolderModel
    
    Specified by:
    
    setNew in interface BaseModel<DLFolder>
    
    Parameters:
    
    n - whether this model instance does not yet exist in the database
  - setParentContainerModelId
```
public void setParentContainerModelId(long parentContainerModelId)
```
    Sets the parent container model ID of this document library folder.
    
    Specified by:
    
    setParentContainerModelId in interface DLFolderModel
    
    Specified by:
    
    setParentContainerModelId in interface ContainerModel
    
    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 DLFolderModel
    
    Parameters:
    
    primaryKey - the primary key of this document library folder
  - setPrimaryKeyObj
```
public void setPrimaryKeyObj(Serializable primaryKeyObj)
```
    Description copied from interface: BaseModel
    
    Sets the primary key of this model instance.
    
    Specified by:
    
    setPrimaryKeyObj in interface DLFolderModel
    
    Specified by:
    
    setPrimaryKeyObj in interface BaseModel<DLFolder>
    
    Specified by:
    
    setPrimaryKeyObj in interface ClassedModel
    
    Parameters:
    
    primaryKeyObj - the primary key of this model instance
  - 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 DLFolderModel
    
    Specified by:
    
    setUserId in interface AuditedModel
    
    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 DLFolderModel
    
    Specified by:
    
    setUserName in interface AuditedModel
    
    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 DLFolderModel
    
    Specified by:
    
    setUserUuid in interface AuditedModel
    
    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
  - toCacheModel
```
public CacheModel<DLFolder> toCacheModel()
```
    Description copied from interface: BaseModel
    
    Returns a cache model object for this entity used by entity cache.
    
    Specified by:
    
    toCacheModel in interface DLFolderModel
    
    Specified by:
    
    toCacheModel in interface BaseModel<DLFolder>
    
    Returns:
    
    the cache model object
  - toEscapedModel
```
public DLFolder toEscapedModel()
```
    Description copied from interface: BaseModel
    
    Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
    
    Specified by:
    
    toEscapedModel in interface DLFolderModel
    
    Specified by:
    
    toEscapedModel in interface BaseModel<DLFolder>
    
    Returns:
    
    the escaped model instance
    
    See Also:
    
    AutoEscapeBeanHandler
  - toString
```
public String toString()
```
    Specified by:
    
    toString in interface DLFolderModel
    
    Overrides:
    
    toString in class Object
  - toUnescapedModel
```
public DLFolder toUnescapedModel()
```
    Specified by:
    
    toUnescapedModel in interface DLFolderModel
    
    Specified by:
    
    toUnescapedModel in interface BaseModel<DLFolder>
  - toXmlString
```
public String toXmlString()
```
    Description copied from interface: BaseModel
    
    Returns the XML representation of this model instance.
    
    Specified by:
    
    toXmlString in interface DLFolderModel
    
    Specified by:
    
    toXmlString in interface BaseModel<DLFolder>
    
    Returns:
    
    the XML representation of this model instance
  - updateTreePath
```
public void updateTreePath(String treePath)
```
    Specified by:
    
    updateTreePath in interface TreeModel
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getStagedModelType
```
public StagedModelType getStagedModelType()
```
    Specified by:
    
    getStagedModelType in interface StagedModel
  - getWrappedModel
```
public DLFolder getWrappedModel()
```
    Specified by:
    
    getWrappedModel in interface ModelWrapper<DLFolder>
  - isEntityCacheEnabled
```
public boolean isEntityCacheEnabled()
```
    Description copied from interface: BaseModel
    
    Returns true if this model's entity cache is enabled.
    
    Specified by:
    
    isEntityCacheEnabled in interface BaseModel<DLFolder>
    
    Returns:
    
    true if this model's entity cache is enabled; false otherwise
  - isFinderCacheEnabled
```
public boolean isFinderCacheEnabled()
```
    Description copied from interface: BaseModel
    
    Returns true if this model's finder cache is enabled.
    
    Specified by:
    
    isFinderCacheEnabled in interface BaseModel<DLFolder>
    
    Returns:
    
    true if this model's finder cache is enabled; false otherwise
  - resetOriginalValues
```
public void resetOriginalValues()
```
    Description copied from interface: BaseModel
    
    Reset all original fields to current values.
    
    Specified by:
    
    resetOriginalValues in interface BaseModel<DLFolder>

Class DLFolderWrapper

Field Summary

Fields inherited from interface com.liferay.document.library.kernel.model.DLFolder

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

DLFolderWrapper

Method Detail

getModelClass

getModelClassName

getModelAttributes

setModelAttributes

buildTreePath

clone

compareTo

getAncestorFolderIds

getAncestors

getCompanyId

getContainerModelId

getContainerModelName

getCreateDate

getDefaultFileEntryTypeId

getDescription

getExpandoBridge

getFolderId

getGroupId

getHidden

getLastPostDate

getLastPublishDate

getModifiedDate

getMountPoint

getName

getParentContainerModelId

getParentFolder

getParentFolderId

getPath

getPathArray

getPrimaryKey

getPrimaryKeyObj

getRepositoryId

getRestrictionType

getStatus

getStatusByUserId

getStatusByUserName

getStatusByUserUuid

getStatusDate

getTrashEntry

getTrashEntryClassPK

getTrashHandler

getTreePath

getUserId

getUserName

getUserUuid

getUuid

hashCode

hasInheritableLock

hasLock

isApproved

isCachedModel

isDenied

isDraft

isEscapedModel

isExpired

isHidden

isInactive

isIncomplete

isInHiddenFolder

isInTrash

isInTrashContainer

isInTrashExplicitly

isInTrashImplicitly

isLocked

isMountPoint

isNew

isPending

isRoot

isScheduled

persist

setCachedModel