@ProviderType public interface RoleModel extends AttachedModel, BaseModel<Role>, LocalizedModel, MVCCModel, ShardedModel, StagedAuditedModel
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.
Role| Modifier and Type | Method and Description |
|---|---|
String[] |
getAvailableLanguageIds() |
String |
getClassName()
Returns the fully qualified class name of this role.
|
long |
getClassNameId()
Returns the class name ID of this role.
|
long |
getClassPK()
Returns the class pk of this role.
|
long |
getCompanyId()
Returns the company ID of this role.
|
Date |
getCreateDate()
Returns the create date of this role.
|
String |
getDefaultLanguageId() |
String |
getDescription()
Returns the description of this role.
|
String |
getDescription(Locale locale)
Returns the localized description of this role in the language.
|
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.
|
String |
getDescription(String languageId)
Returns the localized description of this role in the language.
|
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.
|
String |
getDescriptionCurrentLanguageId() |
String |
getDescriptionCurrentValue() |
Map<Locale,String> |
getDescriptionMap()
Returns a map of the locales and localized descriptions of this role.
|
Date |
getModifiedDate()
Returns the modified date of this role.
|
long |
getMvccVersion()
Returns the mvcc version of this role.
|
String |
getName()
Returns the name of this role.
|
long |
getPrimaryKey()
Returns the primary key of this role.
|
long |
getRoleId()
Returns the role ID of this role.
|
String |
getSubtype()
Returns the subtype of this role.
|
String |
getTitle()
Returns the title of this role.
|
String |
getTitle(Locale locale)
Returns the localized title of this role in the language.
|
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.
|
String |
getTitle(String languageId)
Returns the localized title of this role in the language.
|
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.
|
String |
getTitleCurrentLanguageId() |
String |
getTitleCurrentValue() |
Map<Locale,String> |
getTitleMap()
Returns a map of the locales and localized titles of this role.
|
int |
getType()
Returns the type of this role.
|
long |
getUserId()
Returns the user ID of this role.
|
String |
getUserName()
Returns the user name of this role.
|
String |
getUserUuid()
Returns the user uuid of this role.
|
String |
getUuid()
Returns the uuid of this role.
|
void |
prepareLocalizedFieldsForImport() |
void |
prepareLocalizedFieldsForImport(Locale defaultImportLocale) |
void |
setClassName(String className) |
void |
setClassNameId(long classNameId)
Sets the class name ID of this role.
|
void |
setClassPK(long classPK)
Sets the class pk of this role.
|
void |
setCompanyId(long companyId)
Sets the company ID of this role.
|
void |
setCreateDate(Date createDate)
Sets the create date of this role.
|
void |
setDescription(String description)
Sets the description of this role.
|
void |
setDescription(String description,
Locale locale)
Sets the localized description of this role in the language.
|
void |
setDescription(String description,
Locale locale,
Locale defaultLocale)
Sets the localized description of this role in the language, and sets the default locale.
|
void |
setDescriptionCurrentLanguageId(String languageId) |
void |
setDescriptionMap(Map<Locale,String> descriptionMap)
Sets the localized descriptions of this role from the map of locales and localized descriptions.
|
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.
|
void |
setModifiedDate(Date modifiedDate)
Sets the modified date of this role.
|
void |
setMvccVersion(long mvccVersion)
Sets the mvcc version of this role.
|
void |
setName(String name)
Sets the name of this role.
|
void |
setPrimaryKey(long primaryKey)
Sets the primary key of this role.
|
void |
setRoleId(long roleId)
Sets the role ID of this role.
|
void |
setSubtype(String subtype)
Sets the subtype of this role.
|
void |
setTitle(String title)
Sets the title of this role.
|
void |
setTitle(String title,
Locale locale)
Sets the localized title of this role in the language.
|
void |
setTitle(String title,
Locale locale,
Locale defaultLocale)
Sets the localized title of this role in the language, and sets the default locale.
|
void |
setTitleCurrentLanguageId(String languageId) |
void |
setTitleMap(Map<Locale,String> titleMap)
Sets the localized titles of this role from the map of locales and localized titles.
|
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.
|
void |
setType(int type)
Sets the type of this role.
|
void |
setUserId(long userId)
Sets the user ID of this role.
|
void |
setUserName(String userName)
Sets the user name of this role.
|
void |
setUserUuid(String userUuid)
Sets the user uuid of this role.
|
void |
setUuid(String uuid)
Sets the uuid of this role.
|
clone, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel, toXmlStringclone, getStagedModelTypegetModelClass, getModelClassNamelong getPrimaryKey()
void setPrimaryKey(long primaryKey)
primaryKey - the primary key of this rolelong getMvccVersion()
getMvccVersion in interface MVCCModelvoid setMvccVersion(long mvccVersion)
setMvccVersion in interface MVCCModelmvccVersion - the mvcc version of this role@AutoEscape String getUuid()
getUuid in interface StagedModelvoid setUuid(String uuid)
setUuid in interface StagedModeluuid - the uuid of this rolelong getRoleId()
void setRoleId(long roleId)
roleId - the role ID of this rolelong getCompanyId()
getCompanyId in interface AuditedModelgetCompanyId in interface ShardedModelgetCompanyId in interface StagedModelvoid setCompanyId(long companyId)
setCompanyId in interface AuditedModelsetCompanyId in interface ShardedModelsetCompanyId in interface StagedModelcompanyId - the company ID of this rolelong getUserId()
getUserId in interface AuditedModelvoid setUserId(long userId)
setUserId in interface AuditedModeluserId - the user ID of this roleString getUserUuid()
getUserUuid in interface AuditedModelvoid setUserUuid(String userUuid)
setUserUuid in interface AuditedModeluserUuid - the user uuid of this role@AutoEscape String getUserName()
getUserName in interface AuditedModelvoid setUserName(String userName)
setUserName in interface AuditedModeluserName - the user name of this roleDate getCreateDate()
getCreateDate in interface AuditedModelgetCreateDate in interface StagedModelvoid setCreateDate(Date createDate)
setCreateDate in interface AuditedModelsetCreateDate in interface StagedModelcreateDate - the create date of this roleDate getModifiedDate()
getModifiedDate in interface AuditedModelgetModifiedDate in interface StagedModelvoid setModifiedDate(Date modifiedDate)
setModifiedDate in interface AuditedModelsetModifiedDate in interface StagedModelmodifiedDate - the modified date of this roleString getClassName()
getClassName in interface TypedModelvoid setClassName(String className)
long getClassNameId()
getClassNameId in interface TypedModelvoid setClassNameId(long classNameId)
setClassNameId in interface TypedModelclassNameId - the class name ID of this rolelong getClassPK()
getClassPK in interface AttachedModelvoid setClassPK(long classPK)
setClassPK in interface AttachedModelclassPK - the class pk of this role@AutoEscape String getName()
void setName(String name)
name - the name of this roleString getTitle()
@AutoEscape String getTitle(Locale locale)
locale - the locale of the language@AutoEscape String getTitle(Locale locale, boolean useDefault)
locale - the local of the languageuseDefault - whether to use the default language if no localization exists for the requested languageuseDefault is false and no localization exists for the requested language, an empty string will be returned.@AutoEscape String getTitle(String languageId)
languageId - the ID of the language@AutoEscape String getTitle(String languageId, boolean useDefault)
languageId - the ID of the languageuseDefault - whether to use the default language if no localization exists for the requested language@AutoEscape String getTitleCurrentLanguageId()
@AutoEscape String getTitleCurrentValue()
Map<Locale,String> getTitleMap()
void setTitle(String title)
title - the title of this rolevoid setTitle(String title,
Locale locale)
title - the localized title of this rolelocale - the locale of the languagevoid setTitle(String title,
Locale locale,
Locale defaultLocale)
title - the localized title of this rolelocale - the locale of the languagedefaultLocale - the default localevoid setTitleCurrentLanguageId(String languageId)
void setTitleMap(Map<Locale,String> titleMap)
titleMap - the locales and localized titles of this rolevoid setTitleMap(Map<Locale,String> titleMap,
Locale defaultLocale)
titleMap - the locales and localized titles of this roledefaultLocale - the default localeString getDescription()
@AutoEscape String getDescription(Locale locale)
locale - the locale of the language@AutoEscape String getDescription(Locale locale, boolean useDefault)
locale - the local of the languageuseDefault - whether to use the default language if no localization exists for the requested languageuseDefault is false and no localization exists for the requested language, an empty string will be returned.@AutoEscape String getDescription(String languageId)
languageId - the ID of the language@AutoEscape String getDescription(String languageId, boolean useDefault)
languageId - the ID of the languageuseDefault - whether to use the default language if no localization exists for the requested language@AutoEscape String getDescriptionCurrentLanguageId()
@AutoEscape String getDescriptionCurrentValue()
Map<Locale,String> getDescriptionMap()
void setDescription(String description)
description - the description of this rolevoid setDescription(String description,
Locale locale)
description - the localized description of this rolelocale - the locale of the languagevoid setDescription(String description,
Locale locale,
Locale defaultLocale)
description - the localized description of this rolelocale - the locale of the languagedefaultLocale - the default localevoid setDescriptionCurrentLanguageId(String languageId)
void setDescriptionMap(Map<Locale,String> descriptionMap)
descriptionMap - the locales and localized descriptions of this rolevoid setDescriptionMap(Map<Locale,String> descriptionMap,
Locale defaultLocale)
descriptionMap - the locales and localized descriptions of this roledefaultLocale - the default localeint getType()
void setType(int type)
type - the type of this role@AutoEscape String getSubtype()
void setSubtype(String subtype)
subtype - the subtype of this roleString[] getAvailableLanguageIds()
getAvailableLanguageIds in interface LocalizedModelString getDefaultLanguageId()
getDefaultLanguageId in interface LocalizedModelvoid prepareLocalizedFieldsForImport()
throws LocaleException
prepareLocalizedFieldsForImport in interface LocalizedModelLocaleExceptionvoid prepareLocalizedFieldsForImport(Locale defaultImportLocale)
throws LocaleException
prepareLocalizedFieldsForImport in interface LocalizedModelLocaleException