com.liferay.document.library.kernel.model

Interface DLFileShortcutModel

All Superinterfaces:

AuditedModel, BaseModel<DLFileShortcut>, ClassedModel, Cloneable, Comparable<DLFileShortcut>, CTModel<DLFileShortcut>, GroupedModel, MVCCModel, Serializable, ShardedModel, StagedGroupedModel, StagedModel, TrashedModel, WorkflowedModel

All Known Subinterfaces:

DLFileShortcut

All Known Implementing Classes:

DLFileShortcutWrapper

@ProviderType
public interface DLFileShortcutModel
extends BaseModel<DLFileShortcut>, CTModel<DLFileShortcut>, MVCCModel, ShardedModel, StagedGroupedModel, TrashedModel, WorkflowedModel

The base model interface for the DLFileShortcut service. Represents a row in the "DLFileShortcut" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation com.liferay.portlet.documentlibrary.model.impl.DLFileShortcutModelImpl 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.DLFileShortcutImpl.

Author:

Brian Wing Shun Chan

See Also:

DLFileShortcut

{$generated.description}

Method Summary

Modifier and Type	Method and Description
boolean	getActive() Returns the active of this document library file shortcut.
long	getCompanyId() Returns the company ID of this document library file shortcut.
Date	getCreateDate() Returns the create date of this document library file shortcut.
long	getCtCollectionId() Returns the ct collection ID of this document library file shortcut.
long	getFileShortcutId() Returns the file shortcut ID of this document library file shortcut.
long	getFolderId() Returns the folder ID of this document library file shortcut.
long	getGroupId() Returns the group ID of this document library file shortcut.
Date	getLastPublishDate() Returns the last publish date of this document library file shortcut.
Date	getModifiedDate() Returns the modified date of this document library file shortcut.
long	getMvccVersion() Returns the mvcc version of this document library file shortcut.
long	getPrimaryKey() Returns the primary key of this document library file shortcut.
long	getRepositoryId() Returns the repository ID of this document library file shortcut.
int	getStatus() Returns the status of this document library file shortcut.
long	getStatusByUserId() Returns the status by user ID of this document library file shortcut.
String	getStatusByUserName() Returns the status by user name of this document library file shortcut.
String	getStatusByUserUuid() Returns the status by user uuid of this document library file shortcut.
Date	getStatusDate() Returns the status date of this document library file shortcut.
long	getToFileEntryId() Returns the to file entry ID of this document library file shortcut.
TrashEntry	getTrashEntry() Returns the trash entry created when this document library file shortcut was moved to the Recycle Bin.
long	getTrashEntryClassPK() Returns the class primary key of the trash entry for this document library file shortcut.
TrashHandler	getTrashHandler() Deprecated. As of Judson (7.1.x), with no direct replacement
String	getTreePath() Returns the tree path of this document library file shortcut.
long	getUserId() Returns the user ID of this document library file shortcut.
String	getUserName() Returns the user name of this document library file shortcut.
String	getUserUuid() Returns the user uuid of this document library file shortcut.
String	getUuid() Returns the uuid of this document library file shortcut.
boolean	isActive() Returns true if this document library file shortcut is active.
boolean	isApproved() Returns true if this document library file shortcut is approved.
boolean	isDenied() Returns true if this document library file shortcut is denied.
boolean	isDraft() Returns true if this document library file shortcut is a draft.
boolean	isExpired() Returns true if this document library file shortcut is expired.
boolean	isInactive() Returns true if this document library file shortcut is inactive.
boolean	isIncomplete() Returns true if this document library file shortcut is incomplete.
boolean	isInTrash() Returns true if this document library file shortcut is in the Recycle Bin.
boolean	isInTrashContainer() Returns true if the parent of this document library file shortcut is in the Recycle Bin.
boolean	isInTrashExplicitly()
boolean	isInTrashImplicitly()
boolean	isPending() Returns true if this document library file shortcut is pending.
boolean	isScheduled() Returns true if this document library file shortcut is scheduled.
void	setActive(boolean active) Sets whether this document library file shortcut is active.
void	setCompanyId(long companyId) Sets the company ID of this document library file shortcut.
void	setCreateDate(Date createDate) Sets the create date of this document library file shortcut.
void	setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this document library file shortcut.
void	setFileShortcutId(long fileShortcutId) Sets the file shortcut ID of this document library file shortcut.
void	setFolderId(long folderId) Sets the folder ID of this document library file shortcut.
void	setGroupId(long groupId) Sets the group ID of this document library file shortcut.
void	setLastPublishDate(Date lastPublishDate) Sets the last publish date of this document library file shortcut.
void	setModifiedDate(Date modifiedDate) Sets the modified date of this document library file shortcut.
void	setMvccVersion(long mvccVersion) Sets the mvcc version of this document library file shortcut.
void	setPrimaryKey(long primaryKey) Sets the primary key of this document library file shortcut.
void	setRepositoryId(long repositoryId) Sets the repository ID of this document library file shortcut.
void	setStatus(int status) Sets the status of this document library file shortcut.
void	setStatusByUserId(long statusByUserId) Sets the status by user ID of this document library file shortcut.
void	setStatusByUserName(String statusByUserName) Sets the status by user name of this document library file shortcut.
void	setStatusByUserUuid(String statusByUserUuid) Sets the status by user uuid of this document library file shortcut.
void	setStatusDate(Date statusDate) Sets the status date of this document library file shortcut.
void	setToFileEntryId(long toFileEntryId) Sets the to file entry ID of this document library file shortcut.
void	setTreePath(String treePath) Sets the tree path of this document library file shortcut.
void	setUserId(long userId) Sets the user ID of this document library file shortcut.
void	setUserName(String userName) Sets the user name of this document library file shortcut.
void	setUserUuid(String userUuid) Sets the user uuid of this document library file shortcut.
void	setUuid(String uuid) Sets the uuid of this document library file shortcut.

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, toXmlString

