Liferay 6.2.0

com.liferay.portlet.documentlibrary.model
Interface DLFileShortcutModel

All Superinterfaces:
AuditedModel, BaseModel<DLFileShortcut>, ClassedModel, Cloneable, Comparable<DLFileShortcut>, GroupedModel, Serializable, StagedGroupedModel, StagedModel, TrashedModel, WorkflowedModel
All Known Subinterfaces:
DLFileShortcut
All Known Implementing Classes:
DLFileShortcutBaseImpl, DLFileShortcutImpl, DLFileShortcutModelImpl, DLFileShortcutWrapper

@ProviderType
public interface DLFileShortcutModel
extends BaseModel<DLFileShortcut>, 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 DLFileShortcutModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in DLFileShortcutImpl.

See Also:
DLFileShortcut, DLFileShortcutImpl, DLFileShortcutModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
abstract  Object clone()
          Creates a shallow clone of this model instance.
abstract  int compareTo(DLFileShortcut dlFileShortcut)
           
abstract  boolean getActive()
          Returns the active of this document library file shortcut.
abstract  boolean getApproved()
          Deprecated. As of 6.1.0, replaced by isApproved()
abstract  long getCompanyId()
          Returns the company ID of this document library file shortcut.
abstract  Date getCreateDate()
          Returns the create date of this document library file shortcut.
abstract  ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
abstract  long getFileShortcutId()
          Returns the file shortcut ID of this document library file shortcut.
abstract  long getFolderId()
          Returns the folder ID of this document library file shortcut.
abstract  long getGroupId()
          Returns the group ID of this document library file shortcut.
abstract  Date getModifiedDate()
          Returns the modified date of this document library file shortcut.
abstract  long getPrimaryKey()
          Returns the primary key of this document library file shortcut.
abstract  Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
abstract  long getRepositoryId()
          Returns the repository ID of this document library file shortcut.
abstract  int getStatus()
          Returns the status of this document library file shortcut.
abstract  long getStatusByUserId()
          Returns the status by user ID of this document library file shortcut.
abstract  String getStatusByUserName()
          Returns the status by user name of this document library file shortcut.
abstract  String getStatusByUserUuid()
          Returns the status by user uuid of this document library file shortcut.
abstract  Date getStatusDate()
          Returns the status date of this document library file shortcut.
abstract  long getToFileEntryId()
          Returns the to file entry ID of this document library file shortcut.
abstract  TrashEntry getTrashEntry()
          Returns the trash entry created when this document library file shortcut was moved to the Recycle Bin.
abstract  long getTrashEntryClassPK()
          Returns the class primary key of the trash entry for this document library file shortcut.
abstract  TrashHandler getTrashHandler()
          Returns the trash handler for this document library file shortcut.
abstract  String getTreePath()
          Returns the tree path of this document library file shortcut.
abstract  long getUserId()
          Returns the user ID of this document library file shortcut.
abstract  String getUserName()
          Returns the user name of this document library file shortcut.
abstract  String getUserUuid()
          Returns the user uuid of this document library file shortcut.
abstract  String getUuid()
          Returns the uuid of this document library file shortcut.
abstract  int hashCode()
           
abstract  boolean isActive()
          Returns true if this document library file shortcut is active.
abstract  boolean isApproved()
          Returns true if this document library file shortcut is approved.
abstract  boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
abstract  boolean isDenied()
          Returns true if this document library file shortcut is denied.
abstract  boolean isDraft()
          Returns true if this document library file shortcut is a draft.
abstract  boolean isEscapedModel()
          Returns true if this model instance is escaped.
abstract  boolean isExpired()
          Returns true if this document library file shortcut is expired.
abstract  boolean isInactive()
          Returns true if this document library file shortcut is inactive.
abstract  boolean isIncomplete()
          Returns true if this document library file shortcut is incomplete.
abstract  boolean isInTrash()
          Returns true if this document library file shortcut is in the Recycle Bin.
abstract  boolean isInTrashContainer()
          Returns true if the parent of this document library file shortcut is in the Recycle Bin.
abstract  boolean isNew()
          Returns true if this model instance does not yet exist in the database.
abstract  boolean isPending()
          Returns true if this document library file shortcut is pending.
abstract  boolean isScheduled()
          Returns true if this document library file shortcut is scheduled.
abstract  void setActive(boolean active)
          Sets whether this document library file shortcut is active.
abstract  void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
abstract  void setCompanyId(long companyId)
          Sets the company ID of this document library file shortcut.
abstract  void setCreateDate(Date createDate)
          Sets the create date of this document library file shortcut.
abstract  void setExpandoBridgeAttributes(BaseModel<?> baseModel)
           
abstract  void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
           
abstract  void setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
abstract  void setFileShortcutId(long fileShortcutId)
          Sets the file shortcut ID of this document library file shortcut.
abstract  void setFolderId(long folderId)
          Sets the folder ID of this document library file shortcut.
abstract  void setGroupId(long groupId)
          Sets the group ID of this document library file shortcut.
abstract  void setModifiedDate(Date modifiedDate)
          Sets the modified date of this document library file shortcut.
abstract  void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
abstract  void setPrimaryKey(long primaryKey)
          Sets the primary key of this document library file shortcut.
abstract  void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
abstract  void setRepositoryId(long repositoryId)
          Sets the repository ID of this document library file shortcut.
