com.liferay.portlet.documentlibrary.model
Interface DLFileShortcutModel

All Superinterfaces:

BaseModel<DLFileShortcut>, java.lang.Cloneable, java.lang.Comparable<DLFileShortcut>, java.io.Serializable

All Known Subinterfaces:

DLFileShortcut

All Known Implementing Classes:

DLFileShortcutWrapper

public interface DLFileShortcutModel
extends BaseModel<DLFileShortcut>

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.

Never modify or reference this interface directly. All methods that expect a d l file shortcut model instance should use the DLFileShortcut interface instead.

Author:

Brian Wing Shun Chan

See Also:

DLFileShortcut, com.liferay.portlet.documentlibrary.model.impl.DLFileShortcutImpl, com.liferay.portlet.documentlibrary.model.impl.DLFileShortcutModelImpl

Generated:

Method Summary

java.lang.Object	clone() Creates a shallow clone of this model instance.
int	compareTo(DLFileShortcut dlFileShortcut)
long	getCompanyId() Gets the company id of this d l file shortcut.
java.util.Date	getCreateDate() Gets the create date of this d l file shortcut.
ExpandoBridge	getExpandoBridge() Gets 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.
java.util.Date	getModifiedDate() Gets the modified date of this d l file shortcut.
long	getPrimaryKey() Gets the primary key of this d l file shortcut.
java.io.Serializable	getPrimaryKeyObj() Gets 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.
java.lang.String	getStatusByUserName() Gets the status by user name of this d l file shortcut.
java.lang.String	getStatusByUserUuid() Gets the status by user uuid of this d l file shortcut.
java.util.Date	getStatusDate() Gets the status date of this d l file shortcut.
long	getToFolderId() Gets the to folder id of this d l file shortcut.
java.lang.String	getToName() Gets the to name of this d l file shortcut.
long	getUserId() Gets the user id of this d l file shortcut.
java.lang.String	getUserName() Gets the user name of this d l file shortcut.
java.lang.String	getUserUuid() Gets the user uuid of this d l file shortcut.
java.lang.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() Determines if this model instance was retrieved from the entity cache.
boolean	isDraft() Determines if this d l file shortcut is a draft.
boolean	isEscapedModel() Determines if this model instance is escaped.
boolean	isExpired() Determines if this d l file shortcut is expired.
boolean	isNew() Determines 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(java.util.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(java.util.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 pk) Sets the primary key of this d l file shortcut
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(java.lang.String statusByUserName) Sets the status by user name of this d l file shortcut.
void	setStatusByUserUuid(java.lang.String statusByUserUuid) Sets the status by user uuid of this d l file shortcut.
void	setStatusDate(java.util.Date statusDate) Sets the status date of this d l file shortcut.
void	setToFolderId(long toFolderId) Sets the to folder id of this d l file shortcut.
void	setToName(java.lang.String toName) Sets the to name of this d l file shortcut.
void	setUserId(long userId) Sets the user id of this d l file shortcut.
void	setUserName(java.lang.String userName) Sets the user name of this d l file shortcut.
void	setUserUuid(java.lang.String userUuid) Sets the user uuid of this d l file shortcut.
void	setUuid(java.lang.String uuid) Sets the uuid of this d l file shortcut.
DLFileShortcut	toEscapedModel() Gets a copy of this d l file shortcut as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
java.lang.String	toString()
java.lang.String	toXmlString() Gets the XML representation of this model instance.

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 pk)

Sets the primary key of this d l file shortcut

Parameters:

pk - the primary key of this d l file shortcut

getUuid

@AutoEscape
java.lang.String getUuid()

Gets the uuid of this d l file shortcut.

Returns:

the uuid of this d l file shortcut

setUuid

