com.liferay.portlet.documentlibrary.model
Class DLFolderWrapper

java.lang.Object
  com.liferay.portlet.documentlibrary.model.DLFolderWrapper

All Implemented Interfaces:

BaseModel<DLFolder>, DLFolder, DLFolderModel, Serializable, Cloneable, Comparable<DLFolder>

public class DLFolderWrapper
extends Object
implements DLFolder

This class is a wrapper for DLFolder.

See Also:

DLFolder, Serialized Form

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary

DLFolderWrapper(DLFolder dlFolder)

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(DLFolder dlFolder)
List<DLFolder>	getAncestors()
long	getCompanyId() Gets the company id of this d l folder.
Date	getCreateDate() Gets the create date of this d l folder.
String	getDescription() Gets the description of this d l folder.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
long	getFolderId() Gets the folder id of this d l folder.
long	getGroupId() Gets the group id of this d l folder.
Date	getLastPostDate() Gets the last post date of this d l folder.
Date	getModifiedDate() Gets the modified date of this d l folder.
String	getName() Gets the name of this d l folder.
DLFolder	getParentFolder()
long	getParentFolderId() Gets the parent folder id of this d l folder.
String	getPath()
String[]	getPathArray()
long	getPrimaryKey() Gets the primary key of this d l folder.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
long	getUserId() Gets the user id of this d l folder.
String	getUserName() Gets the user name of this d l folder.
String	getUserUuid() Gets the user uuid of this d l folder.
String	getUuid() Gets the uuid of this d l folder.
DLFolder	getWrappedDLFolder()
int	hashCode()
boolean	hasLock(long userId)
boolean	isCachedModel() Determines if this model instance was retrieved from the entity cache.
boolean	isEscapedModel() Determines if this model instance is escaped.
boolean	isLocked()
boolean	isNew() Determines if this model instance does not yet exist in the database.
boolean	isRoot()
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 folder.
void	setCreateDate(Date createDate) Sets the create date of this d l folder.
void	setDescription(String description) Sets the description of this d l folder.
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	setFolderId(long folderId) Sets the folder id of this d l folder.
void	setGroupId(long groupId) Sets the group id of this d l folder.
void	setLastPostDate(Date lastPostDate) Sets the last post date of this d l folder.
void	setModifiedDate(Date modifiedDate) Sets the modified date of this d l folder.
void	setName(String name) Sets the name of this d l folder.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setParentFolderId(long parentFolderId) Sets the parent folder id of this d l folder.
void	setPrimaryKey(long pk) Sets the primary key of this d l folder
void	setUserId(long userId) Sets the user id of this d l folder.
void	setUserName(String userName) Sets the user name of this d l folder.
void	setUserUuid(String userUuid) Sets the user uuid of this d l folder.
void	setUuid(String uuid) Sets the uuid of this d l folder.
DLFolder	toEscapedModel() Gets a copy of this d l folder as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
String	toXmlString() Gets the XML representation of this model instance.

Methods inherited from class java.lang.Object

equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DLFolderWrapper

public DLFolderWrapper(DLFolder dlFolder)

Method Detail

getPrimaryKey

public long getPrimaryKey()

Description copied from interface: DLFolderModel

Gets the primary key of this d l folder.

Specified by:

getPrimaryKey in interface DLFolderModel

Returns:

the primary key of this d l folder

setPrimaryKey

public void setPrimaryKey(long pk)

Description copied from interface: DLFolderModel

Sets the primary key of this d l folder

Specified by:

setPrimaryKey in interface DLFolderModel

Parameters:

pk - the primary key of this d l folder

getUuid

public String getUuid()

Description copied from interface: DLFolderModel

Gets the uuid of this d l folder.

Specified by:

getUuid in interface DLFolderModel

Returns:

the uuid of this d l folder

setUuid

public void setUuid(String uuid)

Description copied from interface: DLFolderModel

Sets the uuid of this d l folder.

Specified by:

setUuid in interface DLFolderModel

Parameters:

uuid - the uuid of this d l folder

getFolderId

public long getFolderId()

Description copied from interface: DLFolderModel

Gets the folder id of this d l folder.

Specified by:

getFolderId in interface DLFolderModel

Returns:

the folder id of this d l folder

setFolderId

public void setFolderId(long folderId)

Description copied from interface: DLFolderModel

Sets the folder id of this d l folder.

Specified by:

setFolderId in interface DLFolderModel

Parameters:

folderId - the folder id of this d l folder

getGroupId

public long getGroupId()

