|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LayoutPrototypeModel
The base model interface for the LayoutPrototype service. Represents a row in the "LayoutPrototype" database table, with each column mapped to a property of this class.
This interface and its corresponding implementation LayoutPrototypeModelImpl
exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in LayoutPrototypeImpl
.
Never modify or reference this interface directly. All methods that expect a layout prototype model instance should use the LayoutPrototype
interface instead.
LayoutPrototype
,
LayoutPrototypeImpl
,
LayoutPrototypeModelImpl
Method Summary | |
---|---|
Object |
clone()
Creates a shallow clone of this model instance. |
int |
compareTo(LayoutPrototype layoutPrototype)
|
boolean |
getActive()
Gets the active of this layout prototype. |
long |
getCompanyId()
Gets the company id of this layout prototype. |
String |
getDescription()
Gets the description of this layout prototype. |
ExpandoBridge |
getExpandoBridge()
Gets the expando bridge for this model instance. |
long |
getLayoutPrototypeId()
Gets the layout prototype id of this layout prototype. |
String |
getName()
Gets the name of this layout prototype. |
String |
getName(Locale locale)
Gets the localized name of this layout prototype. |
String |
getName(Locale locale,
boolean useDefault)
Gets the localized name of this layout 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 prototype. |
String |
getName(String languageId,
boolean useDefault)
Gets the localized name of this layout 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 prototype. |
long |
getPrimaryKey()
Gets the primary key of this layout prototype. |
Serializable |
getPrimaryKeyObj()
Gets the primary key of this model instance. |
String |
getSettings()
Gets the settings of this layout prototype. |
int |
hashCode()
|
boolean |
isActive()
Determines whether this layout 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 prototype. |
void |
setDescription(String description)
Sets the description of this layout 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 |
setLayoutPrototypeId(long layoutPrototypeId)
Sets the layout prototype id of this layout prototype. |
void |
setName(Locale locale,
String name)
Sets the localized name of this layout prototype. |
void |
setName(String name)
Sets the name of this layout prototype. |
void |
setNameMap(Map<Locale,String> nameMap)
Sets the localized names of this layout 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 prototype |
void |
setSettings(String settings)
Sets the settings of this layout prototype. |
LayoutPrototype |
toEscapedModel()
Gets a copy of this layout 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 |
---|
long getPrimaryKey()
void setPrimaryKey(long pk)
pk
- the primary key of this layout prototypelong getLayoutPrototypeId()
void setLayoutPrototypeId(long layoutPrototypeId)
layoutPrototypeId
- the layout prototype id of this layout prototypelong getCompanyId()
void setCompanyId(long companyId)
companyId
- the company id of this layout prototypeString getName()
String getName(Locale locale)
locale
- the locale to get the localized name for
String getName(Locale locale, boolean useDefault)
locale
- the local to get the localized name foruseDefault
- whether to use the default language if no localization exists for the requested language
useDefault
is false
and no localization exists for the requested language, an empty string will be returned.String getName(String languageId)
languageId
- the id of the language to get the localized name for
String getName(String languageId, boolean useDefault)
languageId
- the id of the language to get the localized name foruseDefault
- whether to use the default language if no localization exists for the requested language
Map<Locale,String> getNameMap()
void setName(String name)
name
- the name of this layout prototypevoid setName(Locale locale, String name)
locale
- the locale to set the localized name forname
- the localized name of this layout prototypevoid setNameMap(Map<Locale,String> nameMap)
nameMap
- the locales and localized names of this layout prototype@AutoEscape String getDescription()
void setDescription(String description)
description
- the description of this layout prototype@AutoEscape String getSettings()
void setSettings(String settings)
settings
- the settings of this layout prototypeboolean getActive()
boolean isActive()
void setActive(boolean active)
active
- the active of this layout prototypeLayoutPrototype toEscapedModel()
AutoEscapeBeanHandler
.
AutoEscapeBeanHandler
boolean isNew()
BaseModel
isNew
in interface BaseModel<LayoutPrototype>
true
if this model instance does not yet exist in
the database; false
otherwisevoid setNew(boolean n)
BaseModel
setNew
in interface BaseModel<LayoutPrototype>
n
- whether this model instance does not yet exist in the databaseboolean isCachedModel()
BaseModel
isCachedModel
in interface BaseModel<LayoutPrototype>
true
if this model instance was retrieved from the
entity cache; false
otherwiseBaseModel.setCachedModel(boolean)
void setCachedModel(boolean cachedModel)
BaseModel
setCachedModel
in interface BaseModel<LayoutPrototype>
cachedModel
- whether this model instance was retrieved from the
entity cacheEntityCache
boolean isEscapedModel()
BaseModel
isEscapedModel
in interface BaseModel<LayoutPrototype>
true
if this model instance is escaped;
false
otherwiseBaseModel.setEscapedModel(boolean)
void setEscapedModel(boolean escapedModel)
BaseModel
A model instance can be made escaped by wrapping it with an HTML auto
escape handler using its toEscapedModel
method. For example,
UserModel.toEscapedModel()
.
setEscapedModel
in interface BaseModel<LayoutPrototype>
escapedModel
- whether this model instance is escapedAutoEscapeBeanHandler
Serializable getPrimaryKeyObj()
BaseModel
getPrimaryKeyObj
in interface BaseModel<LayoutPrototype>
ExpandoBridge getExpandoBridge()
BaseModel
getExpandoBridge
in interface BaseModel<LayoutPrototype>
void setExpandoBridgeAttributes(ServiceContext serviceContext)
BaseModel
setExpandoBridgeAttributes
in interface BaseModel<LayoutPrototype>
serviceContext
- the service context to retrieve the expando bridge
attributes fromServiceContext.getExpandoBridgeAttributes(
)
Object clone()
BaseModel
clone
in interface BaseModel<LayoutPrototype>
int compareTo(LayoutPrototype layoutPrototype)
compareTo
in interface Comparable<LayoutPrototype>
int hashCode()
hashCode
in class Object
String toString()
toString
in class Object
String toXmlString()
BaseModel
toXmlString
in interface BaseModel<LayoutPrototype>
|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |