Liferay 6.0-ee-sp2

com.liferay.portlet.documentlibrary.model
Interface DLFileShortcutModel

All Superinterfaces:
AuditedModel, BaseModel<DLFileShortcut>, ClassedModel, Cloneable, Comparable<DLFileShortcut>, GroupedModel, Serializable, WorkflowedModel
All Known Subinterfaces:
DLFileShortcut
All Known Implementing Classes:
DLFileShortcutWrapper

public interface DLFileShortcutModel
extends BaseModel<DLFileShortcut>, GroupedModel, 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

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(DLFileShortcut dlFileShortcut)
           
 boolean getApproved()
          Deprecated. isApproved()
 long getCompanyId()
          Gets the company ID of this d l file shortcut.
 Date getCreateDate()
          Gets the create date of this d l file shortcut.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 long getFileShortcutId()
          Gets the file shortcut ID of this d l file shortcut.
 long getFolderId()
          Gets the folder ID of this d l file shortcut.
 long getGroupId()
          Gets the group ID of this d l file shortcut.
 Date getModifiedDate()
          Gets the modified date of this d l file shortcut.
 long getPrimaryKey()
          Gets the primary key of this d l file shortcut.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 int getStatus()
          Gets the status of this d l file shortcut.
 long getStatusByUserId()
          Gets the status by user ID of this d l file shortcut.
 String getStatusByUserName()
          Gets the status by user name of this d l file shortcut.
 String getStatusByUserUuid()
          Gets the status by user uuid of this d l file shortcut.
 Date getStatusDate()
          Gets the status date of this d l file shortcut.
 long getToFileEntryId()
          Gets the to file entry ID of this d l file shortcut.
 long getUserId()
          Gets the user ID of this d l file shortcut.
 String getUserName()
          Gets the user name of this d l file shortcut.
 String getUserUuid()
          Gets the user uuid of this d l file shortcut.
 String getUuid()
          Gets the uuid of this d l file shortcut.
 int hashCode()
           
 boolean isApproved()
          Determines if this d l file shortcut is approved.
 boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
 boolean isDraft()
          Determines if this d l file shortcut is a draft.
 boolean isEscapedModel()
          Returns true if this model instance is escaped.
 boolean isExpired()
          Determines if this d l file shortcut is expired.
 boolean isNew()
          Returns true if this model instance does not yet exist in the database.
 boolean isPending()
          Determines if this d l file shortcut is pending.
 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 d l file shortcut.
 void setCreateDate(Date createDate)
          Sets the create date of this d l file shortcut.
 void setEscapedModel(boolean escapedModel)
          Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.
 void setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
 void setFileShortcutId(long fileShortcutId)
          Sets the file shortcut ID of this d l file shortcut.
 void setFolderId(long folderId)
          Sets the folder ID of this d l file shortcut.
 void setGroupId(long groupId)
          Sets the group ID of this d l file shortcut.
 void setModifiedDate(Date modifiedDate)
          Sets the modified date of this d l file shortcut.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setPrimaryKey(long primaryKey)
          Sets the primary key of this d l file shortcut
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setStatus(int status)
          Sets the status of this d l file shortcut.
 void setStatusByUserId(long statusByUserId)
          Sets the status by user ID of this d l file shortcut.
 void setStatusByUserName(String statusByUserName)
          Sets the status by user name of this d l file shortcut.
 void setStatusByUserUuid(String statusByUserUuid)
          Sets the status by user uuid of this d l file shortcut.
 void setStatusDate(Date statusDate)
          Sets the status date of this d l file shortcut.
 void setToFileEntryId(long toFileEntryId)
          Sets the to file entry ID of this d l file shortcut.
 void setUserId(long userId)
          Sets the user ID of this d l file shortcut.
 void setUserName(String userName)
          Sets the user name of this d l file shortcut.
 void setUserUuid(String userUuid)
          Sets the user uuid of this d l file shortcut.
 void setUuid(String uuid)
          Sets the uuid of this d l file shortcut.
 CacheModel<DLFileShortcut> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 DLFileShortcut toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from interface com.liferay.portal.model.BaseModel