void setUuid(java.lang.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.

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.

Parameters:

groupId - the group id of this d l file shortcut

getCompanyId

long getCompanyId()

Gets the company id of this d l file shortcut.

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.

Parameters:

companyId - the company id of this d l file shortcut

getUserId

long getUserId()

Gets the user id of this d l file shortcut.

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.

Parameters:

userId - the user id of this d l file shortcut

getUserUuid

java.lang.String getUserUuid()
                             throws SystemException

Gets the user uuid of this d l file shortcut.

Returns:

the user uuid of this d l file shortcut

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(java.lang.String userUuid)

Sets the user uuid of this d l file shortcut.

Parameters:

userUuid - the user uuid of this d l file shortcut

getUserName

@AutoEscape
java.lang.String getUserName()

Gets the user name of this d l file shortcut.

Returns:

the user name of this d l file shortcut

setUserName

void setUserName(java.lang.String userName)

Sets the user name of this d l file shortcut.

Parameters:

userName - the user name of this d l file shortcut

getCreateDate

java.util.Date getCreateDate()

Gets the create date of this d l file shortcut.

Returns:

the create date of this d l file shortcut

setCreateDate

void setCreateDate(java.util.Date createDate)

Sets the create date of this d l file shortcut.

Parameters:

createDate - the create date of this d l file shortcut

getModifiedDate

java.util.Date getModifiedDate()

Gets the modified date of this d l file shortcut.

Returns:

the modified date of this d l file shortcut

setModifiedDate

void setModifiedDate(java.util.Date modifiedDate)

Sets the modified date of this d l file shortcut.

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

getToFolderId

long getToFolderId()

Gets the to folder id of this d l file shortcut.

Returns:

the to folder id of this d l file shortcut

setToFolderId

void setToFolderId(long toFolderId)

Sets the to folder id of this d l file shortcut.

Parameters:

toFolderId - the to folder id of this d l file shortcut

getToName

@AutoEscape
java.lang.String getToName()

Gets the to name of this d l file shortcut.

Returns:

the to name of this d l file shortcut

setToName

void setToName(java.lang.String toName)

Sets the to name of this d l file shortcut.

Parameters:

toName - the to name of this d l file shortcut

getStatus

int getStatus()

Gets the status of this d l file shortcut.

Returns:

the status of this d l file shortcut

setStatus

void setStatus(int status)

Sets the status of this d l file shortcut.

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.

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.

Parameters:

statusByUserId - the status by user id of this d l file shortcut

getStatusByUserUuid

java.lang.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(java.lang.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
java.lang.String getStatusByUserName()

Gets the status by user name of this d l file shortcut.

Returns:

the status by user name of this d l file shortcut

setStatusByUserName

void setStatusByUserName(java.lang.String statusByUserName)

Sets the status by user name of this d l file shortcut.

Parameters:

statusByUserName - the status by user name of this d l file shortcut

getStatusDate

java.util.Date getStatusDate()

Gets the status date of this d l file shortcut.

Returns:

the status date of this d l file shortcut

setStatusDate

void setStatusDate(java.util.Date statusDate)

Sets the status date of this d l file shortcut.

Parameters:

statusDate - the status date of this d l file shortcut

isApproved

boolean isApproved()

Determines if this d l file shortcut is approved.

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.

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.

Returns:

true if this d l file shortcut is expired; false otherwise

isPending

boolean isPending()

Determines if this d l file shortcut is pending.

Returns:

true if this d l file shortcut is pending; false otherwise

toEscapedModel

DLFileShortcut toEscapedModel()

Gets a copy of this d l file shortcut as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

isNew

boolean isNew()

Description copied from interface: BaseModel

Determines 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

Determines 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

Determines 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

java.io.Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Gets the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<DLFileShortcut>

Returns:

the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Gets the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<DLFileShortcut>

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 to retrieve the expando bridge attributes from

See Also:

ServiceContext.getExpandoBridgeAttributes( )

clone

java.lang.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 java.lang.Comparable<DLFileShortcut>

hashCode

int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object

toXmlString

java.lang.String toXmlString()

Description copied from interface: BaseModel

Gets the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<DLFileShortcut>

Returns:

the XML representation of this model instance