Methods inherited from interface Comparable

compareTo

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

getModelClass, getModelClassName

Methods inherited from interface com.liferay.portal.kernel.model.StagedModel

clone, getStagedModelType

Method Detail

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this document library file shortcut.

Specified by:

getPrimaryKey in interface CTModel<DLFileShortcut>

Returns:

the primary key of this document library file shortcut

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this document library file shortcut.

Specified by:

setPrimaryKey in interface CTModel<DLFileShortcut>

Parameters:

primaryKey - the primary key of this document library file shortcut

getMvccVersion

long getMvccVersion()

Returns the mvcc version of this document library file shortcut.

Specified by:

getMvccVersion in interface MVCCModel

Returns:

the mvcc version of this document library file shortcut

setMvccVersion

void setMvccVersion(long mvccVersion)

Sets the mvcc version of this document library file shortcut.

Specified by:

setMvccVersion in interface MVCCModel

Parameters:

mvccVersion - the mvcc version of this document library file shortcut

getCtCollectionId

long getCtCollectionId()

Returns the ct collection ID of this document library file shortcut.

Specified by:

getCtCollectionId in interface CTModel<DLFileShortcut>

Returns:

the ct collection ID of this document library file shortcut

setCtCollectionId

void setCtCollectionId(long ctCollectionId)

Sets the ct collection ID of this document library file shortcut.

Specified by:

setCtCollectionId in interface CTModel<DLFileShortcut>

Parameters:

ctCollectionId - the ct collection ID of this document library file shortcut

getUuid

@AutoEscape
String getUuid()

Returns the uuid of this document library file shortcut.

Specified by:

getUuid in interface StagedModel

Returns:

the uuid of this document library file shortcut

setUuid

void setUuid(String uuid)

Sets the uuid of this document library file shortcut.

Specified by:

setUuid in interface StagedModel

Parameters:

uuid - the uuid of this document library file shortcut

getFileShortcutId

long getFileShortcutId()

Returns the file shortcut ID of this document library file shortcut.

Returns:

the file shortcut ID of this document library file shortcut

setFileShortcutId

void setFileShortcutId(long fileShortcutId)

Sets the file shortcut ID of this document library file shortcut.

Parameters:

fileShortcutId - the file shortcut ID of this document library file shortcut

getGroupId

long getGroupId()

Returns the group ID of this document library file shortcut.

Specified by:

getGroupId in interface GroupedModel

Returns:

the group ID of this document library file shortcut

setGroupId

void setGroupId(long groupId)

Sets the group ID of this document library file shortcut.

Specified by:

setGroupId in interface GroupedModel

Parameters:

groupId - the group ID of this document library file shortcut

getCompanyId

long getCompanyId()

Returns the company ID of this document library file shortcut.

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 file shortcut

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this document library file shortcut.

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 file shortcut

getUserId

long getUserId()

Returns the user ID of this document library file shortcut.

Specified by:

getUserId in interface AuditedModel

Returns:

the user ID of this document library file shortcut

setUserId

void setUserId(long userId)

Sets the user ID of this document library file shortcut.

Specified by:

setUserId in interface AuditedModel

Parameters:

userId - the user ID of this document library file shortcut

getUserUuid

String getUserUuid()

