com.liferay.portal.model
Interface LayoutSetPrototypeModel

All Superinterfaces:

BaseModel<LayoutSetPrototype>, Cloneable, Comparable<LayoutSetPrototype>, Serializable

All Known Subinterfaces:

LayoutSetPrototype

All Known Implementing Classes:

LayoutSetPrototypeImpl, LayoutSetPrototypeModelImpl, LayoutSetPrototypeWrapper

public interface LayoutSetPrototypeModel
extends BaseModel<LayoutSetPrototype>

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

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

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

See Also:

LayoutSetPrototype, LayoutSetPrototypeImpl, LayoutSetPrototypeModelImpl

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(LayoutSetPrototype layoutSetPrototype)
boolean	getActive() Gets the active of this layout set prototype.
long	getCompanyId() Gets the company id of this layout set prototype.
String	getDescription() Gets the description of this layout set prototype.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
long	getLayoutSetPrototypeId() Gets the layout set prototype id of this layout set prototype.
String	getName() Gets the name of this layout set prototype.
String	getName(Locale locale) Gets the localized name of this layout set prototype.
String	getName(Locale locale, boolean useDefault) Gets the localized name of this layout set prototype, optionally using the default language if no localization exists for the requested language.
String	getName(String languageId) Gets the localized name of this layout set prototype.
String	getName(String languageId, boolean useDefault) Gets the localized name of this layout set prototype, optionally using the default language if no localization exists for the requested language.
Map<Locale,String>	getNameMap() Gets a map of the locales and localized name of this layout set prototype.
long	getPrimaryKey() Gets the primary key of this layout set prototype.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
String	getSettings() Gets the settings of this layout set prototype.
int	hashCode()
boolean	isActive() Determines whether this layout set prototype is active.
boolean	isCachedModel() Determines if this model instance was retrieved from the entity cache.
boolean	isEscapedModel() Determines if this model instance is escaped.
boolean	isNew() Determines if this model instance does not yet exist in the database.
void	setActive(boolean active) Sets whether this {$entity.humanName} is active.
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 set prototype.
void	setDescription(String description) Sets the description of this layout set prototype.
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	setLayoutSetPrototypeId(long layoutSetPrototypeId) Sets the layout set prototype id of this layout set prototype.
void	setName(Locale locale, String name) Sets the localized name of this layout set prototype.
void	setName(String name) Sets the name of this layout set prototype.
void	setNameMap(Map<Locale,String> nameMap) Sets the localized names of this layout set prototype from the map of locales and localized names.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setPrimaryKey(long pk) Sets the primary key of this layout set prototype
void	setSettings(String settings) Sets the settings of this layout set prototype.
LayoutSetPrototype	toEscapedModel() Gets a copy of this layout set prototype 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 set prototype.

Returns:

the primary key of this layout set prototype

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this layout set prototype

Parameters:

pk - the primary key of this layout set prototype

getLayoutSetPrototypeId

long getLayoutSetPrototypeId()

Gets the layout set prototype id of this layout set prototype.

Returns:

the layout set prototype id of this layout set prototype

setLayoutSetPrototypeId

void setLayoutSetPrototypeId(long layoutSetPrototypeId)

Sets the layout set prototype id of this layout set prototype.

Parameters:

layoutSetPrototypeId - the layout set prototype id of this layout set prototype

getCompanyId

long getCompanyId()

Gets the company id of this layout set prototype.

Returns:

the company id of this layout set prototype

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this layout set prototype.

Parameters:

companyId - the company id of this layout set prototype

getName

String getName()

Gets the name of this layout set prototype.

Returns:

the name of this layout set prototype

getName

String getName(Locale locale)

Gets the localized name of this layout set prototype. Uses the default language if no localization exists for the requested language.

Parameters:

locale - the locale to get the localized name for

Returns:

the localized name of this layout set prototype

getName

String getName(Locale locale,
               boolean useDefault)

Gets the localized name of this layout set prototype, optionally using the default language if no localization exists for the requested language.

Parameters:

locale - the local to get the localized name for

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized name of this layout set prototype. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getName

String getName(String languageId)

Gets the localized name of this layout set prototype. Uses the default language if no localization exists for the requested language.

Parameters:

languageId - the id of the language to get the localized name for

Returns:

the localized name of this layout set prototype

getName

String getName(String languageId,
               boolean useDefault)

Gets the localized name of this layout set prototype, optionally using the default language if no localization exists for the requested language.

Parameters:

languageId - the id of the language to get the localized name for

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized name of this layout set prototype

getNameMap

Map<Locale,String> getNameMap()

Gets a map of the locales and localized name of this layout set prototype.

Returns:

the locales and localized name

setName

void setName(String name)

Sets the name of this layout set prototype.

Parameters:

name - the name of this layout set prototype

setName

void setName(Locale locale,
             String name)

Sets the localized name of this layout set prototype.

Parameters:

locale - the locale to set the localized name for

name - the localized name of this layout set prototype

setNameMap

void setNameMap(Map<Locale,String> nameMap)

Sets the localized names of this layout set prototype from the map of locales and localized names.

Parameters:

nameMap - the locales and localized names of this layout set prototype

getDescription

@AutoEscape
String getDescription()

Gets the description of this layout set prototype.

Returns:

the description of this layout set prototype

setDescription

void setDescription(String description)

Sets the description of this layout set prototype.

Parameters:

description - the description of this layout set prototype

getSettings

@AutoEscape
String getSettings()

Gets the settings of this layout set prototype.

Returns:

the settings of this layout set prototype

setSettings

void setSettings(String settings)

Sets the settings of this layout set prototype.

Parameters:

settings - the settings of this layout set prototype

getActive

boolean getActive()

Gets the active of this layout set prototype.

Returns:

the active of this layout set prototype

isActive

boolean isActive()

Determines whether this layout set prototype is active.

Returns:

whether this layout set prototype is active

setActive

void setActive(boolean active)

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

Parameters:

active - the active of this layout set prototype

toEscapedModel

LayoutSetPrototype toEscapedModel()

Gets a copy of this layout set prototype 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<LayoutSetPrototype>

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

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

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

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

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

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

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

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

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(LayoutSetPrototype layoutSetPrototype)

Specified by:

compareTo in interface Comparable<LayoutSetPrototype>

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

Returns:

the XML representation of this model instance