Interface LayoutSetPrototypeModel

All Superinterfaces:
AuditedModel, BaseModel<LayoutSetPrototype>, ClassedModel, Cloneable, Comparable<LayoutSetPrototype>, LocalizedModel, MVCCModel, Serializable, ShardedModel, StagedAuditedModel, StagedModel
All Known Subinterfaces:
LayoutSetPrototype
All Known Implementing Classes:
LayoutSetPrototypeWrapper

@ProviderType public interface LayoutSetPrototypeModel extends BaseModel<LayoutSetPrototype>, LocalizedModel, MVCCModel, ShardedModel, StagedAuditedModel
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 com.liferay.portal.model.impl.LayoutSetPrototypeModelImpl 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.LayoutSetPrototypeImpl.

Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Method Details

    • getPrimaryKey

      long getPrimaryKey()
      Returns the primary key of this layout set prototype.
      Returns:
      the primary key of this layout set prototype
    • setPrimaryKey

      void setPrimaryKey(long primaryKey)
      Sets the primary key of this layout set prototype.
      Parameters:
      primaryKey - the primary key of this layout set prototype
    • getMvccVersion

      long getMvccVersion()
      Returns the mvcc version of this layout set prototype.
      Specified by:
      getMvccVersion in interface MVCCModel
      Returns:
      the mvcc version of this layout set prototype
    • setMvccVersion

      void setMvccVersion(long mvccVersion)
      Sets the mvcc version of this layout set prototype.
      Specified by:
      setMvccVersion in interface MVCCModel
      Parameters:
      mvccVersion - the mvcc version of this layout set prototype
    • getUuid

      @AutoEscape String getUuid()
      Returns the uuid of this layout set prototype.
      Specified by:
      getUuid in interface StagedModel
      Returns:
      the uuid of this layout set prototype
    • setUuid

      void setUuid(String uuid)
      Sets the uuid of this layout set prototype.
      Specified by:
      setUuid in interface StagedModel
      Parameters:
      uuid - the uuid of this layout set prototype
    • getLayoutSetPrototypeId

      long getLayoutSetPrototypeId()
      Returns 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()
      Returns the company ID of this layout set prototype.
      Specified by:
      getCompanyId in interface AuditedModel
      Specified by:
      getCompanyId in interface ShardedModel
      Specified by:
      getCompanyId in interface StagedModel
      Returns:
      the company ID of this layout set prototype
    • setCompanyId

      void setCompanyId(long companyId)
      Sets the company ID of this layout set prototype.
      Specified by:
      setCompanyId in interface AuditedModel
      Specified by:
      setCompanyId in interface ShardedModel
      Specified by:
      setCompanyId in interface StagedModel
      Parameters:
      companyId - the company ID of this layout set prototype
    • getUserId

      long getUserId()
      Returns the user ID of this layout set prototype.
      Specified by:
      getUserId in interface AuditedModel
      Returns:
      the user ID of this layout set prototype
    • setUserId

      void setUserId(long userId)
      Sets the user ID of this layout set prototype.
      Specified by:
      setUserId in interface AuditedModel
      Parameters:
      userId - the user ID of this layout set prototype
    • getUserUuid

      String getUserUuid()
      Returns the user uuid of this layout set prototype.
      Specified by:
      getUserUuid in interface AuditedModel
      Returns:
      the user uuid of this layout set prototype
    • setUserUuid

      void setUserUuid(String userUuid)
      Sets the user uuid of this layout set prototype.
      Specified by:
      setUserUuid in interface AuditedModel
      Parameters:
      userUuid - the user uuid of this layout set prototype
    • getUserName

      @AutoEscape String getUserName()
      Returns the user name of this layout set prototype.
      Specified by:
      getUserName in interface AuditedModel
      Returns:
      the user name of this layout set prototype
    • setUserName

      void setUserName(String userName)
      Sets the user name of this layout set prototype.
      Specified by:
      setUserName in interface AuditedModel
      Parameters:
      userName - the user name of this layout set prototype
    • getCreateDate

      Date getCreateDate()
      Returns the create date of this layout set prototype.
      Specified by:
      getCreateDate in interface AuditedModel
      Specified by:
      getCreateDate in interface StagedModel
      Returns:
      the create date of this layout set prototype
    • setCreateDate

      void setCreateDate(Date createDate)
      Sets the create date of this layout set prototype.
      Specified by:
      setCreateDate in interface AuditedModel
      Specified by:
      setCreateDate in interface StagedModel
      Parameters:
      createDate - the create date of this layout set prototype
    • getModifiedDate

      Date getModifiedDate()
      Returns the modified date of this layout set prototype.
      Specified by:
      getModifiedDate in interface AuditedModel
      Specified by:
      getModifiedDate in interface StagedModel
      Returns:
      the modified date of this layout set prototype
    • setModifiedDate

      void setModifiedDate(Date modifiedDate)
      Sets the modified date of this layout set prototype.
      Specified by:
      setModifiedDate in interface AuditedModel
      Specified by:
      setModifiedDate in interface StagedModel
      Parameters:
      modifiedDate - the modified date of this layout set prototype
    • getName

      String getName()
      Returns the name of this layout set prototype.
      Returns:
      the name of this layout set prototype
    • getName

      @AutoEscape String getName(Locale locale)
      Returns the localized name of this layout set 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 set prototype
    • getName

      @AutoEscape String getName(Locale locale, boolean useDefault)
      Returns the localized name of this layout set prototype in the language, optionally using the default language if no localization exists for the requested language.
      Parameters:
      locale - the local of the language
      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

      @AutoEscape String getName(String languageId)
      Returns the localized name of this layout set 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 set prototype
    • getName

      @AutoEscape String getName(String languageId, boolean useDefault)
      Returns the localized name of this layout set prototype in the language, optionally using the default language if no localization exists for the requested language.
      Parameters:
      languageId - the ID of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized name of this layout set prototype
    • getNameCurrentLanguageId

      @AutoEscape String getNameCurrentLanguageId()
    • getNameCurrentValue

      @AutoEscape String getNameCurrentValue()
    • getNameMap

      Map<Locale,String> getNameMap()
      Returns a map of the locales and localized names of this layout set prototype.
      Returns:
      the locales and localized names of this layout set prototype
    • 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(String name, Locale locale)
      Sets the localized name of this layout set prototype in the language.
      Parameters:
      name - the localized name of this layout set prototype
      locale - the locale of the language
    • setName

      void setName(String name, Locale locale, Locale defaultLocale)
      Sets the localized name of this layout set prototype in the language, and sets the default locale.
      Parameters:
      name - the localized name of this layout set prototype
      locale - the locale of the language
      defaultLocale - the default locale
    • setNameCurrentLanguageId

      void setNameCurrentLanguageId(String languageId)
    • 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
    • setNameMap

      void setNameMap(Map<Locale,String> nameMap, Locale defaultLocale)
      Sets the localized names of this layout set prototype from the map of locales and localized names, and sets the default locale.
      Parameters:
      nameMap - the locales and localized names of this layout set prototype
      defaultLocale - the default locale
    • getDescription

      String getDescription()
      Returns the description of this layout set prototype.
      Returns:
      the description of this layout set prototype
    • getDescription

      @AutoEscape String getDescription(Locale locale)
      Returns the localized description of this layout set 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 set prototype
    • getDescription

      @AutoEscape String getDescription(Locale locale, boolean useDefault)
      Returns the localized description of this layout set prototype in the language, optionally using the default language if no localization exists for the requested language.
      Parameters:
      locale - the local of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized description of this layout set prototype. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
    • getDescription

      @AutoEscape String getDescription(String languageId)
      Returns the localized description of this layout set 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 set prototype
    • getDescription

      @AutoEscape String getDescription(String languageId, boolean useDefault)
      Returns the localized description of this layout set prototype in the language, optionally using the default language if no localization exists for the requested language.
      Parameters:
      languageId - the ID of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized description of this layout set prototype
    • getDescriptionCurrentLanguageId

      @AutoEscape String getDescriptionCurrentLanguageId()
    • getDescriptionCurrentValue

      @AutoEscape String getDescriptionCurrentValue()
    • getDescriptionMap

      Map<Locale,String> getDescriptionMap()
      Returns a map of the locales and localized descriptions of this layout set prototype.
      Returns:
      the locales and localized descriptions 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
    • setDescription

      void setDescription(String description, Locale locale)
      Sets the localized description of this layout set prototype in the language.
      Parameters:
      description - the localized description of this layout set prototype
      locale - the locale of the language
    • setDescription

      void setDescription(String description, Locale locale, Locale defaultLocale)
      Sets the localized description of this layout set prototype in the language, and sets the default locale.
      Parameters:
      description - the localized description of this layout set prototype
      locale - the locale of the language
      defaultLocale - the default locale
    • setDescriptionCurrentLanguageId

      void setDescriptionCurrentLanguageId(String languageId)
    • setDescriptionMap

      void setDescriptionMap(Map<Locale,String> descriptionMap)
      Sets the localized descriptions of this layout set prototype from the map of locales and localized descriptions.
      Parameters:
      descriptionMap - the locales and localized descriptions of this layout set prototype
    • setDescriptionMap

      void setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale)
      Sets the localized descriptions of this layout set prototype from the map of locales and localized descriptions, and sets the default locale.
      Parameters:
      descriptionMap - the locales and localized descriptions of this layout set prototype
      defaultLocale - the default locale
    • getSettings

      @AutoEscape String getSettings()
      Returns 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()
      Returns the active of this layout set prototype.
      Returns:
      the active of this layout set prototype
    • isActive

      boolean isActive()
      Returns true if this layout set prototype is active.
      Returns:
      true if this layout set prototype is active; false otherwise
    • setActive

      void setActive(boolean active)
      Sets whether this layout set prototype is active.
      Parameters:
      active - the active of this layout set prototype
    • getAvailableLanguageIds

      String[] getAvailableLanguageIds()
      Specified by:
      getAvailableLanguageIds in interface LocalizedModel
    • getDefaultLanguageId

      String getDefaultLanguageId()
      Specified by:
      getDefaultLanguageId in interface LocalizedModel
    • prepareLocalizedFieldsForImport

      void prepareLocalizedFieldsForImport() throws LocaleException
      Specified by:
      prepareLocalizedFieldsForImport in interface LocalizedModel
      Throws:
      LocaleException
    • prepareLocalizedFieldsForImport

      void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws LocaleException
      Specified by:
      prepareLocalizedFieldsForImport in interface LocalizedModel
      Throws:
      LocaleException
    • cloneWithOriginalValues

      LayoutSetPrototype cloneWithOriginalValues()
      Specified by:
      cloneWithOriginalValues in interface BaseModel<LayoutSetPrototype>
    • toXmlString

      default String toXmlString()