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 TypeMethodDescriptionlongReturns the company ID of this document library folder.longReturns 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.longReturns the ct collection ID of this document library folder.longReturns 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.longReturns the folder ID of this document library folder.longReturns the group ID of this document library folder.booleanReturns 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.booleanReturns the mount point of this document library folder.longReturns the mvcc version of this document library folder.getName()Returns the name of this document library folder.longReturns the parent container model ID of this document library folder.longReturns the parent folder ID of this document library folder.longReturns the primary key of this document library folder.longReturns the repository ID of this document library folder.intReturns the restriction type of this document library folder.intReturns the status of this document library folder.longReturns 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.longReturns the class primary key of the trash entry for this document library folder.Returns the tree path of this document library folder.longReturns 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.booleanReturnstrueif this document library folder is approved.booleanisDenied()Returnstrueif this document library folder is denied.booleanisDraft()Returnstrueif this document library folder is a draft.booleanReturnstrueif this document library folder is expired.booleanisHidden()Returnstrueif this document library folder is hidden.booleanReturnstrueif this document library folder is inactive.booleanReturnstrueif this document library folder is incomplete.booleanReturnstrueif this document library folder is in the Recycle Bin.booleanReturnstrueif this document library folder is mount point.booleanReturnstrueif this document library folder is pending.booleanReturnstrueif this document library folder is scheduled.voidsetCompanyId(long companyId) Sets the company ID of this document library folder.voidsetContainerModelId(long containerModelId) Sets the container model ID of this document library folder.voidsetCreateDate(Date createDate) Sets the create date of this document library folder.voidsetCtCollectionId(long ctCollectionId) Sets the ct collection ID of this document library folder.voidsetDefaultFileEntryTypeId(long defaultFileEntryTypeId) Sets the default file entry type ID of this document library folder.voidsetDescription(String description) Sets the description of this document library folder.voidsetExternalReferenceCode(String externalReferenceCode) Sets the external reference code of this document library folder.voidsetFolderId(long folderId) Sets the folder ID of this document library folder.voidsetGroupId(long groupId) Sets the group ID of this document library folder.voidsetHidden(boolean hidden) Sets whether this document library folder is hidden.voidsetLastPostDate(Date lastPostDate) Sets the last post date of this document library folder.voidsetLastPublishDate(Date lastPublishDate) Sets the last publish date of this document library folder.voidsetModifiedDate(Date modifiedDate) Sets the modified date of this document library folder.voidsetMountPoint(boolean mountPoint) Sets whether this document library folder is mount point.voidsetMvccVersion(long mvccVersion) Sets the mvcc version of this document library folder.voidSets the name of this document library folder.voidsetParentContainerModelId(long parentContainerModelId) Sets the parent container model ID of this document library folder.voidsetParentFolderId(long parentFolderId) Sets the parent folder ID of this document library folder.voidsetPrimaryKey(long primaryKey) Sets the primary key of this document library folder.voidsetRepositoryId(long repositoryId) Sets the repository ID of this document library folder.voidsetRestrictionType(int restrictionType) Sets the restriction type of this document library folder.voidsetStatus(int status) Sets the status of this document library folder.voidsetStatusByUserId(long statusByUserId) Sets the status by user ID of this document library folder.voidsetStatusByUserName(String statusByUserName) Sets the status by user name of this document library folder.voidsetStatusByUserUuid(String statusByUserUuid) Sets the status by user uuid of this document library folder.voidsetStatusDate(Date statusDate) Sets the status date of this document library folder.voidsetTreePath(String treePath) Sets the tree path of this document library folder.voidsetUserId(long userId) Sets the user ID of this document library folder.voidsetUserName(String userName) Sets the user name of this document library folder.voidsetUserUuid(String userUuid) Sets the user uuid of this document library folder.voidSets the uuid of this document library folder.default StringMethods 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, toUnescapedModelMethods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassNameMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface com.liferay.portal.kernel.model.ContainerModel
getModelClass, getModelClassNameMethods 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:
getPrimaryKeyin 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:
setPrimaryKeyin 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:
getMvccVersionin 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:
setMvccVersionin 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:
getCtCollectionIdin 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:
setCtCollectionIdin interfaceCTModel<DLFolder>- Parameters:
ctCollectionId- the ct collection ID of this document library folder
-
getUuid
Returns the uuid of this document library folder.- Specified by:
getUuidin interfaceStagedModel- Returns:
- the uuid of this document library folder
-
setUuid
Sets the uuid of this document library folder.- Specified by:
setUuidin interfaceStagedModel- Parameters:
uuid- the uuid of this document library folder
-
getExternalReferenceCode
Returns the external reference code of this document library folder.- Specified by:
getExternalReferenceCodein interfaceExternalReferenceCodeModel- Returns:
- the external reference code of this document library folder
-
setExternalReferenceCode
Sets the external reference code of this document library folder.- Specified by:
setExternalReferenceCodein 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:
getGroupIdin 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:
setGroupIdin 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:
getCompanyIdin interfaceAuditedModel- Specified by:
getCompanyIdin interfaceShardedModel- Specified by:
getCompanyIdin 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:
setCompanyIdin interfaceAuditedModel- Specified by:
setCompanyIdin interfaceShardedModel- Specified by:
setCompanyIdin 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:
getUserIdin 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:
setUserIdin 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:
getUserUuidin interfaceAuditedModel- Returns:
- the user uuid of this document library folder
-
setUserUuid
Sets the user uuid of this document library folder.- Specified by:
setUserUuidin interfaceAuditedModel- Parameters:
userUuid- the user uuid of this document library folder
-
getUserName
Returns the user name of this document library folder.- Specified by:
getUserNamein interfaceAuditedModel- Returns:
- the user name of this document library folder
-
setUserName
Sets the user name of this document library folder.- Specified by:
setUserNamein 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:
getCreateDatein interfaceAuditedModel- Specified by:
getCreateDatein interfaceStagedModel- Returns:
- the create date of this document library folder
-
setCreateDate
Sets the create date of this document library folder.- Specified by:
setCreateDatein interfaceAuditedModel- Specified by:
setCreateDatein 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:
getModifiedDatein interfaceAuditedModel- Specified by:
getModifiedDatein interfaceStagedModel- Returns:
- the modified date of this document library folder
-
setModifiedDate
Sets the modified date of this document library folder.- Specified by:
setModifiedDatein interfaceAuditedModel- Specified by:
setModifiedDatein 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()Returnstrueif this document library folder is mount point.- Returns:
trueif this document library folder is mount point;falseotherwise
-
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()Returnstrueif this document library folder is hidden.- Returns:
trueif this document library folder is hidden;falseotherwise
-
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:
getLastPublishDatein interfaceStagedGroupedModel- Returns:
- the last publish date of this document library folder
-
setLastPublishDate
Sets the last publish date of this document library folder.- Specified by:
setLastPublishDatein 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:
getStatusin interfaceTrashedModel- Specified by:
getStatusin interfaceWorkflowedModel- Returns:
- the status of this document library folder
-
setStatus
void setStatus(int status) Sets the status of this document library folder.- Specified by:
setStatusin 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:
getStatusByUserIdin 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:
setStatusByUserIdin 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:
getStatusByUserUuidin 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:
setStatusByUserUuidin 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:
getStatusByUserNamein 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:
setStatusByUserNamein 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:
getStatusDatein interfaceWorkflowedModel- Returns:
- the status date of this document library folder
-
setStatusDate
Sets the status date of this document library folder.- Specified by:
setStatusDatein 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:
getTrashEntryClassPKin interfaceTrashedModel- Returns:
- the class primary key of the trash entry for this document library folder
-
isInTrash
boolean isInTrash()Returnstrueif this document library folder is in the Recycle Bin.- Specified by:
isInTrashin interfaceTrashedModel- Returns:
trueif this document library folder is in the Recycle Bin;falseotherwise
-
isApproved
boolean isApproved()Returnstrueif this document library folder is approved.- Specified by:
isApprovedin interfaceWorkflowedModel- Returns:
trueif this document library folder is approved;falseotherwise
-
isDenied
boolean isDenied()Returnstrueif this document library folder is denied.- Specified by:
isDeniedin interfaceWorkflowedModel- Returns:
trueif this document library folder is denied;falseotherwise
-
isDraft
boolean isDraft()Returnstrueif this document library folder is a draft.- Specified by:
isDraftin interfaceWorkflowedModel- Returns:
trueif this document library folder is a draft;falseotherwise
-
isExpired
boolean isExpired()Returnstrueif this document library folder is expired.- Specified by:
isExpiredin interfaceWorkflowedModel- Returns:
trueif this document library folder is expired;falseotherwise
-
isInactive
boolean isInactive()Returnstrueif this document library folder is inactive.- Specified by:
isInactivein interfaceWorkflowedModel- Returns:
trueif this document library folder is inactive;falseotherwise
-
isIncomplete
boolean isIncomplete()Returnstrueif this document library folder is incomplete.- Specified by:
isIncompletein interfaceWorkflowedModel- Returns:
trueif this document library folder is incomplete;falseotherwise
-
isPending
boolean isPending()Returnstrueif this document library folder is pending.- Specified by:
isPendingin interfaceWorkflowedModel- Returns:
trueif this document library folder is pending;falseotherwise
-
isScheduled
boolean isScheduled()Returnstrueif this document library folder is scheduled.- Specified by:
isScheduledin interfaceWorkflowedModel- Returns:
trueif this document library folder is scheduled;falseotherwise
-
getContainerModelId
long getContainerModelId()Returns the container model ID of this document library folder.- Specified by:
getContainerModelIdin 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:
setContainerModelIdin 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:
getContainerModelNamein 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:
getParentContainerModelIdin 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:
setParentContainerModelIdin interfaceContainerModel- Parameters:
parentContainerModelId- the parent container model ID of this document library folder
-
cloneWithOriginalValues
DLFolder cloneWithOriginalValues()- Specified by:
cloneWithOriginalValuesin interfaceBaseModel<DLFolder>
-
toXmlString
-