abstract  void setStatus(int status)
          Sets the status of this document library file shortcut.
abstract  void setStatusByUserId(long statusByUserId)
          Sets the status by user ID of this document library file shortcut.
abstract  void setStatusByUserName(String statusByUserName)
          Sets the status by user name of this document library file shortcut.
abstract  void setStatusByUserUuid(String statusByUserUuid)
          Sets the status by user uuid of this document library file shortcut.
abstract  void setStatusDate(Date statusDate)
          Sets the status date of this document library file shortcut.
abstract  void setToFileEntryId(long toFileEntryId)
          Sets the to file entry ID of this document library file shortcut.
abstract  void setTreePath(String treePath)
          Sets the tree path of this document library file shortcut.
abstract  void setUserId(long userId)
          Sets the user ID of this document library file shortcut.
abstract  void setUserName(String userName)
          Sets the user name of this document library file shortcut.
abstract  void setUserUuid(String userUuid)
          Sets the user uuid of this document library file shortcut.
abstract  void setUuid(String uuid)
          Sets the uuid of this document library file shortcut.
abstract  CacheModel<DLFileShortcut> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
abstract  DLFileShortcut toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
abstract  String toString()
           
abstract  DLFileShortcut toUnescapedModel()
           
abstract  String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from interface com.liferay.portal.model.BaseModel
getModelAttributes, resetOriginalValues, setModelAttributes
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 
Methods inherited from interface com.liferay.portal.model.StagedModel
getStagedModelType
 

Method Detail

getPrimaryKey

long getPrimaryKey()
Returns the primary key of this document library file shortcut.

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.

Parameters:
primaryKey - the primary key 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 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 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()
                   throws SystemException
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
Throws:
SystemException - if a system exception occurred

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

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()
                           throws SystemException
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
Throws:
SystemException - if a system exception occurred

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,
                                SystemException
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:
SystemException - if a system exception occurred
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

TrashHandler getTrashHandler()
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
Throws:
SystemException - if a system exception occurred

getApproved

boolean getApproved()
Deprecated. As of 6.1.0, replaced by isApproved()

Specified by:
getApproved in interface WorkflowedModel

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

isNew

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 BaseModel<DLFileShortcut>
Returns:
true if this model instance does not yet exist in the database; false otherwise

setNew

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 BaseModel<DLFileShortcut>
Parameters:
n - whether this model instance does not yet exist in the database

isCachedModel

boolean isCachedModel()
Description copied from interface: BaseModel
Returns true if this model instance was retrieved from the entity cache.

Specified by:
isCachedModel in interface BaseModel<DLFileShortcut>
Returns:
true if this model instance was retrieved from the entity cache; false otherwise
See Also:
BaseModel.setCachedModel(boolean)

setCachedModel

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 BaseModel<DLFileShortcut>
Parameters:
cachedModel - whether this model instance was retrieved from the entity cache
See Also:
EntityCache

isEscapedModel

boolean isEscapedModel()
Description copied from interface: BaseModel
Returns true if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<DLFileShortcut>
Returns:
true if this model instance is escaped; false otherwise

getPrimaryKeyObj

Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Returns the primary key of this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<DLFileShortcut>
Specified by:
getPrimaryKeyObj in interface ClassedModel
Returns:
the primary key of this model instance

setPrimaryKeyObj

void setPrimaryKeyObj(Serializable primaryKeyObj)
Description copied from interface: BaseModel
Sets the primary key of this model instance.

Specified by:
setPrimaryKeyObj in interface BaseModel<DLFileShortcut>
Specified by:
setPrimaryKeyObj in interface ClassedModel
Parameters:
primaryKeyObj - the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()
Description copied from interface: BaseModel
Returns the expando bridge for this model instance.

Specified by:
getExpandoBridge in interface BaseModel<DLFileShortcut>
Specified by:
getExpandoBridge in interface ClassedModel
Returns:
the expando bridge for this model instance

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(BaseModel<?> baseModel)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<DLFileShortcut>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<DLFileShortcut>

setExpandoBridgeAttributes

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 BaseModel<DLFileShortcut>
Parameters:
serviceContext - the service context to be applied
See Also:
ServiceContext.getExpandoBridgeAttributes( )

clone

Object clone()
Description copied from interface: BaseModel
Creates a shallow clone of this model instance.

Specified by:
clone in interface BaseModel<DLFileShortcut>
Specified by:
clone in interface StagedModel
Returns:
the shallow clone of this model instance

compareTo

int compareTo(DLFileShortcut dlFileShortcut)
Specified by:
compareTo in interface Comparable<DLFileShortcut>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

CacheModel<DLFileShortcut> toCacheModel()
Description copied from interface: BaseModel
Returns a cache model object for this entity used by entity cache.

Specified by:
toCacheModel in interface BaseModel<DLFileShortcut>
Returns:
the cache model object

toEscapedModel

DLFileShortcut 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 BaseModel<DLFileShortcut>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

DLFileShortcut toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<DLFileShortcut>

toString

String toString()
Overrides:
toString in class Object

toXmlString

String toXmlString()
Description copied from interface: BaseModel
Returns the XML representation of this model instance.

Specified by:
toXmlString in interface BaseModel<DLFileShortcut>
Returns:
the XML representation of this model instance

Liferay 6.2.0