@ProviderType public interface DLFolderModel extends BaseModel<DLFolder>, ContainerModel, ShardedModel, StagedGroupedModel, TrashedModel, WorkflowedModel
This interface and its corresponding implementation DLFolderModelImpl
exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in DLFolderImpl
.
DLFolder
,
DLFolderImpl
,
DLFolderModelImpl
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Creates a shallow clone of this model instance.
|
int |
compareTo(DLFolder dlFolder) |
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.
|
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.
|
long |
getParentFolderId()
Returns the parent folder ID of this document library folder.
|
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.
|
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 7.0.0, 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.
|
int |
hashCode() |
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 |
isEscapedModel()
Returns
true if this model instance is escaped. |
boolean |
isExpired()
Returns
true if this document library folder is expired. |
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 |
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 |
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 |
isScheduled()
Returns
true if this document library folder is scheduled. |
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 |
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.
|
getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes
getModelClass, getModelClassName
getModelClass, getModelClassName
getStagedModelType
long getPrimaryKey()
void setPrimaryKey(long primaryKey)
primaryKey
- the primary key of this document library folder@AutoEscape String getUuid()
getUuid
in interface StagedModel
void setUuid(String uuid)
setUuid
in interface StagedModel
uuid
- the uuid of this document library folderlong getFolderId()
void setFolderId(long folderId)
folderId
- the folder ID of this document library folderlong getGroupId()
getGroupId
in interface GroupedModel
void setGroupId(long groupId)
setGroupId
in interface GroupedModel
groupId
- the group ID of this document library folderlong getCompanyId()
getCompanyId
in interface AuditedModel
getCompanyId
in interface ShardedModel
getCompanyId
in interface StagedModel
void setCompanyId(long companyId)
setCompanyId
in interface AuditedModel
setCompanyId
in interface ShardedModel
setCompanyId
in interface StagedModel
companyId
- the company ID of this document library folderlong getUserId()
getUserId
in interface AuditedModel
void setUserId(long userId)
setUserId
in interface AuditedModel
userId
- the user ID of this document library folderString getUserUuid()
getUserUuid
in interface AuditedModel
void setUserUuid(String userUuid)
setUserUuid
in interface AuditedModel
userUuid
- the user uuid of this document library folder@AutoEscape String getUserName()
getUserName
in interface AuditedModel
void setUserName(String userName)
setUserName
in interface AuditedModel
userName
- the user name of this document library folderDate getCreateDate()
getCreateDate
in interface AuditedModel
getCreateDate
in interface StagedModel
void setCreateDate(Date createDate)
setCreateDate
in interface AuditedModel
setCreateDate
in interface StagedModel
createDate
- the create date of this document library folderDate getModifiedDate()
getModifiedDate
in interface AuditedModel
getModifiedDate
in interface StagedModel
void setModifiedDate(Date modifiedDate)
setModifiedDate
in interface AuditedModel
setModifiedDate
in interface StagedModel
modifiedDate
- the modified date of this document library folderlong getRepositoryId()
void setRepositoryId(long repositoryId)
repositoryId
- the repository ID of this document library folderboolean getMountPoint()
boolean isMountPoint()
true
if this document library folder is mount point.true
if this document library folder is mount point; false
otherwisevoid setMountPoint(boolean mountPoint)
mountPoint
- the mount point of this document library folderlong getParentFolderId()
void setParentFolderId(long parentFolderId)
parentFolderId
- the parent folder ID of this document library folder@AutoEscape String getTreePath()
void setTreePath(String treePath)
treePath
- the tree path of this document library folder@AutoEscape String getName()
void setName(String name)
name
- the name of this document library folder@AutoEscape String getDescription()
void setDescription(String description)
description
- the description of this document library folderDate getLastPostDate()
void setLastPostDate(Date lastPostDate)
lastPostDate
- the last post date of this document library folderlong getDefaultFileEntryTypeId()
void setDefaultFileEntryTypeId(long defaultFileEntryTypeId)
defaultFileEntryTypeId
- the default file entry type ID of this document library folderboolean getHidden()
boolean isHidden()
true
if this document library folder is hidden.true
if this document library folder is hidden; false
otherwisevoid setHidden(boolean hidden)
hidden
- the hidden of this document library folderint getRestrictionType()
void setRestrictionType(int restrictionType)
restrictionType
- the restriction type of this document library folderDate getLastPublishDate()
getLastPublishDate
in interface StagedGroupedModel
void setLastPublishDate(Date lastPublishDate)
setLastPublishDate
in interface StagedGroupedModel
lastPublishDate
- the last publish date of this document library folderint getStatus()
getStatus
in interface TrashedModel
getStatus
in interface WorkflowedModel
void setStatus(int status)
setStatus
in interface WorkflowedModel
status
- the status of this document library folderlong getStatusByUserId()
getStatusByUserId
in interface WorkflowedModel
void setStatusByUserId(long statusByUserId)
setStatusByUserId
in interface WorkflowedModel
statusByUserId
- the status by user ID of this document library folderString getStatusByUserUuid()
getStatusByUserUuid
in interface WorkflowedModel
void setStatusByUserUuid(String statusByUserUuid)
setStatusByUserUuid
in interface WorkflowedModel
statusByUserUuid
- the status by user uuid of this document library folder@AutoEscape String getStatusByUserName()
getStatusByUserName
in interface WorkflowedModel
void setStatusByUserName(String statusByUserName)
setStatusByUserName
in interface WorkflowedModel
statusByUserName
- the status by user name of this document library folderDate getStatusDate()
getStatusDate
in interface WorkflowedModel
void setStatusDate(Date statusDate)
setStatusDate
in interface WorkflowedModel
statusDate
- the status date of this document library folderTrashEntry getTrashEntry() throws PortalException
getTrashEntry
in interface TrashedModel
PortalException
long getTrashEntryClassPK()
getTrashEntryClassPK
in interface TrashedModel
@Deprecated TrashHandler getTrashHandler()
getTrashHandler
in interface TrashedModel
boolean isInTrash()
true
if this document library folder is in the Recycle Bin.isInTrash
in interface TrashedModel
true
if this document library folder is in the Recycle Bin; false
otherwiseboolean isInTrashContainer()
true
if the parent of this document library folder is in the Recycle Bin.isInTrashContainer
in interface TrashedModel
true
if the parent of this document library folder is in the Recycle Bin; false
otherwiseboolean isInTrashExplicitly()
isInTrashExplicitly
in interface TrashedModel
boolean isInTrashImplicitly()
isInTrashImplicitly
in interface TrashedModel
boolean isApproved()
true
if this document library folder is approved.isApproved
in interface WorkflowedModel
true
if this document library folder is approved; false
otherwiseboolean isDenied()
true
if this document library folder is denied.isDenied
in interface WorkflowedModel
true
if this document library folder is denied; false
otherwiseboolean isDraft()
true
if this document library folder is a draft.isDraft
in interface WorkflowedModel
true
if this document library folder is a draft; false
otherwiseboolean isExpired()
true
if this document library folder is expired.isExpired
in interface WorkflowedModel
true
if this document library folder is expired; false
otherwiseboolean isInactive()
true
if this document library folder is inactive.isInactive
in interface WorkflowedModel
true
if this document library folder is inactive; false
otherwiseboolean isIncomplete()
true
if this document library folder is incomplete.isIncomplete
in interface WorkflowedModel
true
if this document library folder is incomplete; false
otherwiseboolean isPending()
true
if this document library folder is pending.isPending
in interface WorkflowedModel
true
if this document library folder is pending; false
otherwiseboolean isScheduled()
true
if this document library folder is scheduled.isScheduled
in interface WorkflowedModel
true
if this document library folder is scheduled; false
otherwiselong getContainerModelId()
getContainerModelId
in interface ContainerModel
void setContainerModelId(long containerModelId)
setContainerModelId
in interface ContainerModel
containerModelId
- the container model ID of this document library folderString getContainerModelName()
getContainerModelName
in interface ContainerModel
long getParentContainerModelId()
getParentContainerModelId
in interface ContainerModel
void setParentContainerModelId(long parentContainerModelId)
setParentContainerModelId
in interface ContainerModel
parentContainerModelId
- the parent container model ID of this document library folderboolean isNew()
BaseModel
true
if this model instance does not yet exist in
the database.void setNew(boolean n)
BaseModel
boolean isCachedModel()
BaseModel
true
if this model instance was retrieved from the
entity cache.isCachedModel
in interface BaseModel<DLFolder>
true
if this model instance was retrieved from the
entity cache; false
otherwiseBaseModel.setCachedModel(boolean)
void setCachedModel(boolean cachedModel)
BaseModel
setCachedModel
in interface BaseModel<DLFolder>
cachedModel
- whether this model instance was retrieved from the
entity cacheEntityCache
boolean isEscapedModel()
BaseModel
true
if this model instance is escaped.isEscapedModel
in interface BaseModel<DLFolder>
true
if this model instance is escaped;
false
otherwiseSerializable getPrimaryKeyObj()
BaseModel
getPrimaryKeyObj
in interface BaseModel<DLFolder>
getPrimaryKeyObj
in interface ClassedModel
void setPrimaryKeyObj(Serializable primaryKeyObj)
BaseModel
setPrimaryKeyObj
in interface BaseModel<DLFolder>
setPrimaryKeyObj
in interface ClassedModel
primaryKeyObj
- the primary key of this model instanceExpandoBridge getExpandoBridge()
BaseModel
getExpandoBridge
in interface BaseModel<DLFolder>
getExpandoBridge
in interface ClassedModel
void setExpandoBridgeAttributes(BaseModel<?> baseModel)
setExpandoBridgeAttributes
in interface BaseModel<DLFolder>
void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
setExpandoBridgeAttributes
in interface BaseModel<DLFolder>
void setExpandoBridgeAttributes(ServiceContext serviceContext)
BaseModel
setExpandoBridgeAttributes
in interface BaseModel<DLFolder>
serviceContext
- the service context to be appliedServiceContext.getExpandoBridgeAttributes()
Object clone()
BaseModel
clone
in interface BaseModel<DLFolder>
clone
in interface StagedModel
int compareTo(DLFolder dlFolder)
compareTo
in interface Comparable<DLFolder>
int hashCode()
hashCode
in class Object
CacheModel<DLFolder> toCacheModel()
BaseModel
toCacheModel
in interface BaseModel<DLFolder>
DLFolder toEscapedModel()
BaseModel
AutoEscapeBeanHandler
.toEscapedModel
in interface BaseModel<DLFolder>
AutoEscapeBeanHandler
DLFolder toUnescapedModel()
toUnescapedModel
in interface BaseModel<DLFolder>
String toString()
toString
in class Object
String toXmlString()
BaseModel
toXmlString
in interface BaseModel<DLFolder>