com.liferay.portal.model
Interface LockModel

All Superinterfaces:

BaseModel<Lock>, Cloneable, Comparable<Lock>, Serializable

All Known Subinterfaces:

Lock

All Known Implementing Classes:

LockImpl, LockModelImpl, LockWrapper

public interface LockModel
extends BaseModel<Lock>

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

This interface and its corresponding implementation LockModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in LockImpl.

Never modify or reference this interface directly. All methods that expect a lock model instance should use the Lock interface instead.

See Also:

Lock, LockImpl, LockModelImpl

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

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(Lock lock)
String	getClassName() Gets the class name of this lock.
long	getCompanyId() Gets the company id of this lock.
Date	getCreateDate() Gets the create date of this lock.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
Date	getExpirationDate() Gets the expiration date of this lock.
boolean	getInheritable() Gets the inheritable of this lock.
String	getKey() Gets the key of this lock.
long	getLockId() Gets the lock id of this lock.
String	getOwner() Gets the owner of this lock.
long	getPrimaryKey() Gets the primary key of this lock.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
long	getUserId() Gets the user id of this lock.
String	getUserName() Gets the user name of this lock.
String	getUserUuid() Gets the user uuid of this lock.
String	getUuid() Gets the uuid of this lock.
int	hashCode()
boolean	isCachedModel() Determines if this model instance was retrieved from the entity cache.
boolean	isEscapedModel() Determines if this model instance is escaped.
boolean	isInheritable() Determines whether this lock is inheritable.
boolean	isNew() Determines if this model instance does not yet exist in the database.
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setClassName(String className) Sets the class name of this lock.
void	setCompanyId(long companyId) Sets the company id of this lock.
void	setCreateDate(Date createDate) Sets the create date of this lock.
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	setExpirationDate(Date expirationDate) Sets the expiration date of this lock.
void	setInheritable(boolean inheritable) Sets whether this {$entity.humanName} is inheritable.
void	setKey(String key) Sets the key of this lock.
void	setLockId(long lockId) Sets the lock id of this lock.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setOwner(String owner) Sets the owner of this lock.
void	setPrimaryKey(long pk) Sets the primary key of this lock
void	setUserId(long userId) Sets the user id of this lock.
void	setUserName(String userName) Sets the user name of this lock.
void	setUserUuid(String userUuid) Sets the user uuid of this lock.
void	setUuid(String uuid) Sets the uuid of this lock.
Lock	toEscapedModel() Gets a copy of this lock as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
String	toXmlString() Gets the XML representation of this model instance.

Method Detail

getPrimaryKey

long getPrimaryKey()

Gets the primary key of this lock.

Returns:

the primary key of this lock

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this lock

Parameters:

pk - the primary key of this lock

getUuid

@AutoEscape
String getUuid()

Gets the uuid of this lock.

Returns:

the uuid of this lock

setUuid

void setUuid(String uuid)

Sets the uuid of this lock.

Parameters:

uuid - the uuid of this lock

getLockId

long getLockId()

Gets the lock id of this lock.

Returns:

the lock id of this lock

setLockId

void setLockId(long lockId)

Sets the lock id of this lock.

Parameters:

lockId - the lock id of this lock

getCompanyId

long getCompanyId()

Gets the company id of this lock.

Returns:

the company id of this lock

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this lock.

Parameters:

companyId - the company id of this lock

getUserId

long getUserId()

Gets the user id of this lock.

Returns:

the user id of this lock

setUserId

void setUserId(long userId)

Sets the user id of this lock.

Parameters:

userId - the user id of this lock

getUserUuid

String getUserUuid()
                   throws SystemException

Gets the user uuid of this lock.

Returns:

the user uuid of this lock

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this lock.

Parameters:

userUuid - the user uuid of this lock

getUserName

@AutoEscape
String getUserName()

Gets the user name of this lock.

Returns:

the user name of this lock

setUserName

void setUserName(String userName)

Sets the user name of this lock.

Parameters:

userName - the user name of this lock

getCreateDate

Date getCreateDate()

Gets the create date of this lock.

Returns:

the create date of this lock

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this lock.

Parameters:

createDate - the create date of this lock

getClassName

@AutoEscape
String getClassName()

Gets the class name of this lock.

Returns:

the class name of this lock

setClassName

void setClassName(String className)

Sets the class name of this lock.

Parameters:

className - the class name of this lock

getKey

@AutoEscape
String getKey()

Gets the key of this lock.

Returns:

the key of this lock

setKey

void setKey(String key)

Sets the key of this lock.

Parameters:

key - the key of this lock

getOwner

@AutoEscape
String getOwner()

Gets the owner of this lock.

Returns:

the owner of this lock

setOwner

void setOwner(String owner)

Sets the owner of this lock.

Parameters:

owner - the owner of this lock

getInheritable

boolean getInheritable()

Gets the inheritable of this lock.

Returns:

the inheritable of this lock

isInheritable

boolean isInheritable()

Determines whether this lock is inheritable.

Returns:

whether this lock is inheritable

setInheritable

void setInheritable(boolean inheritable)

Sets whether this {$entity.humanName} is inheritable.

Parameters:

inheritable - the inheritable of this lock

getExpirationDate

Date getExpirationDate()

Gets the expiration date of this lock.

Returns:

the expiration date of this lock

setExpirationDate

void setExpirationDate(Date expirationDate)

Sets the expiration date of this lock.

Parameters:

expirationDate - the expiration date of this lock

toEscapedModel

Lock toEscapedModel()

Gets a copy of this lock 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<Lock>

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

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

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

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

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

Parameters:

escapedModel - whether this model instance is escaped

See Also:

AutoEscapeBeanHandler

getPrimaryKeyObj

Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Gets the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<Lock>

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

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

Parameters:

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

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(Lock lock)

Specified by:

compareTo in interface Comparable<Lock>

hashCode

int hashCode()

Overrides:

hashCode in class Object

toString

String toString()

Overrides:

toString in class Object

toXmlString

String toXmlString()

Description copied from interface: BaseModel

Gets the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<Lock>

Returns:

the XML representation of this model instance