Package com.liferay.portal.kernel.model
Interface LayoutPrototypeModel
- All Superinterfaces:
AuditedModel,BaseModel<LayoutPrototype>,ClassedModel,Cloneable,Comparable<LayoutPrototype>,CTModel<LayoutPrototype>,LocalizedModel,MVCCModel,Serializable,ShardedModel,StagedAuditedModel,StagedModel
- All Known Subinterfaces:
LayoutPrototype
- All Known Implementing Classes:
LayoutPrototypeWrapper
@ProviderType
public interface LayoutPrototypeModel
extends BaseModel<LayoutPrototype>, CTModel<LayoutPrototype>, LocalizedModel, MVCCModel, ShardedModel, StagedAuditedModel
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 com.liferay.portal.model.impl.LayoutPrototypeModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in com.liferay.portal.model.impl.LayoutPrototypeImpl.
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionbooleanReturns the active of this layout prototype.String[]longReturns the company ID of this layout prototype.Returns the create date of this layout prototype.longReturns the ct collection ID of this layout prototype.Returns the description of this layout prototype.getDescription(String languageId) Returns the localized description of this layout prototype in the language.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.getDescription(Locale locale) Returns the localized description of this layout prototype in the language.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.Returns a map of the locales and localized descriptions of this layout prototype.longReturns the layout prototype ID of this layout prototype.Returns the modified date of this layout prototype.longReturns the mvcc version of this layout prototype.getName()Returns the name of this layout prototype.Returns the localized name of this layout prototype in the language.Returns the localized name of this layout prototype in the language, optionally using the default language if no localization exists for the requested language.Returns the localized name of this layout prototype in the language.Returns the localized name of this layout prototype in the language, optionally using the default language if no localization exists for the requested language.Returns a map of the locales and localized names of this layout prototype.longReturns the primary key of this layout prototype.Returns the settings of this layout prototype.longReturns the user ID of this layout prototype.Returns the user name of this layout prototype.Returns the user uuid of this layout prototype.getUuid()Returns the uuid of this layout prototype.booleanisActive()Returnstrueif this layout prototype is active.voidvoidprepareLocalizedFieldsForImport(Locale defaultImportLocale) voidsetActive(boolean active) Sets whether this layout prototype is active.voidsetCompanyId(long companyId) Sets the company ID of this layout prototype.voidsetCreateDate(Date createDate) Sets the create date of this layout prototype.voidsetCtCollectionId(long ctCollectionId) Sets the ct collection ID of this layout prototype.voidsetDescription(String description) Sets the description of this layout prototype.voidsetDescription(String description, Locale locale) Sets the localized description of this layout prototype in the language.voidsetDescription(String description, Locale locale, Locale defaultLocale) Sets the localized description of this layout prototype in the language, and sets the default locale.voidsetDescriptionCurrentLanguageId(String languageId) voidsetDescriptionMap(Map<Locale, String> descriptionMap) Sets the localized descriptions of this layout prototype from the map of locales and localized descriptions.voidsetDescriptionMap(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.voidsetLayoutPrototypeId(long layoutPrototypeId) Sets the layout prototype ID of this layout prototype.voidsetModifiedDate(Date modifiedDate) Sets the modified date of this layout prototype.voidsetMvccVersion(long mvccVersion) Sets the mvcc version of this layout prototype.voidSets the name of this layout prototype.voidSets the localized name of this layout prototype in the language.voidSets the localized name of this layout prototype in the language, and sets the default locale.voidsetNameCurrentLanguageId(String languageId) voidsetNameMap(Map<Locale, String> nameMap) Sets the localized names of this layout prototype from the map of locales and localized names.voidsetNameMap(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.voidsetPrimaryKey(long primaryKey) Sets the primary key of this layout prototype.voidsetSettings(String settings) Sets the settings of this layout prototype.voidsetUserId(long userId) Sets the user ID of this layout prototype.voidsetUserName(String userName) Sets the user name of this layout prototype.voidsetUserUuid(String userUuid) Sets the user uuid of this layout prototype.voidSets the uuid of this layout prototype.default StringMethods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModelMethods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassNameMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone, getStagedModelType
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this layout prototype.- Specified by:
getPrimaryKeyin interfaceCTModel<LayoutPrototype>- Returns:
- the primary key of this layout prototype
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this layout prototype.- Specified by:
setPrimaryKeyin interfaceCTModel<LayoutPrototype>- Parameters:
primaryKey- the primary key of this layout prototype
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this layout prototype.- Specified by:
getMvccVersionin interfaceMVCCModel- Returns:
- the mvcc version of this layout prototype
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this layout prototype.- Specified by:
setMvccVersionin interfaceMVCCModel- Parameters:
mvccVersion- the mvcc version of this layout prototype
-
getCtCollectionId
long getCtCollectionId()Returns the ct collection ID of this layout prototype.- Specified by:
getCtCollectionIdin interfaceCTModel<LayoutPrototype>- Returns:
- the ct collection ID of this layout prototype
-
setCtCollectionId
void setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this layout prototype.- Specified by:
setCtCollectionIdin interfaceCTModel<LayoutPrototype>- Parameters:
ctCollectionId- the ct collection ID of this layout prototype
-
getUuid
Returns the uuid of this layout prototype.- Specified by:
getUuidin interfaceStagedModel- Returns:
- the uuid of this layout prototype
-
setUuid
Sets the uuid of this layout prototype.- Specified by:
setUuidin interfaceStagedModel- Parameters:
uuid- the uuid of this layout prototype
-
getLayoutPrototypeId
long getLayoutPrototypeId()Returns the layout prototype ID of this layout prototype.- Returns:
- the layout prototype ID of this layout prototype
-
setLayoutPrototypeId
void setLayoutPrototypeId(long layoutPrototypeId) Sets the layout prototype ID of this layout prototype.- Parameters:
layoutPrototypeId- the layout prototype ID of this layout prototype
-
getCompanyId
long getCompanyId()Returns the company ID of this layout prototype.- Specified by:
getCompanyIdin interfaceAuditedModel- Specified by:
getCompanyIdin interfaceShardedModel- Specified by:
getCompanyIdin interfaceStagedModel- Returns:
- the company ID of this layout prototype
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this layout prototype.- Specified by:
setCompanyIdin interfaceAuditedModel- Specified by:
setCompanyIdin interfaceShardedModel- Specified by:
setCompanyIdin interfaceStagedModel- Parameters:
companyId- the company ID of this layout prototype
-
getUserId
long getUserId()Returns the user ID of this layout prototype.- Specified by:
getUserIdin interfaceAuditedModel- Returns:
- the user ID of this layout prototype
-
setUserId
void setUserId(long userId) Sets the user ID of this layout prototype.- Specified by:
setUserIdin interfaceAuditedModel- Parameters:
userId- the user ID of this layout prototype
-
getUserUuid
String getUserUuid()Returns the user uuid of this layout prototype.- Specified by:
getUserUuidin interfaceAuditedModel- Returns:
- the user uuid of this layout prototype
-
setUserUuid
Sets the user uuid of this layout prototype.- Specified by:
setUserUuidin interfaceAuditedModel- Parameters:
userUuid- the user uuid of this layout prototype
-
getUserName
Returns the user name of this layout prototype.- Specified by:
getUserNamein interfaceAuditedModel- Returns:
- the user name of this layout prototype
-
setUserName
Sets the user name of this layout prototype.- Specified by:
setUserNamein interfaceAuditedModel- Parameters:
userName- the user name of this layout prototype
-
getCreateDate
Date getCreateDate()Returns the create date of this layout prototype.- Specified by:
getCreateDatein interfaceAuditedModel- Specified by:
getCreateDatein interfaceStagedModel- Returns:
- the create date of this layout prototype
-
setCreateDate
Sets the create date of this layout prototype.- Specified by:
setCreateDatein interfaceAuditedModel- Specified by:
setCreateDatein interfaceStagedModel- Parameters:
createDate- the create date of this layout prototype
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this layout prototype.- Specified by:
getModifiedDatein interfaceAuditedModel- Specified by:
getModifiedDatein interfaceStagedModel- Returns:
- the modified date of this layout prototype
-
setModifiedDate
Sets the modified date of this layout prototype.- Specified by:
setModifiedDatein interfaceAuditedModel- Specified by:
setModifiedDatein interfaceStagedModel- Parameters:
modifiedDate- the modified date of this layout prototype
-
getName
String getName()Returns the name of this layout prototype.- Returns:
- the name of this layout prototype
-
getName
Returns the localized name of this layout prototype in the language. Uses the default language if no localization exists for the requested language.- Parameters:
locale- the locale of the language- Returns:
- the localized name of this layout prototype
-
getName
Returns the localized name of this layout prototype in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
locale- the local of the languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized name of this layout prototype. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getName
Returns the localized name of this layout prototype in the language. Uses the default language if no localization exists for the requested language.- Parameters:
languageId- the ID of the language- Returns:
- the localized name of this layout prototype
-
getName
Returns the localized name of this layout prototype in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
languageId- the ID of the languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized name of this layout prototype
-
getNameCurrentLanguageId
-
getNameCurrentValue
-
getNameMap
Returns a map of the locales and localized names of this layout prototype.- Returns:
- the locales and localized names of this layout prototype
-
setName
Sets the name of this layout prototype.- Parameters:
name- the name of this layout prototype
-
setName
Sets the localized name of this layout prototype in the language.- Parameters:
name- the localized name of this layout prototypelocale- the locale of the language
-
setName
Sets the localized name of this layout prototype in the language, and sets the default locale.- Parameters:
name- the localized name of this layout prototypelocale- the locale of the languagedefaultLocale- the default locale
-
setNameCurrentLanguageId
-
setNameMap
Sets the localized names of this layout prototype from the map of locales and localized names.- Parameters:
nameMap- the locales and localized names of this layout prototype
-
setNameMap
Sets the localized names of this layout prototype from the map of locales and localized names, and sets the default locale.- Parameters:
nameMap- the locales and localized names of this layout prototypedefaultLocale- the default locale
-
getDescription
String getDescription()Returns the description of this layout prototype.- Returns:
- the description of this layout prototype
-
getDescription
Returns the localized description of this layout prototype in the language. Uses the default language if no localization exists for the requested language.- Parameters:
locale- the locale of the language- Returns:
- the localized description of this layout prototype
-
getDescription
Returns the localized description of this layout prototype in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
locale- the local of the languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized description of this layout prototype. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getDescription
Returns the localized description of this layout prototype in the language. Uses the default language if no localization exists for the requested language.- Parameters:
languageId- the ID of the language- Returns:
- the localized description of this layout prototype
-
getDescription
Returns the localized description of this layout prototype in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
languageId- the ID of the languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized description of this layout prototype
-
getDescriptionCurrentLanguageId
-
getDescriptionCurrentValue
-
getDescriptionMap
Returns a map of the locales and localized descriptions of this layout prototype.- Returns:
- the locales and localized descriptions of this layout prototype
-
setDescription
Sets the description of this layout prototype.- Parameters:
description- the description of this layout prototype
-
setDescription
Sets the localized description of this layout prototype in the language.- Parameters:
description- the localized description of this layout prototypelocale- the locale of the language
-
setDescription
Sets the localized description of this layout prototype in the language, and sets the default locale.- Parameters:
description- the localized description of this layout prototypelocale- the locale of the languagedefaultLocale- the default locale
-
setDescriptionCurrentLanguageId
-
setDescriptionMap
Sets the localized descriptions of this layout prototype from the map of locales and localized descriptions.- Parameters:
descriptionMap- the locales and localized descriptions of this layout prototype
-
setDescriptionMap
Sets the localized descriptions of this layout prototype from the map of locales and localized descriptions, and sets the default locale.- Parameters:
descriptionMap- the locales and localized descriptions of this layout prototypedefaultLocale- the default locale
-
getSettings
Returns the settings of this layout prototype.- Returns:
- the settings of this layout prototype
-
setSettings
Sets the settings of this layout prototype.- Parameters:
settings- the settings of this layout prototype
-
getActive
boolean getActive()Returns the active of this layout prototype.- Returns:
- the active of this layout prototype
-
isActive
boolean isActive()Returnstrueif this layout prototype is active.- Returns:
trueif this layout prototype is active;falseotherwise
-
setActive
void setActive(boolean active) Sets whether this layout prototype is active.- Parameters:
active- the active of this layout prototype
-
getAvailableLanguageIds
String[] getAvailableLanguageIds()- Specified by:
getAvailableLanguageIdsin interfaceLocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageIdin interfaceLocalizedModel
-
prepareLocalizedFieldsForImport
- Specified by:
prepareLocalizedFieldsForImportin interfaceLocalizedModel- Throws:
LocaleException
-
prepareLocalizedFieldsForImport
- Specified by:
prepareLocalizedFieldsForImportin interfaceLocalizedModel- Throws:
LocaleException
-
cloneWithOriginalValues
LayoutPrototype cloneWithOriginalValues()- Specified by:
cloneWithOriginalValuesin interfaceBaseModel<LayoutPrototype>
-
toXmlString
-