Description copied from interface: DLFolderModel

Gets the group id of this d l folder.

Specified by:

getGroupId in interface DLFolderModel

Returns:

the group id of this d l folder

setGroupId

public void setGroupId(long groupId)

Description copied from interface: DLFolderModel

Sets the group id of this d l folder.

Specified by:

setGroupId in interface DLFolderModel

Parameters:

groupId - the group id of this d l folder

getCompanyId

public long getCompanyId()

Description copied from interface: DLFolderModel

Gets the company id of this d l folder.

Specified by:

getCompanyId in interface DLFolderModel

Returns:

the company id of this d l folder

setCompanyId

public void setCompanyId(long companyId)

Description copied from interface: DLFolderModel

Sets the company id of this d l folder.

Specified by:

setCompanyId in interface DLFolderModel

Parameters:

companyId - the company id of this d l folder

getUserId

public long getUserId()

Description copied from interface: DLFolderModel

Gets the user id of this d l folder.

Specified by:

getUserId in interface DLFolderModel

Returns:

the user id of this d l folder

setUserId

public void setUserId(long userId)

Description copied from interface: DLFolderModel

Sets the user id of this d l folder.

Specified by:

setUserId in interface DLFolderModel

Parameters:

userId - the user id of this d l folder

getUserUuid

public String getUserUuid()
                   throws SystemException

Description copied from interface: DLFolderModel

Gets the user uuid of this d l folder.

Specified by:

getUserUuid in interface DLFolderModel

Returns:

the user uuid of this d l folder

Throws:

SystemException - if a system exception occurred

setUserUuid

public void setUserUuid(String userUuid)

Description copied from interface: DLFolderModel

Sets the user uuid of this d l folder.

Specified by:

setUserUuid in interface DLFolderModel

Parameters:

userUuid - the user uuid of this d l folder

getUserName

public String getUserName()

Description copied from interface: DLFolderModel

Gets the user name of this d l folder.

Specified by:

getUserName in interface DLFolderModel

Returns:

the user name of this d l folder

setUserName

public void setUserName(String userName)

Description copied from interface: DLFolderModel

Sets the user name of this d l folder.

Specified by:

setUserName in interface DLFolderModel

Parameters:

userName - the user name of this d l folder

getCreateDate

public Date getCreateDate()

Description copied from interface: DLFolderModel

Gets the create date of this d l folder.

Specified by:

getCreateDate in interface DLFolderModel

Returns:

the create date of this d l folder

setCreateDate

public void setCreateDate(Date createDate)

Description copied from interface: DLFolderModel

Sets the create date of this d l folder.

Specified by:

setCreateDate in interface DLFolderModel

Parameters:

createDate - the create date of this d l folder

getModifiedDate

public Date getModifiedDate()

Description copied from interface: DLFolderModel

Gets the modified date of this d l folder.

Specified by:

getModifiedDate in interface DLFolderModel

Returns:

the modified date of this d l folder

setModifiedDate

public void setModifiedDate(Date modifiedDate)

Description copied from interface: DLFolderModel

Sets the modified date of this d l folder.

Specified by:

setModifiedDate in interface DLFolderModel

Parameters:

modifiedDate - the modified date of this d l folder

getParentFolderId

public long getParentFolderId()

Description copied from interface: DLFolderModel

Gets the parent folder id of this d l folder.

Specified by:

getParentFolderId in interface DLFolderModel

Returns:

the parent folder id of this d l folder

setParentFolderId

public void setParentFolderId(long parentFolderId)

Description copied from interface: DLFolderModel

Sets the parent folder id of this d l folder.

Specified by:

setParentFolderId in interface DLFolderModel

Parameters:

parentFolderId - the parent folder id of this d l folder

getName

public String getName()

Description copied from interface: DLFolderModel

Gets the name of this d l folder.

Specified by:

getName in interface DLFolderModel

Returns:

the name of this d l folder

setName

public void setName(String name)

Description copied from interface: DLFolderModel

Sets the name of this d l folder.

Specified by:

setName in interface DLFolderModel

Parameters:

name - the name of this d l folder

getDescription

public String getDescription()

Description copied from interface: DLFolderModel

Gets the description of this d l folder.

Specified by:

getDescription in interface DLFolderModel

Returns:

the description of this d l folder

setDescription

public void setDescription(String description)

Description copied from interface: DLFolderModel

Sets the description of this d l folder.

Specified by:

setDescription in interface DLFolderModel

Parameters:

description - the description of this d l folder

getLastPostDate

