@ProviderType public interface RoleModel extends AttachedModel, BaseModel<Role>, LocalizedModel, MVCCModel, ShardedModel, StagedAuditedModel
This interface and its corresponding implementation RoleModelImpl
exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in RoleImpl
.
Role
,
RoleImpl
,
RoleModelImpl
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Creates a shallow clone of this model instance.
|
int |
compareTo(Role role) |
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.
|
ExpandoBridge |
getExpandoBridge()
Returns the expando bridge for this model instance.
|
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.
|
Serializable |
getPrimaryKeyObj()
Returns the primary key of this model instance.
|
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.
|
int |
hashCode() |
boolean |
isCachedModel()
Returns
true if this model instance was retrieved from the
entity cache. |
boolean |
isEscapedModel()
Returns
true if this model instance is escaped. |
boolean |
isNew()
Returns
true if this model instance does not yet exist in
the database. |
void |
prepareLocalizedFieldsForImport() |
void |
prepareLocalizedFieldsForImport(Locale defaultImportLocale) |
void |
setCachedModel(boolean cachedModel)
Sets whether this model instance was retrieved from the entity cache.
|
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 |
setExpandoBridgeAttributes(BaseModel<?> baseModel) |
void |
setExpandoBridgeAttributes(ExpandoBridge expandoBridge) |
void |
setExpandoBridgeAttributes(ServiceContext serviceContext)
Sets the expando bridge attributes for this model instance to the
attributes stored in the service context.
|
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 |
setNew(boolean n)
Sets whether this model instance does not yet exist in the database.
|
void |
setPrimaryKey(long primaryKey)
Sets the primary key of this role.
|
void |
setPrimaryKeyObj(Serializable primaryKeyObj)
Sets the primary key of this model instance.
|
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.
|
CacheModel<Role> |
toCacheModel()
Returns a cache model object for this entity used by entity cache.
|
Role |
toEscapedModel()
Returns a copy of this entity as an escaped model instance by wrapping it
with an
AutoEscapeBeanHandler . |
String |
toString() |
Role |
toUnescapedModel() |
String |
toXmlString()
Returns the XML representation of this model instance.
|
getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes
getStagedModelType
getModelClass, getModelClassName
long getPrimaryKey()
void setPrimaryKey(long primaryKey)
primaryKey
- the primary key of this rolelong getMvccVersion()
getMvccVersion
in interface MVCCModel
void setMvccVersion(long mvccVersion)
setMvccVersion
in interface MVCCModel
mvccVersion
- the mvcc version of this role@AutoEscape String getUuid()
getUuid
in interface StagedModel
void setUuid(String uuid)
setUuid
in interface StagedModel
uuid
- the uuid of this rolelong getRoleId()
void setRoleId(long roleId)
roleId
- the role ID of this rolelong getCompanyId()
getCompanyId
in interface AuditedModel
getCompanyId
in interface ShardedModel
getCompanyId
in interface StagedModel
void setCompanyId(long companyId)
setCompanyId
in interface AuditedModel
setCompanyId
in interface ShardedModel
setCompanyId
in interface StagedModel
companyId
- the company ID of this rolelong getUserId()
getUserId
in interface AuditedModel
void setUserId(long userId)
setUserId
in interface AuditedModel
userId
- the user ID of this roleString getUserUuid()
getUserUuid
in interface AuditedModel
void setUserUuid(String userUuid)
setUserUuid
in interface AuditedModel
userUuid
- the user uuid of this role@AutoEscape String getUserName()
getUserName
in interface AuditedModel
void setUserName(String userName)
setUserName
in interface AuditedModel
userName
- the user name of this roleDate getCreateDate()
getCreateDate
in interface AuditedModel
getCreateDate
in interface StagedModel
void setCreateDate(Date createDate)
setCreateDate
in interface AuditedModel
setCreateDate
in interface StagedModel
createDate
- the create date of this roleDate getModifiedDate()
getModifiedDate
in interface AuditedModel
getModifiedDate
in interface StagedModel
void setModifiedDate(Date modifiedDate)
setModifiedDate
in interface AuditedModel
setModifiedDate
in interface StagedModel
modifiedDate
- the modified date of this roleString getClassName()
getClassName
in interface TypedModel
void setClassName(String className)
long getClassNameId()
getClassNameId
in interface TypedModel
void setClassNameId(long classNameId)
setClassNameId
in interface TypedModel
classNameId
- the class name ID of this rolelong getClassPK()
getClassPK
in interface AttachedModel
void setClassPK(long classPK)
setClassPK
in interface AttachedModel
classPK
- 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 roleboolean isNew()
BaseModel
true
if this model instance does not yet exist in
the database.void setNew(boolean n)
BaseModel
boolean isCachedModel()
BaseModel
true
if this model instance was retrieved from the
entity cache.isCachedModel
in interface BaseModel<Role>
true
if this model instance was retrieved from the
entity cache; false
otherwiseBaseModel.setCachedModel(boolean)
void setCachedModel(boolean cachedModel)
BaseModel
setCachedModel
in interface BaseModel<Role>
cachedModel
- whether this model instance was retrieved from the
entity cacheEntityCache
boolean isEscapedModel()
BaseModel
true
if this model instance is escaped.isEscapedModel
in interface BaseModel<Role>
true
if this model instance is escaped;
false
otherwiseSerializable getPrimaryKeyObj()
BaseModel
getPrimaryKeyObj
in interface BaseModel<Role>
getPrimaryKeyObj
in interface ClassedModel
void setPrimaryKeyObj(Serializable primaryKeyObj)
BaseModel
setPrimaryKeyObj
in interface BaseModel<Role>
setPrimaryKeyObj
in interface ClassedModel
primaryKeyObj
- the primary key of this model instanceExpandoBridge getExpandoBridge()
BaseModel
getExpandoBridge
in interface BaseModel<Role>
getExpandoBridge
in interface ClassedModel
void setExpandoBridgeAttributes(BaseModel<?> baseModel)
setExpandoBridgeAttributes
in interface BaseModel<Role>
void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
setExpandoBridgeAttributes
in interface BaseModel<Role>
void setExpandoBridgeAttributes(ServiceContext serviceContext)
BaseModel
setExpandoBridgeAttributes
in interface BaseModel<Role>
serviceContext
- the service context to be appliedServiceContext.getExpandoBridgeAttributes()
String[] getAvailableLanguageIds()
getAvailableLanguageIds
in interface LocalizedModel
String getDefaultLanguageId()
getDefaultLanguageId
in interface LocalizedModel
void prepareLocalizedFieldsForImport() throws LocaleException
prepareLocalizedFieldsForImport
in interface LocalizedModel
LocaleException
void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws LocaleException
prepareLocalizedFieldsForImport
in interface LocalizedModel
LocaleException
Object clone()
BaseModel
clone
in interface BaseModel<Role>
clone
in interface StagedModel
int hashCode()
hashCode
in class Object
CacheModel<Role> toCacheModel()
BaseModel
toCacheModel
in interface BaseModel<Role>
Role toEscapedModel()
BaseModel
AutoEscapeBeanHandler
.toEscapedModel
in interface BaseModel<Role>
AutoEscapeBeanHandler
Role toUnescapedModel()
toUnescapedModel
in interface BaseModel<Role>
String toString()
toString
in class Object
String toXmlString()
BaseModel
toXmlString
in interface BaseModel<Role>