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
@ProviderType
public interface DLFolderModel
extends BaseModel<DLFolder>, ContainerModel, CTModel<DLFolder>, ExternalReferenceCodeModel, MVCCModel, ShardedModel, StagedGroupedModel, TrashedModel, WorkflowedModel
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 Summary
Modifier and TypeMethodDescriptionlong
Returns the company ID of this document library folder.long
Returns the container model ID of this document library folder.Returns the container name of this document library folder.Returns the create date of this document library folder.long
Returns the ct collection ID of this document library folder.long
Returns the default file entry type ID of this document library folder.Returns the description of this document library folder.Returns the external reference code of this document library folder.long
Returns the folder ID of this document library folder.long
Returns the group ID of this document library folder.boolean
Returns the hidden of this document library folder.Returns the last post date of this document library folder.Returns the last publish date of this document library folder.Returns the modified date of this document library folder.boolean
Returns the mount point of this document library folder.long
Returns the mvcc version of this document library folder.getName()
Returns the name of this document library folder.long
Returns the parent container model ID of this document library folder.long
Returns the parent folder ID of this document library folder.long
Returns the primary key of this document library folder.long
Returns the repository ID of this document library folder.int
Returns the restriction type of this document library folder.int
Returns the status of this document library folder.long
Returns the status by user ID of this document library folder.Returns the status by user name of this document library folder.Returns the status by user uuid of this document library folder.Returns the status date of this document library folder.long
Returns the class primary key of the trash entry for this document library folder.Returns the tree path of this document library folder.long
Returns the user ID of this document library folder.Returns the user name of this document library folder.Returns the user uuid of this document library folder.getUuid()
Returns the uuid of this document library folder.boolean
Returnstrue
if this document library folder is approved.boolean
isDenied()
Returnstrue
if this document library folder is denied.boolean
isDraft()
Returnstrue
if this document library folder is a draft.boolean
Returnstrue
if this document library folder is expired.boolean
isHidden()
Returnstrue
if this document library folder is hidden.boolean
Returnstrue
if this document library folder is inactive.boolean
Returnstrue
if this document library folder is incomplete.boolean
Returnstrue
if this document library folder is in the Recycle Bin.boolean
Returnstrue
if this document library folder is mount point.boolean
Returnstrue
if this document library folder is pending.boolean
Returnstrue
if this document library folder is scheduled.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
setCtCollectionId
(long ctCollectionId) Sets the ct collection ID 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
setExternalReferenceCode
(String externalReferenceCode) Sets the external reference code of this document library folder.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
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
setMvccVersion
(long mvccVersion) Sets the mvcc version of this document library folder.void
Sets the name of this document library folder.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
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
Sets the uuid of this document library folder.default String
Methods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel
Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface com.liferay.portal.kernel.model.ContainerModel
getModelClass, getModelClassName
Methods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone, getStagedModelType
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this document library folder.- Specified by:
getPrimaryKey
in interfaceCTModel<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 interfaceCTModel<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 interfaceMVCCModel
- 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 interfaceMVCCModel
- 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 interfaceCTModel<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 interfaceCTModel<DLFolder>
- Parameters:
ctCollectionId
- the ct collection ID of this document library folder
-
getUuid
Returns the uuid of this document library folder.- Specified by:
getUuid
in interfaceStagedModel
- Returns:
- the uuid of this document library folder
-
setUuid
Sets the uuid of this document library folder.- Specified by:
setUuid
in interfaceStagedModel
- Parameters:
uuid
- the uuid of this document library folder
-
getExternalReferenceCode
Returns the external reference code of this document library folder.- Specified by:
getExternalReferenceCode
in interfaceExternalReferenceCodeModel
- Returns:
- the external reference code of this document library folder
-
setExternalReferenceCode
Sets the external reference code of this document library folder.- Specified by:
setExternalReferenceCode
in interfaceExternalReferenceCodeModel
- 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 interfaceGroupedModel
- 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 interfaceGroupedModel
- 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 interfaceAuditedModel
- Specified by:
getCompanyId
in interfaceShardedModel
- Specified by:
getCompanyId
in interfaceStagedModel
- 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 interfaceAuditedModel
- Specified by:
setCompanyId
in interfaceShardedModel
- Specified by:
setCompanyId
in interfaceStagedModel
- 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 interfaceAuditedModel
- 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 interfaceAuditedModel
- 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 interfaceAuditedModel
- Returns:
- the user uuid of this document library folder
-
setUserUuid
Sets the user uuid of this document library folder.- Specified by:
setUserUuid
in interfaceAuditedModel
- Parameters:
userUuid
- the user uuid of this document library folder
-
getUserName
Returns the user name of this document library folder.- Specified by:
getUserName
in interfaceAuditedModel
- Returns:
- the user name of this document library folder
-
setUserName
Sets the user name of this document library folder.- Specified by:
setUserName
in interfaceAuditedModel
- 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 interfaceAuditedModel
- Specified by:
getCreateDate
in interfaceStagedModel
- Returns:
- the create date of this document library folder
-
setCreateDate
Sets the create date of this document library folder.- Specified by:
setCreateDate
in interfaceAuditedModel
- Specified by:
setCreateDate
in interfaceStagedModel
- 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 interfaceAuditedModel
- Specified by:
getModifiedDate
in interfaceStagedModel
- Returns:
- the modified date of this document library folder
-
setModifiedDate
Sets the modified date of this document library folder.- Specified by:
setModifiedDate
in interfaceAuditedModel
- Specified by:
setModifiedDate
in interfaceStagedModel
- 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()Returnstrue
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
Returns the tree path of this document library folder.- Returns:
- the tree path of this document library folder
-
setTreePath
Sets the tree path of this document library folder.- Parameters:
treePath
- the tree path of this document library folder
-
getName
Returns the name of this document library folder.- Returns:
- the name of this document library folder
-
setName
Sets the name of this document library folder.- Parameters:
name
- the name of this document library folder
-
getDescription
Returns the description of this document library folder.- Returns:
- the description of this document library folder
-
setDescription
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
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()Returnstrue
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 interfaceStagedGroupedModel
- Returns:
- the last publish date of this document library folder
-
setLastPublishDate
Sets the last publish date of this document library folder.- Specified by:
setLastPublishDate
in interfaceStagedGroupedModel
- 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 interfaceTrashedModel
- Specified by:
getStatus
in interfaceWorkflowedModel
- 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 interfaceWorkflowedModel
- 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 interfaceWorkflowedModel
- 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 interfaceWorkflowedModel
- 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 interfaceWorkflowedModel
- Returns:
- the status by user uuid of this document library folder
-
setStatusByUserUuid
Sets the status by user uuid of this document library folder.- Specified by:
setStatusByUserUuid
in interfaceWorkflowedModel
- Parameters:
statusByUserUuid
- the status by user uuid of this document library folder
-
getStatusByUserName
Returns the status by user name of this document library folder.- Specified by:
getStatusByUserName
in interfaceWorkflowedModel
- Returns:
- the status by user name of this document library folder
-
setStatusByUserName
Sets the status by user name of this document library folder.- Specified by:
setStatusByUserName
in interfaceWorkflowedModel
- 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 interfaceWorkflowedModel
- Returns:
- the status date of this document library folder
-
setStatusDate
Sets the status date of this document library folder.- Specified by:
setStatusDate
in interfaceWorkflowedModel
- 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 interfaceTrashedModel
- Returns:
- the class primary key of the trash entry for this document library folder
-
isInTrash
boolean isInTrash()Returnstrue
if this document library folder is in the Recycle Bin.- Specified by:
isInTrash
in interfaceTrashedModel
- Returns:
true
if this document library folder is in the Recycle Bin;false
otherwise
-
isApproved
boolean isApproved()Returnstrue
if this document library folder is approved.- Specified by:
isApproved
in interfaceWorkflowedModel
- Returns:
true
if this document library folder is approved;false
otherwise
-
isDenied
boolean isDenied()Returnstrue
if this document library folder is denied.- Specified by:
isDenied
in interfaceWorkflowedModel
- Returns:
true
if this document library folder is denied;false
otherwise
-
isDraft
boolean isDraft()Returnstrue
if this document library folder is a draft.- Specified by:
isDraft
in interfaceWorkflowedModel
- Returns:
true
if this document library folder is a draft;false
otherwise
-
isExpired
boolean isExpired()Returnstrue
if this document library folder is expired.- Specified by:
isExpired
in interfaceWorkflowedModel
- Returns:
true
if this document library folder is expired;false
otherwise
-
isInactive
boolean isInactive()Returnstrue
if this document library folder is inactive.- Specified by:
isInactive
in interfaceWorkflowedModel
- Returns:
true
if this document library folder is inactive;false
otherwise
-
isIncomplete
boolean isIncomplete()Returnstrue
if this document library folder is incomplete.- Specified by:
isIncomplete
in interfaceWorkflowedModel
- Returns:
true
if this document library folder is incomplete;false
otherwise
-
isPending
boolean isPending()Returnstrue
if this document library folder is pending.- Specified by:
isPending
in interfaceWorkflowedModel
- Returns:
true
if this document library folder is pending;false
otherwise
-
isScheduled
boolean isScheduled()Returnstrue
if this document library folder is scheduled.- Specified by:
isScheduled
in interfaceWorkflowedModel
- 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 interfaceContainerModel
- 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 interfaceContainerModel
- 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 interfaceContainerModel
- 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 interfaceContainerModel
- 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 interfaceContainerModel
- Parameters:
parentContainerModelId
- the parent container model ID of this document library folder
-
cloneWithOriginalValues
DLFolder cloneWithOriginalValues()- Specified by:
cloneWithOriginalValues
in interfaceBaseModel<DLFolder>
-
toXmlString
-