com.liferay.portal.model
Interface LayoutModel

All Superinterfaces:

BaseModel<Layout>, Cloneable, Comparable<Layout>, Serializable

All Known Subinterfaces:

Layout

All Known Implementing Classes:

LayoutImpl, LayoutModelImpl, LayoutWrapper

public interface LayoutModel
extends BaseModel<Layout>

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

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

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

See Also:

Layout, LayoutImpl, LayoutModelImpl

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(Layout layout)
String	getColorSchemeId() Gets the color scheme id of this layout.
long	getCompanyId() Gets the company id of this layout.
String	getCss() Gets the css of this layout.
String	getDescription() Gets the description of this layout.
long	getDlFolderId() Gets the dl folder id of this layout.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
String	getFriendlyURL() Gets the friendly u r l of this layout.
long	getGroupId() Gets the group id of this layout.
boolean	getHidden() Gets the hidden of this layout.
boolean	getIconImage() Gets the icon image of this layout.
long	getIconImageId() Gets the icon image id of this layout.
long	getLayoutId() Gets the layout id of this layout.
long	getLayoutPrototypeId() Gets the layout prototype id of this layout.
String	getName() Gets the name of this layout.
long	getParentLayoutId() Gets the parent layout id of this layout.
long	getPlid() Gets the plid of this layout.
long	getPrimaryKey() Gets the primary key of this layout.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
int	getPriority() Gets the priority of this layout.
boolean	getPrivateLayout() Gets the private layout of this layout.
String	getThemeId() Gets the theme id of this layout.
String	getTitle() Gets the title of this layout.
String	getType() Gets the type of this layout.
String	getTypeSettings() Gets the type settings of this layout.
String	getUuid() Gets the uuid of this layout.
String	getWapColorSchemeId() Gets the wap color scheme id of this layout.
String	getWapThemeId() Gets the wap theme id of this layout.
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	isHidden() Determines whether this layout is hidden.
boolean	isIconImage() Determines whether this layout is icon image.
boolean	isNew() Determines if this model instance does not yet exist in the database.
boolean	isPrivateLayout() Determines whether this layout is private layout.
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setColorSchemeId(String colorSchemeId) Sets the color scheme id of this layout.
void	setCompanyId(long companyId) Sets the company id of this layout.
void	setCss(String css) Sets the css of this layout.
void	setDescription(String description) Sets the description of this layout.
void	setDlFolderId(long dlFolderId) Sets the dl folder id of this layout.
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	setFriendlyURL(String friendlyURL) Sets the friendly u r l of this layout.
void	setGroupId(long groupId) Sets the group id of this layout.
void	setHidden(boolean hidden) Sets whether this {$entity.humanName} is hidden.
void	setIconImage(boolean iconImage) Sets whether this {$entity.humanName} is icon image.
void	setIconImageId(long iconImageId) Sets the icon image id of this layout.
void	setLayoutId(long layoutId) Sets the layout id of this layout.
void	setLayoutPrototypeId(long layoutPrototypeId) Sets the layout prototype id of this layout.
void	setName(String name) Sets the name of this layout.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setParentLayoutId(long parentLayoutId) Sets the parent layout id of this layout.
void	setPlid(long plid) Sets the plid of this layout.
void	setPrimaryKey(long pk) Sets the primary key of this layout
void	setPriority(int priority) Sets the priority of this layout.
void	setPrivateLayout(boolean privateLayout) Sets whether this {$entity.humanName} is private layout.
void	setThemeId(String themeId) Sets the theme id of this layout.
void	setTitle(String title) Sets the title of this layout.
void	setType(String type) Sets the type of this layout.
void	setTypeSettings(String typeSettings) Sets the type settings of this layout.
void	setUuid(String uuid) Sets the uuid of this layout.
void	setWapColorSchemeId(String wapColorSchemeId) Sets the wap color scheme id of this layout.
void	setWapThemeId(String wapThemeId) Sets the wap theme id of this layout.
Layout	toEscapedModel() Gets a copy of this layout 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 layout.

Returns:

the primary key of this layout

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this layout

Parameters:

pk - the primary key of this layout

getUuid

@AutoEscape
String getUuid()

Gets the uuid of this layout.

Returns:

the uuid of this layout

setUuid

void setUuid(String uuid)

Sets the uuid of this layout.

Parameters:

uuid - the uuid of this layout

getPlid

long getPlid()

Gets the plid of this layout.

Returns:

the plid of this layout

setPlid

void setPlid(long plid)

Sets the plid of this layout.

Parameters:

plid - the plid of this layout

getGroupId

long getGroupId()

Gets the group id of this layout.

Returns:

the group id of this layout

setGroupId

void setGroupId(long groupId)

Sets the group id of this layout.

Parameters:

groupId - the group id of this layout

getCompanyId

long getCompanyId()

Gets the company id of this layout.

Returns:

the company id of this layout

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this layout.

Parameters:

companyId - the company id of this layout

getPrivateLayout

boolean getPrivateLayout()

Gets the private layout of this layout.

Returns:

the private layout of this layout

isPrivateLayout

boolean isPrivateLayout()

Determines whether this layout is private layout.

Returns:

whether this layout is private layout

setPrivateLayout

void setPrivateLayout(boolean privateLayout)

Sets whether this {$entity.humanName} is private layout.

Parameters:

privateLayout - the private layout of this layout

getLayoutId

long getLayoutId()

