Liferay 6.2-ce-ga5

com.liferay.portal.model
Interface LayoutBranchModel

All Superinterfaces:
BaseModel<LayoutBranch>, ClassedModel, Cloneable, Comparable<LayoutBranch>, Serializable
All Known Subinterfaces:
LayoutBranch
All Known Implementing Classes:
LayoutBranchBaseImpl, LayoutBranchImpl, LayoutBranchModelImpl, LayoutBranchWrapper

@ProviderType
public interface LayoutBranchModel
extends BaseModel<LayoutBranch>

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

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

See Also:
LayoutBranch, LayoutBranchImpl, LayoutBranchModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(LayoutBranch layoutBranch)
           
 long getCompanyId()
          Returns the company ID of this layout branch.
 String getDescription()
          Returns the description of this layout branch.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 long getGroupId()
          Returns the group ID of this layout branch.
 long getLayoutBranchId()
          Returns the layout branch ID of this layout branch.
 long getLayoutSetBranchId()
          Returns the layout set branch ID of this layout branch.
 boolean getMaster()
          Returns the master of this layout branch.
 String getName()
          Returns the name of this layout branch.
 long getPlid()
          Returns the plid of this layout branch.
 long getPrimaryKey()
          Returns the primary key of this layout branch.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 long getUserId()
          Returns the user ID of this layout branch.
 String getUserName()
          Returns the user name of this layout branch.
 String getUserUuid()
          Returns the user uuid of this layout branch.
 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 isMaster()
          Returns true if this layout branch is master.
 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 setCompanyId(long companyId)
          Sets the company ID of this layout branch.
 void setDescription(String description)
          Sets the description of this layout branch.
 void setExpandoBridgeAttributes(BaseModel<?> baseModel)
           
 void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
           
 void setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
 void setGroupId(long groupId)
          Sets the group ID of this layout branch.
 void setLayoutBranchId(long LayoutBranchId)
          Sets the layout branch ID of this layout branch.
 void setLayoutSetBranchId(long layoutSetBranchId)
          Sets the layout set branch ID of this layout branch.
 void setMaster(boolean master)
          Sets whether this layout branch is master.
 void setName(String name)
          Sets the name of this layout branch.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setPlid(long plid)
          Sets the plid of this layout branch.
 void setPrimaryKey(long primaryKey)
          Sets the primary key of this layout branch.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setUserId(long userId)
          Sets the user ID of this layout branch.
 void setUserName(String userName)
          Sets the user name of this layout branch.
 void setUserUuid(String userUuid)
          Sets the user uuid of this layout branch.
 CacheModel<LayoutBranch> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 LayoutBranch toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 LayoutBranch 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 layout branch.

Returns:
the primary key of this layout branch

setPrimaryKey

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

Parameters:
primaryKey - the primary key of this layout branch

getLayoutBranchId

long getLayoutBranchId()
Returns the layout branch ID of this layout branch.

Returns:
the layout branch ID of this layout branch

setLayoutBranchId

void setLayoutBranchId(long LayoutBranchId)
Sets the layout branch ID of this layout branch.

Parameters:
LayoutBranchId - the layout branch ID of this layout branch

getGroupId

long getGroupId()
Returns the group ID of this layout branch.

Returns:
the group ID of this layout branch

setGroupId

void setGroupId(long groupId)
Sets the group ID of this layout branch.

Parameters:
groupId - the group ID of this layout branch

getCompanyId

long getCompanyId()
Returns the company ID of this layout branch.

Returns:
the company ID of this layout branch

setCompanyId

void setCompanyId(long companyId)
Sets the company ID of this layout branch.

Parameters:
companyId - the company ID of this layout branch

getUserId

long getUserId()
Returns the user ID of this layout branch.

Returns:
the user ID of this layout branch

setUserId

void setUserId(long userId)
Sets the user ID of this layout branch.

Parameters:
userId - the user ID of this layout branch

getUserUuid

String getUserUuid()
                   throws SystemException
Returns the user uuid of this layout branch.

Returns:
the user uuid of this layout branch
Throws:
SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)
Sets the user uuid of this layout branch.

Parameters:
userUuid - the user uuid of this layout branch

getUserName

@AutoEscape
String getUserName()
Returns the user name of this layout branch.

Returns:
the user name of this layout branch

setUserName

void setUserName(String userName)
Sets the user name of this layout branch.

Parameters:
userName - the user name of this layout branch

getLayoutSetBranchId

long getLayoutSetBranchId()
Returns the layout set branch ID of this layout branch.

Returns:
the layout set branch ID of this layout branch

setLayoutSetBranchId

void setLayoutSetBranchId(long layoutSetBranchId)
Sets the layout set branch ID of this layout branch.

Parameters:
layoutSetBranchId - the layout set branch ID of this layout branch

getPlid

long getPlid()
Returns the plid of this layout branch.

Returns:
the plid of this layout branch

setPlid

void setPlid(long plid)
Sets the plid of this layout branch.

Parameters:
plid - the plid of this layout branch

getName

@AutoEscape
String getName()
Returns the name of this layout branch.

Returns:
the name of this layout branch

setName

void setName(String name)
Sets the name of this layout branch.

Parameters:
name - the name of this layout branch

getDescription

@AutoEscape
String getDescription()
Returns the description of this layout branch.

Returns:
the description of this layout branch

setDescription

void setDescription(String description)
Sets the description of this layout branch.

Parameters:
description - the description of this layout branch

getMaster

boolean getMaster()
Returns the master of this layout branch.

Returns:
the master of this layout branch

isMaster

boolean isMaster()
Returns true if this layout branch is master.

Returns:
true if this layout branch is master; false otherwise

setMaster

void setMaster(boolean master)
Sets whether this layout branch is master.

Parameters:
master - the master of this layout branch

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<LayoutBranch>
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<LayoutBranch>
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<LayoutBranch>
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<LayoutBranch>
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<LayoutBranch>
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<LayoutBranch>
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<LayoutBranch>
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<LayoutBranch>
Specified by:
getExpandoBridge in interface ClassedModel
Returns:
the expando bridge for this model instance

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(BaseModel<?> baseModel)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<LayoutBranch>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<LayoutBranch>

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<LayoutBranch>
Parameters:
serviceContext - the service context to be applied
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<LayoutBranch>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(LayoutBranch layoutBranch)
Specified by:
compareTo in interface Comparable<LayoutBranch>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

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

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

toEscapedModel

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

toUnescapedModel

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

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

Liferay 6.2-ce-ga5