public Date getLastPostDate()

Description copied from interface: DLFolderModel

Gets the last post date of this d l folder.

Specified by:

getLastPostDate in interface DLFolderModel

Returns:

the last post date of this d l folder

setLastPostDate

public void setLastPostDate(Date lastPostDate)

Description copied from interface: DLFolderModel

Sets the last post date of this d l folder.

Specified by:

setLastPostDate in interface DLFolderModel

Parameters:

lastPostDate - the last post date of this d l folder

toEscapedModel

public DLFolder toEscapedModel()

Description copied from interface: DLFolderModel

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

Specified by:

toEscapedModel in interface DLFolderModel

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

isNew

public 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<DLFolder>

Specified by:

isNew in interface DLFolderModel

Returns:

true if this model instance does not yet exist in the database; false otherwise

setNew

public 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<DLFolder>

Specified by:

setNew in interface DLFolderModel

Parameters:

n - whether this model instance does not yet exist in the database

isCachedModel

public boolean isCachedModel()

Description copied from interface: BaseModel

Determines if this model instance was retrieved from the entity cache.

Specified by:

isCachedModel in interface BaseModel<DLFolder>

Specified by:

isCachedModel in interface DLFolderModel

Returns:

true if this model instance was retrieved from the entity cache; false otherwise

See Also:

BaseModel.setCachedModel(boolean)

setCachedModel

public 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<DLFolder>

Specified by:

setCachedModel in interface DLFolderModel

Parameters:

cachedModel - whether this model instance was retrieved from the entity cache

See Also:

EntityCache

isEscapedModel

public boolean isEscapedModel()

Description copied from interface: BaseModel

Determines if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<DLFolder>

Specified by:

isEscapedModel in interface DLFolderModel

Returns:

true if this model instance is escaped; false otherwise

See Also:

BaseModel.setEscapedModel(boolean)

setEscapedModel

public 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<DLFolder>

Specified by:

setEscapedModel in interface DLFolderModel

Parameters:

escapedModel - whether this model instance is escaped

See Also:

AutoEscapeBeanHandler

getPrimaryKeyObj

public Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Gets the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<DLFolder>

Specified by:

getPrimaryKeyObj in interface DLFolderModel

Returns:

the primary key of this model instance

getExpandoBridge

public ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Gets the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<DLFolder>

Specified by:

getExpandoBridge in interface DLFolderModel

Returns:

the expando bridge for this model instance

setExpandoBridgeAttributes

public 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<DLFolder>

Specified by:

setExpandoBridgeAttributes in interface DLFolderModel

Parameters:

serviceContext - the service context to retrieve the expando bridge attributes from

See Also:

ServiceContext.getExpandoBridgeAttributes( )

clone

public Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<DLFolder>

Specified by:

clone in interface DLFolderModel

Overrides:

clone in class Object

Returns:

the shallow clone of this model instance

compareTo

public int compareTo(DLFolder dlFolder)

Specified by:

compareTo in interface DLFolderModel

Specified by:

compareTo in interface Comparable<DLFolder>

hashCode

public int hashCode()

Specified by:

hashCode in interface DLFolderModel

Overrides:

hashCode in class Object

toString

public String toString()

Specified by:

toString in interface DLFolderModel

Overrides:

toString in class Object

toXmlString

public String toXmlString()

Description copied from interface: BaseModel

Gets the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<DLFolder>

Specified by:

toXmlString in interface DLFolderModel

Returns:

the XML representation of this model instance

getAncestors

public List<DLFolder> getAncestors()
                            throws PortalException,
                                   SystemException

Specified by:

getAncestors in interface DLFolder

Throws:

PortalException

SystemException

getParentFolder

public DLFolder getParentFolder()
                         throws PortalException,
                                SystemException

Specified by:

getParentFolder in interface DLFolder

Throws:

PortalException

SystemException

getPath

public String getPath()
               throws PortalException,
                      SystemException

Specified by:

getPath in interface DLFolder

Throws:

PortalException

SystemException

getPathArray

public String[] getPathArray()
                      throws PortalException,
                             SystemException

Specified by:

getPathArray in interface DLFolder

Throws:

PortalException

SystemException

hasLock

public boolean hasLock(long userId)

Specified by:

hasLock in interface DLFolder

isLocked

public boolean isLocked()

Specified by:

isLocked in interface DLFolder

isRoot

public boolean isRoot()

Specified by:

isRoot in interface DLFolder

getWrappedDLFolder

public DLFolder getWrappedDLFolder()