Gets the layout id of this layout.

Returns:

the layout id of this layout

setLayoutId

void setLayoutId(long layoutId)

Sets the layout id of this layout.

Parameters:

layoutId - the layout id of this layout

getParentLayoutId

long getParentLayoutId()

Gets the parent layout id of this layout.

Returns:

the parent layout id of this layout

setParentLayoutId

void setParentLayoutId(long parentLayoutId)

Sets the parent layout id of this layout.

Parameters:

parentLayoutId - the parent layout id of this layout

getName

@AutoEscape
String getName()

Gets the name of this layout.

Returns:

the name of this layout

setName

void setName(String name)

Sets the name of this layout.

Parameters:

name - the name of this layout

getTitle

@AutoEscape
String getTitle()

Gets the title of this layout.

Returns:

the title of this layout

setTitle

void setTitle(String title)

Sets the title of this layout.

Parameters:

title - the title of this layout

getDescription

@AutoEscape
String getDescription()

Gets the description of this layout.

Returns:

the description of this layout

setDescription

void setDescription(String description)

Sets the description of this layout.

Parameters:

description - the description of this layout

getType

@AutoEscape
String getType()

Gets the type of this layout.

Returns:

the type of this layout

setType

void setType(String type)

Sets the type of this layout.

Parameters:

type - the type of this layout

getTypeSettings

@AutoEscape
String getTypeSettings()

Gets the type settings of this layout.

Returns:

the type settings of this layout

setTypeSettings

void setTypeSettings(String typeSettings)

Sets the type settings of this layout.

Parameters:

typeSettings - the type settings of this layout

getHidden

boolean getHidden()

Gets the hidden of this layout.

Returns:

the hidden of this layout

isHidden

boolean isHidden()

Determines whether this layout is hidden.

Returns:

whether this layout is hidden

setHidden

void setHidden(boolean hidden)

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

Parameters:

hidden - the hidden of this layout

getFriendlyURL

@AutoEscape
String getFriendlyURL()

Gets the friendly u r l of this layout.

Returns:

the friendly u r l of this layout

setFriendlyURL

void setFriendlyURL(String friendlyURL)

Sets the friendly u r l of this layout.

Parameters:

friendlyURL - the friendly u r l of this layout

getIconImage

boolean getIconImage()

Gets the icon image of this layout.

Returns:

the icon image of this layout

isIconImage

boolean isIconImage()

Determines whether this layout is icon image.

Returns:

whether this layout is icon image

setIconImage

void setIconImage(boolean iconImage)

Sets whether this {$entity.humanName} is icon image.

Parameters:

iconImage - the icon image of this layout

getIconImageId

long getIconImageId()

Gets the icon image id of this layout.

Returns:

the icon image id of this layout

setIconImageId

void setIconImageId(long iconImageId)

Sets the icon image id of this layout.

Parameters:

iconImageId - the icon image id of this layout

getThemeId

@AutoEscape
String getThemeId()

Gets the theme id of this layout.

Returns:

the theme id of this layout

setThemeId

void setThemeId(String themeId)

Sets the theme id of this layout.

Parameters:

themeId - the theme id of this layout

getColorSchemeId

@AutoEscape
String getColorSchemeId()

Gets the color scheme id of this layout.

Returns:

the color scheme id of this layout

setColorSchemeId

void setColorSchemeId(String colorSchemeId)

Sets the color scheme id of this layout.

Parameters:

colorSchemeId - the color scheme id of this layout

getWapThemeId

@AutoEscape
String getWapThemeId()

Gets the wap theme id of this layout.

Returns:

the wap theme id of this layout

setWapThemeId

void setWapThemeId(String wapThemeId)

Sets the wap theme id of this layout.

Parameters:

wapThemeId - the wap theme id of this layout

getWapColorSchemeId

@AutoEscape
String getWapColorSchemeId()

Gets the wap color scheme id of this layout.

Returns:

the wap color scheme id of this layout

setWapColorSchemeId

void setWapColorSchemeId(String wapColorSchemeId)

Sets the wap color scheme id of this layout.

Parameters:

wapColorSchemeId - the wap color scheme id of this layout

getCss

@AutoEscape
String getCss()

Gets the css of this layout.

Returns:

the css of this layout

setCss

void setCss(String css)

Sets the css of this layout.

Parameters:

css - the css of this layout

getPriority

int getPriority()

Gets the priority of this layout.

Returns:

the priority of this layout

setPriority

void setPriority(int priority)

Sets the priority of this layout.

Parameters:

priority - the priority of this layout

getLayoutPrototypeId

long getLayoutPrototypeId()

Gets the layout prototype id of this layout.

Returns:

the layout prototype id of this layout

setLayoutPrototypeId

void setLayoutPrototypeId(long layoutPrototypeId)

Sets the layout prototype id of this layout.

Parameters:

layoutPrototypeId - the layout prototype id of this layout

getDlFolderId

long getDlFolderId()

Gets the dl folder id of this layout.

Returns:

the dl folder id of this layout

setDlFolderId

void setDlFolderId(long dlFolderId)

Sets the dl folder id of this layout.

Parameters:

dlFolderId - the dl folder id of this layout

toEscapedModel

Layout toEscapedModel()

Gets a copy of this layout 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<Layout>

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

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

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

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

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

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

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

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

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(Layout layout)

Specified by:

compareTo in interface Comparable<Layout>

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

Returns:

the XML representation of this model instance