Returns the user uuid of this document library file shortcut.

Specified by:

getUserUuid in interface AuditedModel

Returns:

the user uuid of this document library file shortcut

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this document library file shortcut.

Specified by:

setUserUuid in interface AuditedModel

Parameters:

userUuid - the user uuid of this document library file shortcut

getUserName

@AutoEscape
String getUserName()

Returns the user name of this document library file shortcut.

Specified by:

getUserName in interface AuditedModel

Returns:

the user name of this document library file shortcut

setUserName

void setUserName(String userName)

Sets the user name of this document library file shortcut.

Specified by:

setUserName in interface AuditedModel

Parameters:

userName - the user name of this document library file shortcut

getCreateDate

Date getCreateDate()

Returns the create date of this document library file shortcut.

Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface StagedModel

Returns:

the create date of this document library file shortcut

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this document library file shortcut.

Specified by:

setCreateDate in interface AuditedModel

Specified by:

setCreateDate in interface StagedModel

Parameters:

createDate - the create date of this document library file shortcut

getModifiedDate

Date getModifiedDate()

Returns the modified date of this document library file shortcut.

Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface StagedModel

Returns:

the modified date of this document library file shortcut

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this document library file shortcut.

Specified by:

setModifiedDate in interface AuditedModel

Specified by:

setModifiedDate in interface StagedModel

Parameters:

modifiedDate - the modified date of this document library file shortcut

getRepositoryId

long getRepositoryId()

Returns the repository ID of this document library file shortcut.

Returns:

the repository ID of this document library file shortcut

setRepositoryId

void setRepositoryId(long repositoryId)

Sets the repository ID of this document library file shortcut.

Parameters:

repositoryId - the repository ID of this document library file shortcut

getFolderId

long getFolderId()

Returns the folder ID of this document library file shortcut.

Returns:

the folder ID of this document library file shortcut

setFolderId

void setFolderId(long folderId)

Sets the folder ID of this document library file shortcut.

Parameters:

folderId - the folder ID of this document library file shortcut

getToFileEntryId

long getToFileEntryId()

Returns the to file entry ID of this document library file shortcut.

Returns:

the to file entry ID of this document library file shortcut

setToFileEntryId

void setToFileEntryId(long toFileEntryId)

Sets the to file entry ID of this document library file shortcut.

Parameters:

toFileEntryId - the to file entry ID of this document library file shortcut

getTreePath

@AutoEscape
String getTreePath()

Returns the tree path of this document library file shortcut.

Returns:

the tree path of this document library file shortcut

setTreePath

void setTreePath(String treePath)

Sets the tree path of this document library file shortcut.

Parameters:

treePath - the tree path of this document library file shortcut

getActive

boolean getActive()

Returns the active of this document library file shortcut.

Returns:

the active of this document library file shortcut

isActive

boolean isActive()

Returns true if this document library file shortcut is active.

Returns:

true if this document library file shortcut is active; false otherwise

setActive

void setActive(boolean active)

Sets whether this document library file shortcut is active.

Parameters:

active - the active of this document library file shortcut

getLastPublishDate

Date getLastPublishDate()

Returns the last publish date of this document library file shortcut.

Specified by:

getLastPublishDate in interface StagedGroupedModel

Returns:

the last publish date of this document library file shortcut

setLastPublishDate

void setLastPublishDate(Date lastPublishDate)

Sets the last publish date of this document library file shortcut.

Specified by:

setLastPublishDate in interface StagedGroupedModel

Parameters:

lastPublishDate - the last publish date of this document library file shortcut

getStatus

int getStatus()

Returns the status of this document library file shortcut.

Specified by:

getStatus in interface TrashedModel

Specified by:

getStatus in interface WorkflowedModel

Returns:

the status of this document library file shortcut

setStatus

void setStatus(int status)

Sets the status of this document library file shortcut.

Specified by:

setStatus in interface WorkflowedModel

Parameters:

status - the status of this document library file shortcut

getStatusByUserId

long getStatusByUserId()

Returns the status by user ID of this document library file shortcut.

Specified by:

getStatusByUserId in interface WorkflowedModel

Returns:

the status by user ID of this document library file shortcut

setStatusByUserId

void setStatusByUserId(long statusByUserId)

Sets the status by user ID of this document library file shortcut.

Specified by:

setStatusByUserId in interface WorkflowedModel

Parameters:

statusByUserId - the status by user ID of this document library file shortcut

getStatusByUserUuid

String getStatusByUserUuid()

Returns the status by user uuid of this document library file shortcut.

Specified by:

getStatusByUserUuid in interface WorkflowedModel

Returns:

