Interface KaleoDefinitionModel

All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel, com.liferay.portal.kernel.model.BaseModel<KaleoDefinition>, com.liferay.portal.kernel.model.ClassedModel, Cloneable, Comparable<KaleoDefinition>, com.liferay.portal.kernel.model.change.tracking.CTModel<KaleoDefinition>, com.liferay.portal.kernel.model.ExternalReferenceCodeModel, com.liferay.portal.kernel.model.GroupedModel, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, Serializable, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedAuditedModel, com.liferay.portal.kernel.model.StagedModel
All Known Subinterfaces:
KaleoDefinition
All Known Implementing Classes:
KaleoDefinitionWrapper

@ProviderType public interface KaleoDefinitionModel extends com.liferay.portal.kernel.model.BaseModel<KaleoDefinition>, com.liferay.portal.kernel.model.change.tracking.CTModel<KaleoDefinition>, com.liferay.portal.kernel.model.ExternalReferenceCodeModel, com.liferay.portal.kernel.model.GroupedModel, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedAuditedModel
The base model interface for the KaleoDefinition service. Represents a row in the "KaleoDefinition" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation com.liferay.portal.workflow.kaleo.model.impl.KaleoDefinitionModelImpl 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.workflow.kaleo.model.impl.KaleoDefinitionImpl.

