Interface DefinitionModel

All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel, com.liferay.portal.kernel.model.BaseModel<Definition>, com.liferay.portal.kernel.model.ClassedModel, Cloneable, Comparable<Definition>, com.liferay.portal.kernel.model.GroupedModel, com.liferay.portal.kernel.model.LocalizedModel, Serializable, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedGroupedModel, com.liferay.portal.kernel.model.StagedModel
All Known Subinterfaces:
Definition
All Known Implementing Classes:
DefinitionWrapper

@ProviderType public interface DefinitionModel extends com.liferay.portal.kernel.model.BaseModel<Definition>, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedGroupedModel
The base model interface for the Definition service. Represents a row in the "Reports_Definition" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation com.liferay.portal.reports.engine.console.model.impl.DefinitionModelImpl 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.reports.engine.console.model.impl.DefinitionImpl.

See Also:
Generated:
  • Method Details

    • getPrimaryKey

      long getPrimaryKey()
      Returns the primary key of this definition.
      Returns:
      the primary key of this definition
    • setPrimaryKey

      void setPrimaryKey(long primaryKey)
      Sets the primary key of this definition.
      Parameters:
      primaryKey - the primary key of this definition
    • getUuid

      @AutoEscape String getUuid()
      Returns the uuid of this definition.
      Specified by:
      getUuid in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the uuid of this definition
    • setUuid

      void setUuid(String uuid)
      Sets the uuid of this definition.
      Specified by:
      setUuid in interface com.liferay.portal.kernel.model.StagedModel
      Parameters:
      uuid - the uuid of this definition
    • getDefinitionId

      long getDefinitionId()
      Returns the definition ID of this definition.
      Returns:
      the definition ID of this definition
    • setDefinitionId

      void setDefinitionId(long definitionId)
      Sets the definition ID of this definition.
      Parameters:
      definitionId - the definition ID of this definition
    • getGroupId

      long getGroupId()
      Returns the group ID of this definition.
      Specified by:
      getGroupId in interface com.liferay.portal.kernel.model.GroupedModel
      Returns:
      the group ID of this definition
    • setGroupId

      void setGroupId(long groupId)
      Sets the group ID of this definition.
      Specified by:
      setGroupId in interface com.liferay.portal.kernel.model.GroupedModel
      Parameters:
      groupId - the group ID of this definition
    • getCompanyId

      long getCompanyId()
      Returns the company ID of this definition.
      Specified by:
      getCompanyId in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      getCompanyId in interface com.liferay.portal.kernel.model.ShardedModel
      Specified by:
      getCompanyId in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the company ID of this definition
    • setCompanyId

      void setCompanyId(long companyId)
      Sets the company ID of this definition.
      Specified by:
      setCompanyId in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      setCompanyId in interface com.liferay.portal.kernel.model.ShardedModel
      Specified by:
      setCompanyId in interface com.liferay.portal.kernel.model.StagedModel
      Parameters:
      companyId - the company ID of this definition
    • getUserId

      long getUserId()
      Returns the user ID of this definition.
      Specified by:
      getUserId in interface com.liferay.portal.kernel.model.AuditedModel
      Returns:
      the user ID of this definition
    • setUserId

      void setUserId(long userId)
      Sets the user ID of this definition.
      Specified by:
      setUserId in interface com.liferay.portal.kernel.model.AuditedModel
      Parameters:
      userId - the user ID of this definition
    • getUserUuid

      String getUserUuid()
      Returns the user uuid of this definition.
      Specified by:
      getUserUuid in interface com.liferay.portal.kernel.model.AuditedModel
      Returns:
      the user uuid of this definition
    • setUserUuid

      void setUserUuid(String userUuid)
      Sets the user uuid of this definition.
      Specified by:
      setUserUuid in interface com.liferay.portal.kernel.model.AuditedModel
      Parameters:
      userUuid - the user uuid of this definition
    • getUserName

      @AutoEscape String getUserName()
      Returns the user name of this definition.
      Specified by:
      getUserName in interface com.liferay.portal.kernel.model.AuditedModel
      Returns:
      the user name of this definition
    • setUserName

      void setUserName(String userName)
      Sets the user name of this definition.
      Specified by:
      setUserName in interface com.liferay.portal.kernel.model.AuditedModel
      Parameters:
      userName - the user name of this definition
    • getCreateDate

      Date getCreateDate()
      Returns the create date of this definition.
      Specified by:
      getCreateDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      getCreateDate in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the create date of this definition
    • setCreateDate

      void setCreateDate(Date createDate)
      Sets the create date of this definition.
      Specified by:
      setCreateDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      setCreateDate in interface com.liferay.portal.kernel.model.StagedModel
      Parameters:
      createDate - the create date of this definition
    • getModifiedDate

      Date getModifiedDate()
      Returns the modified date of this definition.
      Specified by:
      getModifiedDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      getModifiedDate in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the modified date of this definition
    • setModifiedDate

      void setModifiedDate(Date modifiedDate)
      Sets the modified date of this definition.
      Specified by:
      setModifiedDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      setModifiedDate in interface com.liferay.portal.kernel.model.StagedModel
      Parameters:
      modifiedDate - the modified date of this definition
    • getName

      String getName()
      Returns the name of this definition.
      Returns:
      the name of this definition
    • getName

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

      @AutoEscape String getName(Locale locale, boolean useDefault)
      Returns the localized name of this definition 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 definition. 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 definition 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 definition
    • getName

      @AutoEscape String getName(String languageId, boolean useDefault)
      Returns the localized name of this definition 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 definition
    • getNameCurrentLanguageId

      @AutoEscape String getNameCurrentLanguageId()
    • getNameCurrentValue

      @AutoEscape String getNameCurrentValue()
    • getNameMap

      Map<Locale,String> getNameMap()
      Returns a map of the locales and localized names of this definition.
      Returns:
      the locales and localized names of this definition
    • setName

      void setName(String name)
      Sets the name of this definition.
      Parameters:
      name - the name of this definition
    • setName

      void setName(String name, Locale locale)
      Sets the localized name of this definition in the language.
      Parameters:
      name - the localized name of this definition
      locale - the locale of the language
    • setName

      void setName(String name, Locale locale, Locale defaultLocale)
      Sets the localized name of this definition in the language, and sets the default locale.
      Parameters:
      name - the localized name of this definition
      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 definition from the map of locales and localized names.
      Parameters:
      nameMap - the locales and localized names of this definition
    • setNameMap

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

      String getDescription()
      Returns the description of this definition.
      Returns:
      the description of this definition
    • getDescription

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

      @AutoEscape String getDescription(Locale locale, boolean useDefault)
      Returns the localized description of this definition 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 definition. 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 definition 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 definition
    • getDescription

      @AutoEscape String getDescription(String languageId, boolean useDefault)
      Returns the localized description of this definition 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 definition
    • getDescriptionCurrentLanguageId

      @AutoEscape String getDescriptionCurrentLanguageId()
    • getDescriptionCurrentValue

      @AutoEscape String getDescriptionCurrentValue()
    • getDescriptionMap

      Map<Locale,String> getDescriptionMap()
      Returns a map of the locales and localized descriptions of this definition.
      Returns:
      the locales and localized descriptions of this definition
    • setDescription

      void setDescription(String description)
      Sets the description of this definition.
      Parameters:
      description - the description of this definition
    • setDescription

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

      void setDescription(String description, Locale locale, Locale defaultLocale)
      Sets the localized description of this definition in the language, and sets the default locale.
      Parameters:
      description - the localized description of this definition
      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 definition from the map of locales and localized descriptions.
      Parameters:
      descriptionMap - the locales and localized descriptions of this definition
    • setDescriptionMap

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

      long getSourceId()
      Returns the source ID of this definition.
      Returns:
      the source ID of this definition
    • setSourceId

      void setSourceId(long sourceId)
      Sets the source ID of this definition.
      Parameters:
      sourceId - the source ID of this definition
    • getReportName

      @AutoEscape String getReportName()
      Returns the report name of this definition.
      Returns:
      the report name of this definition
    • setReportName

      void setReportName(String reportName)
      Sets the report name of this definition.
      Parameters:
      reportName - the report name of this definition
    • getReportParameters

      @AutoEscape String getReportParameters()
      Returns the report parameters of this definition.
      Returns:
      the report parameters of this definition
    • setReportParameters

      void setReportParameters(String reportParameters)
      Sets the report parameters of this definition.
      Parameters:
      reportParameters - the report parameters of this definition
    • getLastPublishDate

      Date getLastPublishDate()
      Returns the last publish date of this definition.
      Specified by:
      getLastPublishDate in interface com.liferay.portal.kernel.model.StagedGroupedModel
      Returns:
      the last publish date of this definition
    • setLastPublishDate

      void setLastPublishDate(Date lastPublishDate)
      Sets the last publish date of this definition.
      Specified by:
      setLastPublishDate in interface com.liferay.portal.kernel.model.StagedGroupedModel
      Parameters:
      lastPublishDate - the last publish date of this definition
    • getAvailableLanguageIds

      String[] getAvailableLanguageIds()
      Specified by:
      getAvailableLanguageIds in interface com.liferay.portal.kernel.model.LocalizedModel
    • getDefaultLanguageId

      String getDefaultLanguageId()
      Specified by:
      getDefaultLanguageId in interface com.liferay.portal.kernel.model.LocalizedModel
    • prepareLocalizedFieldsForImport

      void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException
      Specified by:
      prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModel
      Throws:
      com.liferay.portal.kernel.exception.LocaleException
    • prepareLocalizedFieldsForImport

      void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws com.liferay.portal.kernel.exception.LocaleException
      Specified by:
      prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModel
      Throws:
      com.liferay.portal.kernel.exception.LocaleException
    • cloneWithOriginalValues

      Definition cloneWithOriginalValues()
      Specified by:
      cloneWithOriginalValues in interface com.liferay.portal.kernel.model.BaseModel<Definition>
    • toXmlString

      default String toXmlString()