resetOriginalValues
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 

Method Detail

getPrimaryKey

long getPrimaryKey()
Gets the primary key of this d l file shortcut.

Returns:
the primary key of this d l file shortcut

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this d l file shortcut

Parameters:
primaryKey - the primary key of this d l file shortcut

getUuid

@AutoEscape
String getUuid()
Gets the uuid of this d l file shortcut.

Returns:
the uuid of this d l file shortcut

setUuid

void setUuid(String uuid)
Sets the uuid of this d l file shortcut.

Parameters:
uuid - the uuid of this d l file shortcut

getFileShortcutId

long getFileShortcutId()
Gets the file shortcut ID of this d l file shortcut.

Returns:
the file shortcut ID of this d l file shortcut

setFileShortcutId

void setFileShortcutId(long fileShortcutId)
Sets the file shortcut ID of this d l file shortcut.

Parameters:
fileShortcutId - the file shortcut ID of this d l file shortcut

getGroupId

long getGroupId()
Gets the group ID of this d l file shortcut.

Specified by:
getGroupId in interface GroupedModel
Returns:
the group ID of this d l file shortcut

setGroupId

void setGroupId(long groupId)
Sets the group ID of this d l file shortcut.

Specified by:
setGroupId in interface GroupedModel
Parameters:
groupId - the group ID of this d l file shortcut

getCompanyId

long getCompanyId()
Gets the company ID of this d l file shortcut.

Specified by:
getCompanyId in interface AuditedModel
Returns:
the company ID of this d l file shortcut

setCompanyId

void setCompanyId(long companyId)
Sets the company ID of this d l file shortcut.

Specified by:
setCompanyId in interface AuditedModel
Parameters:
companyId - the company ID of this d l file shortcut

getUserId

long getUserId()
Gets the user ID of this d l file shortcut.

Specified by:
getUserId in interface AuditedModel
Returns:
the user ID of this d l file shortcut

setUserId

void setUserId(long userId)
Sets the user ID of this d l file shortcut.

Specified by:
setUserId in interface AuditedModel
Parameters:
userId - the user ID of this d l file shortcut

getUserUuid

String getUserUuid()
                   throws SystemException
Gets the user uuid of this d l file shortcut.

Specified by:
getUserUuid in interface AuditedModel
Returns:
the user uuid of this d l file shortcut
Throws:
SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)
Sets the user uuid of this d l file shortcut.

Specified by:
setUserUuid in interface AuditedModel
Parameters:
userUuid - the user uuid of this d l file shortcut

getUserName

@AutoEscape
String getUserName()
Gets the user name of this d l file shortcut.

Specified by:
getUserName in interface AuditedModel
Returns:
the user name of this d l file shortcut

setUserName

void setUserName(String userName)
Sets the user name of this d l file shortcut.

Specified by:
setUserName in interface AuditedModel
Parameters:
userName - the user name of this d l file shortcut

getCreateDate

Date getCreateDate()
Gets the create date of this d l file shortcut.

Specified by:
getCreateDate in interface AuditedModel
Returns:
the create date of this d l file shortcut

setCreateDate

void setCreateDate(Date createDate)
Sets the create date of this d l file shortcut.

Specified by:
setCreateDate in interface AuditedModel
Parameters:
createDate - the create date of this d l file shortcut

getModifiedDate

Date getModifiedDate()
Gets the modified date of this d l file shortcut.

Specified by:
getModifiedDate in interface AuditedModel
Returns:
the modified date of this d l file shortcut

setModifiedDate

void setModifiedDate(Date modifiedDate)
Sets the modified date of this d l file shortcut.

Specified by:
setModifiedDate in interface AuditedModel
Parameters:
modifiedDate - the modified date of this d l file shortcut

getFolderId

long getFolderId()
Gets the folder ID of this d l file shortcut.

Returns:
the folder ID of this d l file shortcut

setFolderId

void setFolderId(long folderId)
Sets the folder ID of this d l file shortcut.