the status by user uuid of this document library file shortcut

setStatusByUserUuid

void setStatusByUserUuid(String statusByUserUuid)

Sets the status by user uuid of this document library file shortcut.

Specified by:

setStatusByUserUuid in interface WorkflowedModel

Parameters:

statusByUserUuid - the status by user uuid of this document library file shortcut

getStatusByUserName

@AutoEscape
String getStatusByUserName()

Returns the status by user name of this document library file shortcut.

Specified by:

getStatusByUserName in interface WorkflowedModel

Returns:

the status by user name of this document library file shortcut

setStatusByUserName

void setStatusByUserName(String statusByUserName)

Sets the status by user name of this document library file shortcut.

Specified by:

setStatusByUserName in interface WorkflowedModel

Parameters:

statusByUserName - the status by user name of this document library file shortcut

getStatusDate

Date getStatusDate()

Returns the status date of this document library file shortcut.

Specified by:

getStatusDate in interface WorkflowedModel

Returns:

the status date of this document library file shortcut

setStatusDate

void setStatusDate(Date statusDate)

Sets the status date of this document library file shortcut.

Specified by:

setStatusDate in interface WorkflowedModel

Parameters:

statusDate - the status date of this document library file shortcut

getTrashEntry

TrashEntry getTrashEntry()
                  throws PortalException

Returns the trash entry created when this document library file shortcut was moved to the Recycle Bin. The trash entry may belong to one of the ancestors of this document library file shortcut.

Specified by:

getTrashEntry in interface TrashedModel

Returns:

the trash entry created when this document library file shortcut was moved to the Recycle Bin

Throws:

PortalException

getTrashEntryClassPK

long getTrashEntryClassPK()

Returns the class primary key of the trash entry for this document library file shortcut.

Specified by:

getTrashEntryClassPK in interface TrashedModel

Returns:

the class primary key of the trash entry for this document library file shortcut

getTrashHandler

@Deprecated
TrashHandler getTrashHandler()

Deprecated. As of Judson (7.1.x), with no direct replacement

Returns the trash handler for this document library file shortcut.

Specified by:

getTrashHandler in interface TrashedModel

Returns:

the trash handler for this document library file shortcut

isInTrash

boolean isInTrash()

Returns true if this document library file shortcut is in the Recycle Bin.

Specified by:

isInTrash in interface TrashedModel

Returns:

true if this document library file shortcut is in the Recycle Bin; false otherwise

isInTrashContainer

boolean isInTrashContainer()

Returns true if the parent of this document library file shortcut is in the Recycle Bin.

Specified by:

isInTrashContainer in interface TrashedModel

Returns:

true if the parent of this document library file shortcut is in the Recycle Bin; false otherwise

isInTrashExplicitly

boolean isInTrashExplicitly()

Specified by:

isInTrashExplicitly in interface TrashedModel

isInTrashImplicitly

boolean isInTrashImplicitly()

Specified by:

isInTrashImplicitly in interface TrashedModel

isApproved

boolean isApproved()

Returns true if this document library file shortcut is approved.

Specified by:

isApproved in interface WorkflowedModel

Returns:

true if this document library file shortcut is approved; false otherwise

isDenied

boolean isDenied()

Returns true if this document library file shortcut is denied.

Specified by:

isDenied in interface WorkflowedModel

Returns:

true if this document library file shortcut is denied; false otherwise

isDraft

boolean isDraft()

Returns true if this document library file shortcut is a draft.

Specified by:

isDraft in interface WorkflowedModel

Returns:

true if this document library file shortcut is a draft; false otherwise

isExpired

boolean isExpired()

Returns true if this document library file shortcut is expired.

Specified by:

isExpired in interface WorkflowedModel

Returns:

true if this document library file shortcut is expired; false otherwise

isInactive

boolean isInactive()

Returns true if this document library file shortcut is inactive.

Specified by:

isInactive in interface WorkflowedModel

Returns:

true if this document library file shortcut is inactive; false otherwise

isIncomplete

boolean isIncomplete()

Returns true if this document library file shortcut is incomplete.

Specified by:

isIncomplete in interface WorkflowedModel

Returns:

true if this document library file shortcut is incomplete; false otherwise

isPending

boolean isPending()

Returns true if this document library file shortcut is pending.

Specified by:

isPending in interface WorkflowedModel

Returns:

true if this document library file shortcut is pending; false otherwise

isScheduled

boolean isScheduled()

Returns true if this document library file shortcut is scheduled.

Specified by:

isScheduled in interface WorkflowedModel

Returns:

true if this document library file shortcut is scheduled; false otherwise