See Also:
Generated:
  • Method Summary

    Modifier and Type
    Method
    Description
     
    boolean
    Returns the active of this kaleo definition.
     
    long
    Returns the company ID of this kaleo definition.
    Returns the content of this kaleo definition.
    Returns the create date of this kaleo definition.
    long
    Returns the ct collection ID of this kaleo definition.
     
    Returns the description of this kaleo definition.
    Returns the external reference code of this kaleo definition.
    long
    Returns the group ID of this kaleo definition.
    long
    Returns the kaleo definition ID of this kaleo definition.
    Returns the modified date of this kaleo definition.
    long
    Returns the mvcc version of this kaleo definition.
    Returns the name of this kaleo definition.
    long
    Returns the primary key of this kaleo definition.
    Returns the scope of this kaleo definition.
    Returns the title of this kaleo definition.
    getTitle(String languageId)
    Returns the localized title of this kaleo definition in the language.
    getTitle(String languageId, boolean useDefault)
    Returns the localized title of this kaleo definition in the language, optionally using the default language if no localization exists for the requested language.
    getTitle(Locale locale)
    Returns the localized title of this kaleo definition in the language.
    getTitle(Locale locale, boolean useDefault)
    Returns the localized title of this kaleo definition in the language, optionally using the default language if no localization exists for the requested language.
     
     
    Returns a map of the locales and localized titles of this kaleo definition.
    long
    Returns the user ID of this kaleo definition.
    Returns the user name of this kaleo definition.
    Returns the user uuid of this kaleo definition.
    Returns the uuid of this kaleo definition.
    int
    Returns the version of this kaleo definition.
    boolean
    Returns true if this kaleo definition is active.
    void
     
    void
     
    void
    setActive(boolean active)
    Sets whether this kaleo definition is active.
    void
    setCompanyId(long companyId)
    Sets the company ID of this kaleo definition.
    void
    setContent(String content)
    Sets the content of this kaleo definition.
    void
    setCreateDate(Date createDate)
    Sets the create date of this kaleo definition.
    void
    setCtCollectionId(long ctCollectionId)
    Sets the ct collection ID of this kaleo definition.
    void
    setDescription(String description)
    Sets the description of this kaleo definition.
    void
    setExternalReferenceCode(String externalReferenceCode)
    Sets the external reference code of this kaleo definition.
    void
    setGroupId(long groupId)
    Sets the group ID of this kaleo definition.
    void
    setKaleoDefinitionId(long kaleoDefinitionId)
    Sets the kaleo definition ID of this kaleo definition.
    void
    setModifiedDate(Date modifiedDate)
    Sets the modified date of this kaleo definition.
    void
    setMvccVersion(long mvccVersion)
    Sets the mvcc version of this kaleo definition.
    void
    Sets the name of this kaleo definition.
    void
    setPrimaryKey(long primaryKey)
    Sets the primary key of this kaleo definition.
    void
    Sets the scope of this kaleo definition.
    void
    Sets the title of this kaleo definition.
    void
    setTitle(String title, Locale locale)
    Sets the localized title of this kaleo definition in the language.
    void
    setTitle(String title, Locale locale, Locale defaultLocale)
    Sets the localized title of this kaleo definition in the language, and sets the default locale.
    void
     
    void
    Sets the localized titles of this kaleo definition from the map of locales and localized titles.
    void
    setTitleMap(Map<Locale,String> titleMap, Locale defaultLocale)
    Sets the localized titles of this kaleo definition from the map of locales and localized titles, and sets the default locale.
    void
    setUserId(long userId)
    Sets the user ID of this kaleo definition.
    void
    setUserName(String userName)
    Sets the user name of this kaleo definition.
    void
    setUserUuid(String userUuid)
    Sets the user uuid of this kaleo definition.
    void
    Sets the uuid of this kaleo definition.
    void
    setVersion(int version)
    Sets the version of this kaleo definition.
    default String
     

    Methods 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, toUnescapedModel

    Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

    getModelClass, getModelClassName

    Methods inherited from interface java.lang.Comparable

    compareTo

    Methods inherited from interface com.liferay.portal.kernel.model.StagedModel

    clone, getStagedModelType
  • Method Details

    • getPrimaryKey

      long getPrimaryKey()
      Returns the primary key of this kaleo definition.
      Specified by:
      getPrimaryKey in interface com.liferay.portal.kernel.model.change.tracking.CTModel<KaleoDefinition>
      Returns:
      the primary key of this kaleo definition
    • setPrimaryKey

      void setPrimaryKey(long primaryKey)
      Sets the primary key of this kaleo definition.
      Specified by:
      setPrimaryKey in interface com.liferay.portal.kernel.model.change.tracking.CTModel<KaleoDefinition>
      Parameters:
      primaryKey - the primary key of this kaleo definition
    • getMvccVersion

      long getMvccVersion()
      Returns the mvcc version of this kaleo definition.
      Specified by:
      getMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel
      Returns:
      the mvcc version of this kaleo definition
    • setMvccVersion

      void setMvccVersion(long mvccVersion)
      Sets the mvcc version of this kaleo definition.
      Specified by:
      setMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel
      Parameters:
      mvccVersion - the mvcc version of this kaleo definition
    • getCtCollectionId

      long getCtCollectionId()
      Returns the ct collection ID of this kaleo definition.
      Specified by:
      getCtCollectionId in interface com.liferay.portal.kernel.model.change.tracking.CTModel<KaleoDefinition>
      Returns:
      the ct collection ID of this kaleo definition
    • setCtCollectionId

      void setCtCollectionId(long ctCollectionId)
      Sets the ct collection ID of this kaleo definition.
      Specified by:
      setCtCollectionId in interface com.liferay.portal.kernel.model.change.tracking.CTModel<KaleoDefinition>
      Parameters:
      ctCollectionId - the ct collection ID of this kaleo definition
    • getUuid

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

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

      @AutoEscape String getExternalReferenceCode()
      Returns the external reference code of this kaleo definition.
      Specified by:
      getExternalReferenceCode in interface com.liferay.portal.kernel.model.ExternalReferenceCodeModel
      Returns:
      the external reference code of this kaleo definition
    • setExternalReferenceCode

      void setExternalReferenceCode(String externalReferenceCode)
      Sets the external reference code of this kaleo definition.
      Specified by:
      setExternalReferenceCode in interface com.liferay.portal.kernel.model.ExternalReferenceCodeModel
      Parameters:
      externalReferenceCode - the external reference code of this kaleo definition
    • getKaleoDefinitionId

      long getKaleoDefinitionId()
      Returns the kaleo definition ID of this kaleo definition.
      Returns:
      the kaleo definition ID of this kaleo definition
    • setKaleoDefinitionId

      void setKaleoDefinitionId(long kaleoDefinitionId)
      Sets the kaleo definition ID of this kaleo definition.
      Parameters:
      kaleoDefinitionId - the kaleo definition ID of this kaleo definition
    • getGroupId

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

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

      long getCompanyId()
      Returns the company ID of this kaleo 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 kaleo definition
    • setCompanyId

      void setCompanyId(long companyId)
      Sets the company ID of this kaleo 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 kaleo definition
    • getUserId

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

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

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

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

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

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

      Date getCreateDate()
      Returns the create date of this kaleo 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 kaleo definition
    • setCreateDate

      void setCreateDate(Date createDate)
      Sets the create date of this kaleo 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 kaleo definition
    • getModifiedDate

      Date getModifiedDate()
      Returns the modified date of this kaleo 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 kaleo definition
    • setModifiedDate

      void setModifiedDate(Date modifiedDate)
      Sets the modified date of this kaleo 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 kaleo definition
    • getName

      @AutoEscape String getName()
      Returns the name of this kaleo definition.
      Returns:
      the name of this kaleo definition
    • setName

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

      String getTitle()
      Returns the title of this kaleo definition.
      Returns:
      the title of this kaleo definition
    • getTitle

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

      @AutoEscape String getTitle(Locale locale, boolean useDefault)
      Returns the localized title of this kaleo 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 title of this kaleo definition. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
    • getTitle

      @AutoEscape String getTitle(String languageId)
      Returns the localized title of this kaleo 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 title of this kaleo definition
    • getTitle

      @AutoEscape String getTitle(String languageId, boolean useDefault)
      Returns the localized title of this kaleo 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 title of this kaleo definition
    • getTitleCurrentLanguageId

      @AutoEscape String getTitleCurrentLanguageId()
    • getTitleCurrentValue

      @AutoEscape String getTitleCurrentValue()
    • getTitleMap

      Map<Locale,String> getTitleMap()
      Returns a map of the locales and localized titles of this kaleo definition.
      Returns:
      the locales and localized titles of this kaleo definition
    • setTitle

      void setTitle(String title)
      Sets the title of this kaleo definition.
      Parameters:
      title - the title of this kaleo definition
    • setTitle

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

      void setTitle(String title, Locale locale, Locale defaultLocale)
      Sets the localized title of this kaleo definition in the language, and sets the default locale.
      Parameters:
      title - the localized title of this kaleo definition
      locale - the locale of the language
      defaultLocale - the default locale
    • setTitleCurrentLanguageId

      void setTitleCurrentLanguageId(String languageId)
    • setTitleMap

      void setTitleMap(Map<Locale,String> titleMap)
      Sets the localized titles of this kaleo definition from the map of locales and localized titles.
      Parameters:
      titleMap - the locales and localized titles of this kaleo definition
    • setTitleMap

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

      @AutoEscape String getDescription()
      Returns the description of this kaleo definition.
      Returns:
      the description of this kaleo definition
    • setDescription

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

      @AutoEscape String getContent()
      Returns the content of this kaleo definition.
      Returns:
      the content of this kaleo definition
    • setContent

      void setContent(String content)
      Sets the content of this kaleo definition.
      Parameters:
      content - the content of this kaleo definition
    • getScope

      @AutoEscape String getScope()
      Returns the scope of this kaleo definition.
      Returns:
      the scope of this kaleo definition
    • setScope

      void setScope(String scope)
      Sets the scope of this kaleo definition.
      Parameters:
      scope - the scope of this kaleo definition
    • getVersion

      int getVersion()
      Returns the version of this kaleo definition.
      Returns:
      the version of this kaleo definition
    • setVersion

      void setVersion(int version)
      Sets the version of this kaleo definition.
      Parameters:
      version - the version of this kaleo definition
    • getActive

      boolean getActive()
      Returns the active of this kaleo definition.
      Returns:
      the active of this kaleo definition
    • isActive

      boolean isActive()
      Returns true if this kaleo definition is active.
      Returns:
      true if this kaleo definition is active; false otherwise
    • setActive

      void setActive(boolean active)
      Sets whether this kaleo definition is active.
      Parameters:
      active - the active of this kaleo 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

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

      default String toXmlString()