Interface RoleModel

All Superinterfaces:
AttachedModel, AuditedModel, BaseModel<Role>, ClassedModel, Cloneable, Comparable<Role>, CTModel<Role>, ExternalReferenceCodeModel, LocalizedModel, MVCCModel, Serializable, ShardedModel, StagedAuditedModel, StagedModel, TypedModel
All Known Subinterfaces:
Role
All Known Implementing Classes:
RoleWrapper

The base model interface for the Role service. Represents a row in the "Role_" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation com.liferay.portal.model.impl.RoleModelImpl 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.RoleImpl.

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

    • getPrimaryKey

      long getPrimaryKey()
      Returns the primary key of this role.
      Specified by:
      getPrimaryKey in interface CTModel<Role>
      Returns:
      the primary key of this role
    • setPrimaryKey

      void setPrimaryKey(long primaryKey)
      Sets the primary key of this role.
      Specified by:
      setPrimaryKey in interface CTModel<Role>
      Parameters:
      primaryKey - the primary key of this role
    • getMvccVersion

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

      void setMvccVersion(long mvccVersion)
      Sets the mvcc version of this role.
      Specified by:
      setMvccVersion in interface MVCCModel
      Parameters:
      mvccVersion - the mvcc version of this role
    • getCtCollectionId

      long getCtCollectionId()
      Returns the ct collection ID of this role.
      Specified by:
      getCtCollectionId in interface CTModel<Role>
      Returns:
      the ct collection ID of this role
    • setCtCollectionId

      void setCtCollectionId(long ctCollectionId)
      Sets the ct collection ID of this role.
      Specified by:
      setCtCollectionId in interface CTModel<Role>
      Parameters:
      ctCollectionId - the ct collection ID of this role
    • getUuid

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

      void setUuid(String uuid)
      Sets the uuid of this role.
      Specified by:
      setUuid in interface StagedModel
      Parameters:
      uuid - the uuid of this role
    • getExternalReferenceCode

      @AutoEscape String getExternalReferenceCode()
      Returns the external reference code of this role.
      Specified by:
      getExternalReferenceCode in interface ExternalReferenceCodeModel
      Returns:
      the external reference code of this role
    • setExternalReferenceCode

      void setExternalReferenceCode(String externalReferenceCode)
      Sets the external reference code of this role.
      Specified by:
      setExternalReferenceCode in interface ExternalReferenceCodeModel
      Parameters:
      externalReferenceCode - the external reference code of this role
    • getRoleId

      long getRoleId()
      Returns the role ID of this role.
      Returns:
      the role ID of this role
    • setRoleId

      void setRoleId(long roleId)
      Sets the role ID of this role.
      Parameters:
      roleId - the role ID of this role
    • getCompanyId

      long getCompanyId()
      Returns the company ID of this role.
      Specified by:
      getCompanyId in interface AuditedModel
      Specified by:
      getCompanyId in interface ShardedModel
      Specified by:
      getCompanyId in interface StagedModel
      Returns:
      the company ID of this role
    • setCompanyId

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

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

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

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

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

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

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

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

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

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

      void setModifiedDate(Date modifiedDate)
      Sets the modified date of this role.
      Specified by:
      setModifiedDate in interface AuditedModel
      Specified by:
      setModifiedDate in interface StagedModel
      Parameters:
      modifiedDate - the modified date of this role
    • getClassName

      String getClassName()
      Returns the fully qualified class name of this role.
      Specified by:
      getClassName in interface TypedModel
      Returns:
      the fully qualified class name of this role
    • setClassName

      void setClassName(String className)
    • getClassNameId

      long getClassNameId()
      Returns the class name ID of this role.
      Specified by:
      getClassNameId in interface TypedModel
      Returns:
      the class name ID of this role
    • setClassNameId

      void setClassNameId(long classNameId)
      Sets the class name ID of this role.
      Specified by:
      setClassNameId in interface TypedModel
      Parameters:
      classNameId - the class name ID of this role
    • getClassPK

      long getClassPK()
      Returns the class pk of this role.
      Specified by:
      getClassPK in interface AttachedModel
      Returns:
      the class pk of this role
    • setClassPK

      void setClassPK(long classPK)
      Sets the class pk of this role.
      Specified by:
      setClassPK in interface AttachedModel
      Parameters:
      classPK - the class pk of this role
    • getName

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

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

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

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

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

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

      @AutoEscape String getTitleCurrentLanguageId()
    • getTitleCurrentValue

      @AutoEscape String getTitleCurrentValue()
    • getTitleMap

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

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

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

      void setTitle(String title, Locale locale, Locale defaultLocale)
      Sets the localized title of this role in the language, and sets the default locale.
      Parameters:
      title - the localized title of this role
      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 role from the map of locales and localized titles.
      Parameters:
      titleMap - the locales and localized titles of this role
    • setTitleMap

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

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

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

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

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

      @AutoEscape String getDescriptionCurrentLanguageId()
    • getDescriptionCurrentValue

      @AutoEscape String getDescriptionCurrentValue()
    • getDescriptionMap

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

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

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

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

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

      int getType()
      Returns the type of this role.
      Returns:
      the type of this role
    • setType

      void setType(int type)
      Sets the type of this role.
      Parameters:
      type - the type of this role
    • getSubtype

      @AutoEscape String getSubtype()
      Returns the subtype of this role.
      Returns:
      the subtype of this role
    • setSubtype

      void setSubtype(String subtype)
      Sets the subtype of this role.
      Parameters:
      subtype - the subtype of this role
    • 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

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

      default String toXmlString()