@ProviderType public interface LayoutPrototypeModel extends BaseModel<LayoutPrototype>, LocalizedModel, MVCCModel, StagedAuditedModel
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| Modifier and Type | Method and Description |
|---|---|
java.lang.Object |
clone()
Creates a shallow clone of this model instance.
|
int |
compareTo(LayoutPrototype layoutPrototype) |
boolean |
getActive()
Returns the active of this layout prototype.
|
java.lang.String[] |
getAvailableLanguageIds() |
long |
getCompanyId()
Returns the company ID of this layout prototype.
|
java.util.Date |
getCreateDate()
Returns the create date of this layout prototype.
|
java.lang.String |
getDefaultLanguageId() |
java.lang.String |
getDescription()
Returns the description of this layout prototype.
|
java.lang.String |
getDescription(java.util.Locale locale)
Returns the localized description of this layout prototype in the language.
|
java.lang.String |
getDescription(java.util.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.
|
java.lang.String |
getDescription(java.lang.String languageId)
Returns the localized description of this layout prototype in the language.
|
java.lang.String |
getDescription(java.lang.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.
|
java.lang.String |
getDescriptionCurrentLanguageId() |
java.lang.String |
getDescriptionCurrentValue() |
java.util.Map<java.util.Locale,java.lang.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.
|
java.util.Date |
getLastPublishDate()
Returns the last publish date of this layout prototype.
|
long |
getLayoutPrototypeId()
Returns the layout prototype ID of this layout prototype.
|
java.util.Date |
getModifiedDate()
Returns the modified date of this layout prototype.
|
long |
getMvccVersion()
Returns the mvcc version of this layout prototype.
|
java.lang.String |
getName()
Returns the name of this layout prototype.
|
java.lang.String |
getName(java.util.Locale locale)
Returns the localized name of this layout prototype in the language.
|
java.lang.String |
getName(java.util.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.
|
java.lang.String |
getName(java.lang.String languageId)
Returns the localized name of this layout prototype in the language.
|
java.lang.String |
getName(java.lang.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.
|
java.lang.String |
getNameCurrentLanguageId() |
java.lang.String |
getNameCurrentValue() |
java.util.Map<java.util.Locale,java.lang.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.
|
java.io.Serializable |
getPrimaryKeyObj()
Returns the primary key of this model instance.
|
java.lang.String |
getSettings()
Returns the settings of this layout prototype.
|
long |
getUserId()
Returns the user ID of this layout prototype.
|
java.lang.String |
getUserName()
Returns the user name of this layout prototype.
|
java.lang.String |
getUserUuid()
Returns the user uuid of this layout prototype.
|
java.lang.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(java.util.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(java.util.Date createDate)
Sets the create date of this layout prototype.
|
void |
setDescription(java.lang.String description)
Sets the description of this layout prototype.
|
void |
setDescription(java.lang.String description,
java.util.Locale locale)
Sets the localized description of this layout prototype in the language.
|
void |
setDescription(java.lang.String description,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized description of this layout prototype in the language, and sets the default locale.
|
void |
setDescriptionCurrentLanguageId(java.lang.String languageId) |
void |
setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap)
Sets the localized descriptions of this layout prototype from the map of locales and localized descriptions.
|
void |
setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.util.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 |
setLastPublishDate(java.util.Date lastPublishDate)
Sets the last publish date of this layout prototype.
|
void |
setLayoutPrototypeId(long layoutPrototypeId)
Sets the layout prototype ID of this layout prototype.
|
void |
setModifiedDate(java.util.Date modifiedDate)
Sets the modified date of this layout prototype.
|
void |
setMvccVersion(long mvccVersion)
Sets the mvcc version of this layout prototype.
|
void |
setName(java.lang.String name)
Sets the name of this layout prototype.
|
void |
setName(java.lang.String name,
java.util.Locale locale)
Sets the localized name of this layout prototype in the language.
|
void |
setName(java.lang.String name,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized name of this layout prototype in the language, and sets the default locale.
|
void |
setNameCurrentLanguageId(java.lang.String languageId) |
void |
setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap)
Sets the localized names of this layout prototype from the map of locales and localized names.
|
void |
setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.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(java.io.Serializable primaryKeyObj)
Sets the primary key of this model instance.
|
void |
setSettings(java.lang.String settings)
Sets the settings of this layout prototype.
|
void |
setUserId(long userId)
Sets the user ID of this layout prototype.
|
void |
setUserName(java.lang.String userName)
Sets the user name of this layout prototype.
|
void |
setUserUuid(java.lang.String userUuid)
Sets the user uuid of this layout prototype.
|
void |
setUuid(java.lang.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. |
java.lang.String |
toString() |
LayoutPrototype |
toUnescapedModel() |
java.lang.String |
toXmlString()
Returns the XML representation of this model instance.
|
getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributesgetStagedModelTypegetModelClass, getModelClassNamelong 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 java.lang.String getUuid()
getUuid in interface StagedModelvoid setUuid(java.lang.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 StagedModelvoid setCompanyId(long companyId)
setCompanyId in interface AuditedModelsetCompanyId 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 prototypejava.lang.String getUserUuid()
getUserUuid in interface AuditedModelvoid setUserUuid(java.lang.String userUuid)
setUserUuid in interface AuditedModeluserUuid - the user uuid of this layout prototype@AutoEscape java.lang.String getUserName()
getUserName in interface AuditedModelvoid setUserName(java.lang.String userName)
setUserName in interface AuditedModeluserName - the user name of this layout prototypejava.util.Date getCreateDate()
getCreateDate in interface AuditedModelgetCreateDate in interface StagedModelvoid setCreateDate(java.util.Date createDate)
setCreateDate in interface AuditedModelsetCreateDate in interface StagedModelcreateDate - the create date of this layout prototypejava.util.Date getModifiedDate()
getModifiedDate in interface AuditedModelgetModifiedDate in interface StagedModelvoid setModifiedDate(java.util.Date modifiedDate)
setModifiedDate in interface AuditedModelsetModifiedDate in interface StagedModelmodifiedDate - the modified date of this layout prototypejava.lang.String getName()
@AutoEscape java.lang.String getName(java.util.Locale locale)
locale - the locale of the language@AutoEscape java.lang.String getName(java.util.Locale locale, boolean useDefault)
locale - the local of the languageuseDefault - whether to use the default language if no localization exists for the requested languageuseDefault is false and no localization exists for the requested language, an empty string will be returned.@AutoEscape java.lang.String getName(java.lang.String languageId)
languageId - the ID of the language@AutoEscape java.lang.String getName(java.lang.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 java.lang.String getNameCurrentLanguageId()
@AutoEscape java.lang.String getNameCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getNameMap()
void setName(java.lang.String name)
name - the name of this layout prototypevoid setName(java.lang.String name,
java.util.Locale locale)
name - the localized name of this layout prototypelocale - the locale of the languagevoid setName(java.lang.String name,
java.util.Locale locale,
java.util.Locale defaultLocale)
name - the localized name of this layout prototypelocale - the locale of the languagedefaultLocale - the default localevoid setNameCurrentLanguageId(java.lang.String languageId)
void setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap)
nameMap - the locales and localized names of this layout prototypevoid setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Locale defaultLocale)
nameMap - the locales and localized names of this layout prototypedefaultLocale - the default localejava.lang.String getDescription()
@AutoEscape java.lang.String getDescription(java.util.Locale locale)
locale - the locale of the language@AutoEscape java.lang.String getDescription(java.util.Locale locale, boolean useDefault)
locale - the local of the languageuseDefault - whether to use the default language if no localization exists for the requested languageuseDefault is false and no localization exists for the requested language, an empty string will be returned.@AutoEscape java.lang.String getDescription(java.lang.String languageId)
languageId - the ID of the language@AutoEscape java.lang.String getDescription(java.lang.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 java.lang.String getDescriptionCurrentLanguageId()
@AutoEscape java.lang.String getDescriptionCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getDescriptionMap()
void setDescription(java.lang.String description)
description - the description of this layout prototypevoid setDescription(java.lang.String description,
java.util.Locale locale)
description - the localized description of this layout prototypelocale - the locale of the languagevoid setDescription(java.lang.String description,
java.util.Locale locale,
java.util.Locale defaultLocale)
description - the localized description of this layout prototypelocale - the locale of the languagedefaultLocale - the default localevoid setDescriptionCurrentLanguageId(java.lang.String languageId)
void setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap)
descriptionMap - the locales and localized descriptions of this layout prototypevoid setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.util.Locale defaultLocale)
descriptionMap - the locales and localized descriptions of this layout prototypedefaultLocale - the default locale@AutoEscape java.lang.String getSettings()
void setSettings(java.lang.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 prototypejava.util.Date getLastPublishDate()
getLastPublishDate in interface StagedModelvoid setLastPublishDate(java.util.Date lastPublishDate)
setLastPublishDate in interface StagedModellastPublishDate - the last publish date 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)
BaseModelsetNew 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)
BaseModelsetCachedModel 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 otherwisejava.io.Serializable getPrimaryKeyObj()
BaseModelgetPrimaryKeyObj in interface BaseModel<LayoutPrototype>getPrimaryKeyObj in interface ClassedModelvoid setPrimaryKeyObj(java.io.Serializable primaryKeyObj)
BaseModelsetPrimaryKeyObj in interface BaseModel<LayoutPrototype>setPrimaryKeyObj in interface ClassedModelprimaryKeyObj - the primary key of this model instanceExpandoBridge getExpandoBridge()
BaseModelgetExpandoBridge 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)
BaseModelsetExpandoBridgeAttributes in interface BaseModel<LayoutPrototype>serviceContext - the service context to be appliedServiceContext.getExpandoBridgeAttributes(
)java.lang.String[] getAvailableLanguageIds()
getAvailableLanguageIds in interface LocalizedModeljava.lang.String getDefaultLanguageId()
getDefaultLanguageId in interface LocalizedModelvoid prepareLocalizedFieldsForImport()
throws LocaleException
prepareLocalizedFieldsForImport in interface LocalizedModelLocaleExceptionvoid prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
throws LocaleException
prepareLocalizedFieldsForImport in interface LocalizedModelLocaleExceptionjava.lang.Object clone()
BaseModelclone in interface BaseModel<LayoutPrototype>clone in interface StagedModelint compareTo(LayoutPrototype layoutPrototype)
compareTo in interface java.lang.Comparable<LayoutPrototype>int hashCode()
hashCode in class java.lang.ObjectCacheModel<LayoutPrototype> toCacheModel()
BaseModeltoCacheModel in interface BaseModel<LayoutPrototype>LayoutPrototype toEscapedModel()
BaseModelAutoEscapeBeanHandler.toEscapedModel in interface BaseModel<LayoutPrototype>AutoEscapeBeanHandlerLayoutPrototype toUnescapedModel()
toUnescapedModel in interface BaseModel<LayoutPrototype>java.lang.String toString()
toString in class java.lang.Objectjava.lang.String toXmlString()
BaseModeltoXmlString in interface BaseModel<LayoutPrototype>