@ProviderType public class RoleWrapper extends Object implements Role, ModelWrapper<Role>
This class is a wrapper for Role
.
Role
,
Serialized FormNAME_ACCESSOR, ROLE_ID_ACCESSOR, TITLE_ACCESSOR
Constructor and Description |
---|
RoleWrapper(Role role) |
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Creates a shallow clone of this model instance.
|
int |
compareTo(Role role) |
boolean |
equals(Object obj) |
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.
|
String |
getDescriptiveName() |
ExpandoBridge |
getExpandoBridge()
Returns the expando bridge for this model instance.
|
Map<String,Object> |
getModelAttributes() |
Class<?> |
getModelClass() |
String |
getModelClassName() |
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.
|
StagedModelType |
getStagedModelType() |
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.
|
String |
getTypeLabel() |
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.
|
Role |
getWrappedModel() |
int |
hashCode() |
boolean |
isCachedModel()
Returns
true if this model instance was retrieved from the
entity cache. |
boolean |
isEntityCacheEnabled()
Returns
true if this model's entity cache is enabled. |
boolean |
isEscapedModel()
Returns
true if this model instance is escaped. |
boolean |
isFinderCacheEnabled()
Returns
true if this model's finder cache is enabled. |
boolean |
isNew()
Returns
true if this model instance does not yet exist in
the database. |
boolean |
isSystem() |
boolean |
isTeam() |
void |
persist()
Updates this model instance in the database or adds it if it does not yet
exist.
|
void |
prepareLocalizedFieldsForImport() |
void |
prepareLocalizedFieldsForImport(Locale defaultImportLocale) |
void |
resetOriginalValues()
Reset all original fields to current values.
|
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 |
setModelAttributes(Map<String,Object> attributes) |
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.
|
public RoleWrapper(Role role)
public Class<?> getModelClass()
getModelClass
in interface ClassedModel
public String getModelClassName()
getModelClassName
in interface ClassedModel
public Map<String,Object> getModelAttributes()
getModelAttributes
in interface BaseModel<Role>
public void setModelAttributes(Map<String,Object> attributes)
setModelAttributes
in interface BaseModel<Role>
public Object clone()
BaseModel
public int compareTo(Role role)
public String[] getAvailableLanguageIds()
getAvailableLanguageIds
in interface LocalizedModel
getAvailableLanguageIds
in interface RoleModel
public String getClassName()
getClassName
in interface RoleModel
getClassName
in interface TypedModel
public long getClassNameId()
getClassNameId
in interface RoleModel
getClassNameId
in interface TypedModel
public long getClassPK()
getClassPK
in interface AttachedModel
getClassPK
in interface RoleModel
public long getCompanyId()
getCompanyId
in interface AuditedModel
getCompanyId
in interface RoleModel
getCompanyId
in interface ShardedModel
getCompanyId
in interface StagedModel
public Date getCreateDate()
getCreateDate
in interface AuditedModel
getCreateDate
in interface RoleModel
getCreateDate
in interface StagedModel
public String getDefaultLanguageId()
getDefaultLanguageId
in interface LocalizedModel
getDefaultLanguageId
in interface RoleModel
public String getDescription()
getDescription
in interface RoleModel
public String getDescription(Locale locale)
getDescription
in interface RoleModel
locale
- the locale of the languagepublic String getDescription(Locale locale, boolean useDefault)
getDescription
in interface RoleModel
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.public String getDescription(String languageId)
getDescription
in interface RoleModel
languageId
- the ID of the languagepublic String getDescription(String languageId, boolean useDefault)
getDescription
in interface RoleModel
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested languagepublic String getDescriptionCurrentLanguageId()
getDescriptionCurrentLanguageId
in interface RoleModel
public String getDescriptionCurrentValue()
getDescriptionCurrentValue
in interface RoleModel
public Map<Locale,String> getDescriptionMap()
getDescriptionMap
in interface RoleModel
public String getDescriptiveName() throws PortalException
getDescriptiveName
in interface Role
PortalException
public ExpandoBridge getExpandoBridge()
BaseModel
getExpandoBridge
in interface BaseModel<Role>
getExpandoBridge
in interface ClassedModel
getExpandoBridge
in interface RoleModel
public Date getModifiedDate()
getModifiedDate
in interface AuditedModel
getModifiedDate
in interface RoleModel
getModifiedDate
in interface StagedModel
public long getMvccVersion()
getMvccVersion
in interface MVCCModel
getMvccVersion
in interface RoleModel
public String getName()
public long getPrimaryKey()
getPrimaryKey
in interface RoleModel
public Serializable getPrimaryKeyObj()
BaseModel
getPrimaryKeyObj
in interface BaseModel<Role>
getPrimaryKeyObj
in interface ClassedModel
getPrimaryKeyObj
in interface RoleModel
public long getRoleId()
public String getSubtype()
getSubtype
in interface RoleModel
public String getTitle()
public String getTitle(Locale locale)
public String getTitle(Locale locale, boolean useDefault)
getTitle
in interface RoleModel
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.public String getTitle(String languageId)
public String getTitle(String languageId, boolean useDefault)
public String getTitleCurrentLanguageId()
getTitleCurrentLanguageId
in interface RoleModel
public String getTitleCurrentValue()
getTitleCurrentValue
in interface RoleModel
public Map<Locale,String> getTitleMap()
getTitleMap
in interface RoleModel
public int getType()
public String getTypeLabel()
getTypeLabel
in interface Role
public long getUserId()
getUserId
in interface AuditedModel
getUserId
in interface RoleModel
public String getUserName()
getUserName
in interface AuditedModel
getUserName
in interface RoleModel
public String getUserUuid()
getUserUuid
in interface AuditedModel
getUserUuid
in interface RoleModel
public String getUuid()
getUuid
in interface RoleModel
getUuid
in interface StagedModel
public int hashCode()
public boolean isCachedModel()
BaseModel
true
if this model instance was retrieved from the
entity cache.isCachedModel
in interface BaseModel<Role>
isCachedModel
in interface RoleModel
true
if this model instance was retrieved from the
entity cache; false
otherwiseBaseModel.setCachedModel(boolean)
public boolean isEscapedModel()
BaseModel
true
if this model instance is escaped.isEscapedModel
in interface BaseModel<Role>
isEscapedModel
in interface RoleModel
true
if this model instance is escaped;
false
otherwisepublic boolean isNew()
BaseModel
true
if this model instance does not yet exist in
the database.public void persist()
PersistedModel
persist
in interface PersistedModel
public void prepareLocalizedFieldsForImport() throws LocaleException
prepareLocalizedFieldsForImport
in interface LocalizedModel
prepareLocalizedFieldsForImport
in interface RoleModel
LocaleException
public void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws LocaleException
prepareLocalizedFieldsForImport
in interface LocalizedModel
prepareLocalizedFieldsForImport
in interface RoleModel
LocaleException
public void setCachedModel(boolean cachedModel)
BaseModel
setCachedModel
in interface BaseModel<Role>
setCachedModel
in interface RoleModel
cachedModel
- whether this model instance was retrieved from the
entity cacheEntityCache
public void setClassName(String className)
setClassName
in interface RoleModel
public void setClassNameId(long classNameId)
setClassNameId
in interface RoleModel
setClassNameId
in interface TypedModel
classNameId
- the class name ID of this rolepublic void setClassPK(long classPK)
setClassPK
in interface AttachedModel
setClassPK
in interface RoleModel
classPK
- the class pk of this rolepublic void setCompanyId(long companyId)
setCompanyId
in interface AuditedModel
setCompanyId
in interface RoleModel
setCompanyId
in interface ShardedModel
setCompanyId
in interface StagedModel
companyId
- the company ID of this rolepublic void setCreateDate(Date createDate)
setCreateDate
in interface AuditedModel
setCreateDate
in interface RoleModel
setCreateDate
in interface StagedModel
createDate
- the create date of this rolepublic void setDescription(String description)
setDescription
in interface RoleModel
description
- the description of this rolepublic void setDescription(String description, Locale locale)
setDescription
in interface RoleModel
description
- the localized description of this rolelocale
- the locale of the languagepublic void setDescription(String description, Locale locale, Locale defaultLocale)
setDescription
in interface RoleModel
description
- the localized description of this rolelocale
- the locale of the languagedefaultLocale
- the default localepublic void setDescriptionCurrentLanguageId(String languageId)
setDescriptionCurrentLanguageId
in interface RoleModel
public void setDescriptionMap(Map<Locale,String> descriptionMap)
setDescriptionMap
in interface RoleModel
descriptionMap
- the locales and localized descriptions of this rolepublic void setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale)
setDescriptionMap
in interface RoleModel
descriptionMap
- the locales and localized descriptions of this roledefaultLocale
- the default localepublic void setExpandoBridgeAttributes(BaseModel<?> baseModel)
setExpandoBridgeAttributes
in interface BaseModel<Role>
setExpandoBridgeAttributes
in interface RoleModel
public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
setExpandoBridgeAttributes
in interface BaseModel<Role>
setExpandoBridgeAttributes
in interface RoleModel
public void setExpandoBridgeAttributes(ServiceContext serviceContext)
BaseModel
setExpandoBridgeAttributes
in interface BaseModel<Role>
setExpandoBridgeAttributes
in interface RoleModel
serviceContext
- the service context to be appliedServiceContext.getExpandoBridgeAttributes()
public void setModifiedDate(Date modifiedDate)
setModifiedDate
in interface AuditedModel
setModifiedDate
in interface RoleModel
setModifiedDate
in interface StagedModel
modifiedDate
- the modified date of this rolepublic void setMvccVersion(long mvccVersion)
setMvccVersion
in interface MVCCModel
setMvccVersion
in interface RoleModel
mvccVersion
- the mvcc version of this rolepublic void setName(String name)
public void setNew(boolean n)
BaseModel
public void setPrimaryKey(long primaryKey)
setPrimaryKey
in interface RoleModel
primaryKey
- the primary key of this rolepublic void setPrimaryKeyObj(Serializable primaryKeyObj)
BaseModel
setPrimaryKeyObj
in interface BaseModel<Role>
setPrimaryKeyObj
in interface ClassedModel
setPrimaryKeyObj
in interface RoleModel
primaryKeyObj
- the primary key of this model instancepublic void setRoleId(long roleId)
public void setSubtype(String subtype)
setSubtype
in interface RoleModel
subtype
- the subtype of this rolepublic void setTitle(String title)
public void setTitle(String title, Locale locale)
public void setTitle(String title, Locale locale, Locale defaultLocale)
public void setTitleCurrentLanguageId(String languageId)
setTitleCurrentLanguageId
in interface RoleModel
public void setTitleMap(Map<Locale,String> titleMap)
setTitleMap
in interface RoleModel
titleMap
- the locales and localized titles of this rolepublic void setTitleMap(Map<Locale,String> titleMap, Locale defaultLocale)
setTitleMap
in interface RoleModel
titleMap
- the locales and localized titles of this roledefaultLocale
- the default localepublic void setType(int type)
public void setUserId(long userId)
setUserId
in interface AuditedModel
setUserId
in interface RoleModel
userId
- the user ID of this rolepublic void setUserName(String userName)
setUserName
in interface AuditedModel
setUserName
in interface RoleModel
userName
- the user name of this rolepublic void setUserUuid(String userUuid)
setUserUuid
in interface AuditedModel
setUserUuid
in interface RoleModel
userUuid
- the user uuid of this rolepublic void setUuid(String uuid)
setUuid
in interface RoleModel
setUuid
in interface StagedModel
uuid
- the uuid of this rolepublic CacheModel<Role> toCacheModel()
BaseModel
toCacheModel
in interface BaseModel<Role>
toCacheModel
in interface RoleModel
public Role toEscapedModel()
BaseModel
AutoEscapeBeanHandler
.toEscapedModel
in interface BaseModel<Role>
toEscapedModel
in interface RoleModel
AutoEscapeBeanHandler
public String toString()
public Role toUnescapedModel()
toUnescapedModel
in interface BaseModel<Role>
toUnescapedModel
in interface RoleModel
public String toXmlString()
BaseModel
toXmlString
in interface BaseModel<Role>
toXmlString
in interface RoleModel
public boolean equals(Object obj)
equals
in class Object
public StagedModelType getStagedModelType()
getStagedModelType
in interface StagedModel
public Role getWrappedModel()
getWrappedModel
in interface ModelWrapper<Role>
public boolean isEntityCacheEnabled()
BaseModel
true
if this model's entity cache is enabled.isEntityCacheEnabled
in interface BaseModel<Role>
true
if this model's entity cache is enabled;
false
otherwisepublic boolean isFinderCacheEnabled()
BaseModel
true
if this model's finder cache is enabled.isFinderCacheEnabled
in interface BaseModel<Role>
true
if this model's finder cache is enabled;
false
otherwisepublic void resetOriginalValues()
BaseModel
resetOriginalValues
in interface BaseModel<Role>