Liferay 6.1.2-ce-ga3

com.liferay.portal.model
Interface LockModel

All Superinterfaces:
BaseModel<Lock>, ClassedModel, Cloneable, Comparable<Lock>, Serializable
All Known Subinterfaces:
Lock
All Known Implementing Classes:
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.

See Also:
Lock, LockImpl, LockModelImpl

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(Lock lock)
           
 String getClassName()
          Returns the class name of this lock.
 long getCompanyId()
          Returns the company ID of this lock.
 Date getCreateDate()
          Returns the create date of this lock.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 Date getExpirationDate()
          Returns the expiration date of this lock.
 boolean getInheritable()
          Returns the inheritable of this lock.
 String getKey()
          Returns the key of this lock.
 long getLockId()
          Returns the lock ID of this lock.
 String getOwner()
          Returns the owner of this lock.
 long getPrimaryKey()
          Returns the primary key of this lock.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 long getUserId()
          Returns the user ID of this lock.
 String getUserName()
          Returns the user name of this lock.
 String getUserUuid()
          Returns the user uuid of this lock.
 String getUuid()
          Returns the uuid of this lock.
 int hashCode()
           
 boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
 boolean isEscapedModel()
          Returns true if this model instance is escaped.
 boolean isInheritable()
          Returns true if this lock is inheritable.
 boolean isNew()
          Returns true 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 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 lock 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 primaryKey)
          Sets the primary key of this lock.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 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.
 CacheModel<Lock> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 Lock toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 Lock toUnescapedModel()
           
 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
 

Method Detail

getPrimaryKey

long getPrimaryKey()
Returns the primary key of this lock.

Returns:
the primary key of this lock

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this lock.

Parameters:
primaryKey - the primary key of this lock

getUuid

@AutoEscape
String getUuid()
Returns 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()
Returns 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()
Returns 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()
Returns 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
Returns 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()
Returns 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()
Returns 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()
Returns 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()
Returns 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()
Returns 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()
Returns the inheritable of this lock.

Returns:
the inheritable of this lock

isInheritable

boolean isInheritable()
Returns true if this lock is inheritable.

Returns:
true if this lock is inheritable; false otherwise

setInheritable

void setInheritable(boolean inheritable)
Sets whether this lock is inheritable.

Parameters:
inheritable - the inheritable of this lock

getExpirationDate

Date getExpirationDate()
Returns 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

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<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
Returns true 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
Returns true if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<Lock>
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<Lock>
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<Lock>
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<Lock>
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<Lock>
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<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

toCacheModel

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

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

toEscapedModel

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

toUnescapedModel

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

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<Lock>
Returns:
the XML representation of this model instance

Liferay 6.1.2-ce-ga3