Parameters:
folderId - the folder ID of this d l file shortcut

getToFileEntryId

long getToFileEntryId()
Gets the to file entry ID of this d l file shortcut.

Returns:
the to file entry ID of this d l file shortcut

setToFileEntryId

void setToFileEntryId(long toFileEntryId)
Sets the to file entry ID of this d l file shortcut.

Parameters:
toFileEntryId - the to file entry ID of this d l file shortcut

getStatus

int getStatus()
Gets the status of this d l file shortcut.

Specified by:
getStatus in interface WorkflowedModel
Returns:
the status of this d l file shortcut

setStatus

void setStatus(int status)
Sets the status of this d l file shortcut.

Specified by:
setStatus in interface WorkflowedModel
Parameters:
status - the status of this d l file shortcut

getStatusByUserId

long getStatusByUserId()
Gets the status by user ID of this d l file shortcut.

Specified by:
getStatusByUserId in interface WorkflowedModel
Returns:
the status by user ID of this d l file shortcut

setStatusByUserId

void setStatusByUserId(long statusByUserId)
Sets the status by user ID of this d l file shortcut.

Specified by:
setStatusByUserId in interface WorkflowedModel
Parameters:
statusByUserId - the status by user ID of this d l file shortcut

getStatusByUserUuid

String getStatusByUserUuid()
                           throws SystemException
Gets the status by user uuid of this d l file shortcut.

Returns:
the status by user uuid of this d l file shortcut
Throws:
SystemException - if a system exception occurred

setStatusByUserUuid

void setStatusByUserUuid(String statusByUserUuid)
Sets the status by user uuid of this d l file shortcut.

Parameters:
statusByUserUuid - the status by user uuid of this d l file shortcut

getStatusByUserName

@AutoEscape
String getStatusByUserName()
Gets the status by user name of this d l file shortcut.

Specified by:
getStatusByUserName in interface WorkflowedModel
Returns:
the status by user name of this d l file shortcut

setStatusByUserName

void setStatusByUserName(String statusByUserName)
Sets the status by user name of this d l file shortcut.

Specified by:
setStatusByUserName in interface WorkflowedModel
Parameters:
statusByUserName - the status by user name of this d l file shortcut

getStatusDate

Date getStatusDate()
Gets the status date of this d l file shortcut.

Specified by:
getStatusDate in interface WorkflowedModel
Returns:
the status date of this d l file shortcut

setStatusDate

void setStatusDate(Date statusDate)
Sets the status date of this d l file shortcut.

Specified by:
setStatusDate in interface WorkflowedModel
Parameters:
statusDate - the status date of this d l file shortcut

getApproved

boolean getApproved()
Deprecated. isApproved()


isApproved

boolean isApproved()
Determines if this d l file shortcut is approved.

Specified by:
isApproved in interface WorkflowedModel
Returns:
true if this d l file shortcut is approved; false otherwise

isDraft

boolean isDraft()
Determines if this d l file shortcut is a draft.

Specified by:
isDraft in interface WorkflowedModel
Returns:
true if this d l file shortcut is a draft; false otherwise

isExpired

boolean isExpired()
Determines if this d l file shortcut is expired.

Specified by:
isExpired in interface WorkflowedModel
Returns:
true if this d l file shortcut is expired; false otherwise

isPending

boolean isPending()
Determines if this d l file shortcut is pending.

Specified by:
isPending in interface WorkflowedModel
Returns:
true if this d l file shortcut is pending; 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
See Also:
BaseModel.setEscapedModel(boolean)

setEscapedModel

void setEscapedModel(boolean escapedModel)
Description copied from interface: BaseModel
Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.

A model instance can be made escaped by wrapping it with an HTML auto escape handler using its toEscapedModel method. For example, UserModel.toEscapedModel().

Specified by:
setEscapedModel in interface BaseModel<DLFileShortcut>
Parameters:
escapedModel - whether this model instance is escaped
See Also:
AutoEscapeBeanHandler

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(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
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>
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

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.0-ee-sp2