|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@ProviderType 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.
LayoutPrototype,
LayoutPrototypeImpl,
LayoutPrototypeModelImpl| Method Summary | |
|---|---|
Object |
clone()
Creates a shallow clone of this model instance. |
int |
compareTo(LayoutPrototype layoutPrototype)
|
boolean |
getActive()
Returns the active of this layout prototype. |
String[] |
getAvailableLanguageIds()
|
long |
getCompanyId()
Returns the company ID of this layout prototype. |
Date |
getCreateDate()
Returns the create date of this layout prototype. |
String |
getDefaultLanguageId()
|
String |
getDescription()
Returns the description of this layout prototype. |
String |
getDescription(Locale locale)
Returns the localized description of this layout prototype in the language. |
String |
getDescription(Locale locale,
boolean useDefault)
Returns the localized description of this layout prototype in the language, optionally using the default language if no localization exists for the requested language. |
String |
getDescription(String languageId)
Returns the localized description of this layout prototype in the language. |
String |
getDescription(String languageId,
boolean useDefault)
Returns the localized description of this layout prototype in the language, optionally using the default language if no localization exists for the requested language. |
String |
getDescriptionCurrentLanguageId()
|
String |
getDescriptionCurrentValue()
|
Map<Locale,String> |
getDescriptionMap()
Returns a map of the locales and localized descriptions of this layout prototype. |
ExpandoBridge |
getExpandoBridge()
Returns the expando bridge for this model instance. |
long |
getLayoutPrototypeId()
Returns the layout prototype ID of this layout prototype. |
Date |
getModifiedDate()
Returns the modified date of this layout prototype. |
long |
getMvccVersion()
Returns the mvcc version of this layout prototype. |
String |
getName()
Returns the name of this layout prototype. |
String |
getName(Locale locale)
Returns the localized name of this layout prototype in the language. |
String |
getName(Locale locale,
boolean useDefault)
Returns the localized name of this layout prototype in the language, optionally using the default language if no localization exists for the requested language. |
String |
getName(String languageId)
Returns the localized name of this layout prototype in the language. |
String |
getName(String languageId,
boolean useDefault)
Returns the localized name of this layout prototype in the language, optionally using the default language if no localization exists for the requested language. |
String |
getNameCurrentLanguageId()
|
String |
getNameCurrentValue()
|
Map<Locale,String> |
getNameMap()
Returns a map of the locales and localized names of this layout prototype. |
long |
getPrimaryKey()
Returns the primary key of this layout prototype. |
Serializable |
getPrimaryKeyObj()
Returns the primary key of this model instance. |
String |
getSettings()
Returns the settings of this layout prototype. |
long |
getUserId()
Returns the user ID of this layout prototype. |
String |
getUserName()
Returns the user name of this layout prototype. |
String |
getUserUuid()
Returns the user uuid of this layout prototype. |
String |
getUuid()
Returns the uuid of this layout prototype. |
int |
hashCode()
|
boolean |
isActive()
Returns true if this layout prototype is active. |
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 |
isNew()
Returns true if this model instance does not yet exist in
the database. |
void |
prepareLocalizedFieldsForImport()
|
void |
prepareLocalizedFieldsForImport(Locale defaultImportLocale)
|
void |
setActive(boolean active)
Sets whether this layout prototype 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 |
setCreateDate(Date createDate)
Sets the create date of this layout prototype. |
void |
setDescription(String description)
Sets the description of this layout prototype. |
void |
setDescription(String description,
Locale locale)
Sets the localized description of this layout prototype in the language. |
void |
setDescription(String description,
Locale locale,
Locale defaultLocale)
Sets the localized description of this layout prototype in the language, and sets the default locale. |
void |
setDescriptionCurrentLanguageId(String languageId)
|
void |
setDescriptionMap(Map<Locale,String> descriptionMap)
Sets the localized descriptions of this layout prototype from the map of locales and localized descriptions. |
void |
setDescriptionMap(Map<Locale,String> descriptionMap,
Locale defaultLocale)
Sets the localized descriptions of this layout prototype from the map of locales and localized descriptions, and sets the default locale. |
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 |
setLayoutPrototypeId(long layoutPrototypeId)
Sets the layout prototype ID of this layout prototype. |
void |
setModifiedDate(Date modifiedDate)
Sets the modified date of this layout prototype. |
void |
setMvccVersion(long mvccVersion)
Sets the mvcc version of this layout prototype. |
void |
setName(String name)
Sets the name of this layout prototype. |
void |
setName(String name,
Locale locale)
Sets the localized name of this layout prototype in the language. |
void |
setName(String name,
Locale locale,
Locale defaultLocale)
Sets the localized name of this layout prototype in the language, and sets the default locale. |
void |
setNameCurrentLanguageId(String languageId)
|
void |
setNameMap(Map<Locale,String> nameMap)
Sets the localized names of this layout prototype from the map of locales and localized names. |
void |
setNameMap(Map<Locale,String> nameMap,
Locale defaultLocale)
Sets the localized names of this layout prototype from the map of locales and localized names, and sets the default locale. |
void |
setNew(boolean n)
Sets whether this model instance does not yet exist in the database. |
void |
setPrimaryKey(long primaryKey)
Sets the primary key of this layout prototype. |
void |
setPrimaryKeyObj(Serializable primaryKeyObj)
Sets the primary key of this model instance. |
void |
setSettings(String settings)
Sets the settings of this layout prototype. |
void |
setUserId(long userId)
Sets the user ID of this layout prototype. |
void |
setUserName(String userName)
Sets the user name of this layout prototype. |
void |
setUserUuid(String userUuid)
Sets the user uuid of this layout prototype. |
void |
setUuid(String uuid)
Sets the uuid of this layout prototype. |
CacheModel<LayoutPrototype> |
toCacheModel()
Returns a cache model object for this entity used by entity cache. |
LayoutPrototype |
toEscapedModel()
Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler. |
String |
toString()
|
LayoutPrototype |
toUnescapedModel()
|
String |
toXmlString()
Returns the XML representation of this model instance. |
| Methods inherited from interface com.liferay.portal.model.BaseModel |
|---|
getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes |
| Methods inherited from interface com.liferay.portal.model.StagedModel |
|---|
getStagedModelType |
| Methods inherited from interface com.liferay.portal.model.ClassedModel |
|---|
getModelClass, getModelClassName |
| Method Detail |
|---|
long getPrimaryKey()
void setPrimaryKey(long primaryKey)
primaryKey - the primary key of this layout prototypelong getMvccVersion()
getMvccVersion in interface MVCCModelvoid setMvccVersion(long mvccVersion)
setMvccVersion in interface MVCCModelmvccVersion - the mvcc version of this layout prototype@AutoEscape String getUuid()
getUuid in interface StagedModelvoid setUuid(String uuid)
setUuid in interface StagedModeluuid - the uuid of this layout prototypelong getLayoutPrototypeId()
void setLayoutPrototypeId(long layoutPrototypeId)
layoutPrototypeId - the layout prototype ID of this layout prototypelong getCompanyId()
getCompanyId in interface AuditedModelgetCompanyId in interface ShardedModelgetCompanyId in interface StagedModelvoid setCompanyId(long companyId)
setCompanyId in interface AuditedModelsetCompanyId in interface ShardedModelsetCompanyId in interface StagedModelcompanyId - the company ID of this layout prototypelong getUserId()
getUserId in interface AuditedModelvoid setUserId(long userId)
setUserId in interface AuditedModeluserId - the user ID of this layout prototypeString getUserUuid()
getUserUuid in interface AuditedModelvoid setUserUuid(String userUuid)
setUserUuid in interface AuditedModeluserUuid - the user uuid of this layout prototype@AutoEscape String getUserName()
getUserName in interface AuditedModelvoid setUserName(String userName)
setUserName in interface AuditedModeluserName - the user name of this layout prototypeDate getCreateDate()
getCreateDate in interface AuditedModelgetCreateDate in interface StagedModelvoid setCreateDate(Date createDate)
setCreateDate in interface AuditedModelsetCreateDate in interface StagedModelcreateDate - the create date of this layout prototypeDate getModifiedDate()
getModifiedDate in interface AuditedModelgetModifiedDate in interface StagedModelvoid setModifiedDate(Date modifiedDate)
setModifiedDate in interface AuditedModelsetModifiedDate in interface StagedModelmodifiedDate - the modified date of this layout prototypeString getName()
@AutoEscape String getName(Locale locale)
locale - the locale of the language
@AutoEscape
String getName(Locale locale,
boolean useDefault)
locale - the local of the languageuseDefault - 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.@AutoEscape String getName(String languageId)
languageId - the ID of the language
@AutoEscape
String getName(String languageId,
boolean useDefault)
languageId - the ID of the languageuseDefault - whether to use the default language if no localization exists for the requested language
@AutoEscape String getNameCurrentLanguageId()
@AutoEscape String getNameCurrentValue()
Map<Locale,String> getNameMap()
void setName(String name)
name - the name of this layout prototype
void setName(String name,
Locale locale)
name - the localized name of this layout prototypelocale - the locale of the language
void setName(String name,
Locale locale,
Locale defaultLocale)
name - the localized name of this layout prototypelocale - the locale of the languagedefaultLocale - the default localevoid setNameCurrentLanguageId(String languageId)
void setNameMap(Map<Locale,String> nameMap)
nameMap - the locales and localized names of this layout prototype
void setNameMap(Map<Locale,String> nameMap,
Locale defaultLocale)
nameMap - the locales and localized names of this layout prototypedefaultLocale - the default localeString getDescription()
@AutoEscape String getDescription(Locale locale)
locale - the locale of the language
@AutoEscape
String getDescription(Locale locale,
boolean useDefault)
locale - the local of the languageuseDefault - 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.@AutoEscape String getDescription(String languageId)
languageId - the ID of the language
@AutoEscape
String getDescription(String languageId,
boolean useDefault)
languageId - the ID of the languageuseDefault - whether to use the default language if no localization exists for the requested language
@AutoEscape String getDescriptionCurrentLanguageId()
@AutoEscape String getDescriptionCurrentValue()
Map<Locale,String> getDescriptionMap()
void setDescription(String description)
description - the description of this layout prototype
void setDescription(String description,
Locale locale)
description - the localized description of this layout prototypelocale - the locale of the language
void setDescription(String description,
Locale locale,
Locale defaultLocale)
description - the localized description of this layout prototypelocale - the locale of the languagedefaultLocale - the default localevoid setDescriptionCurrentLanguageId(String languageId)
void setDescriptionMap(Map<Locale,String> descriptionMap)
descriptionMap - the locales and localized descriptions of this layout prototype
void setDescriptionMap(Map<Locale,String> descriptionMap,
Locale defaultLocale)
descriptionMap - the locales and localized descriptions of this layout prototypedefaultLocale - the default locale@AutoEscape String getSettings()
void setSettings(String settings)
settings - the settings of this layout prototypeboolean getActive()
boolean isActive()
true if this layout prototype is active.
true if this layout prototype is active; false otherwisevoid setActive(boolean active)
active - the active of this layout prototypeboolean isNew()
BaseModeltrue if this model instance does not yet exist in
the database.
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()
BaseModeltrue if this model instance was retrieved from the
entity cache.
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 cacheEntityCacheboolean isEscapedModel()
BaseModeltrue if this model instance is escaped.
isEscapedModel in interface BaseModel<LayoutPrototype>true if this model instance is escaped;
false otherwiseSerializable getPrimaryKeyObj()
BaseModel
getPrimaryKeyObj in interface BaseModel<LayoutPrototype>getPrimaryKeyObj in interface ClassedModelvoid setPrimaryKeyObj(Serializable primaryKeyObj)
BaseModel
setPrimaryKeyObj in interface BaseModel<LayoutPrototype>setPrimaryKeyObj in interface ClassedModelprimaryKeyObj - the primary key of this model instanceExpandoBridge getExpandoBridge()
BaseModel
getExpandoBridge in interface BaseModel<LayoutPrototype>getExpandoBridge in interface ClassedModelvoid setExpandoBridgeAttributes(BaseModel<?> baseModel)
setExpandoBridgeAttributes in interface BaseModel<LayoutPrototype>void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
setExpandoBridgeAttributes in interface BaseModel<LayoutPrototype>void setExpandoBridgeAttributes(ServiceContext serviceContext)
BaseModel
setExpandoBridgeAttributes in interface BaseModel<LayoutPrototype>serviceContext - the service context to be appliedServiceContext.getExpandoBridgeAttributes()String[] getAvailableLanguageIds()
getAvailableLanguageIds in interface LocalizedModelString getDefaultLanguageId()
getDefaultLanguageId in interface LocalizedModel
void prepareLocalizedFieldsForImport()
throws LocaleException
prepareLocalizedFieldsForImport in interface LocalizedModelLocaleException
void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
throws LocaleException
prepareLocalizedFieldsForImport in interface LocalizedModelLocaleExceptionObject clone()
BaseModel
clone in interface BaseModel<LayoutPrototype>clone in interface StagedModelint compareTo(LayoutPrototype layoutPrototype)
compareTo in interface Comparable<LayoutPrototype>int hashCode()
hashCode in class ObjectCacheModel<LayoutPrototype> toCacheModel()
BaseModel
toCacheModel in interface BaseModel<LayoutPrototype>LayoutPrototype toEscapedModel()
BaseModelAutoEscapeBeanHandler.
toEscapedModel in interface BaseModel<LayoutPrototype>AutoEscapeBeanHandlerLayoutPrototype toUnescapedModel()
toUnescapedModel in interface BaseModel<LayoutPrototype>String toString()
toString in class ObjectString toXmlString()
BaseModel
toXmlString in interface BaseModel<LayoutPrototype>
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||