Package com.liferay.portal.kernel.model
Class RoleWrapper
Object
com.liferay.portal.kernel.model.wrapper.BaseModelWrapper<Role>
com.liferay.portal.kernel.model.RoleWrapper
- All Implemented Interfaces:
AttachedModel
,AuditedModel
,BaseModel<Role>
,CTModel<Role>
,ClassedModel
,ExternalReferenceCodeModel
,LocalizedModel
,ModelWrapper<Role>
,MVCCModel
,PersistedModel
,Role
,RoleModel
,ShardedModel
,StagedAuditedModel
,StagedModel
,TypedModel
,Serializable
,Cloneable
,Comparable<Role>
This class is a wrapper for Role
.
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Field Summary
Fields inherited from class com.liferay.portal.kernel.model.wrapper.BaseModelWrapper
model
Fields inherited from interface com.liferay.portal.kernel.model.Role
NAME_ACCESSOR, ROLE_ID_ACCESSOR, TITLE_ACCESSOR
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionString[]
Returns the fully qualified class name of this role.long
Returns the class name ID of this role.long
Returns the class pk of this role.long
Returns the company ID of this role.Returns the create date of this role.long
Returns the ct collection ID of this role.Returns the description of this role.getDescription
(String languageId) Returns the localized description of this role in the language.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.getDescription
(Locale locale) Returns the localized description of this role in the language.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.Returns a map of the locales and localized descriptions of this role.Returns the external reference code of this role.Returns the modified date of this role.long
Returns the mvcc version of this role.getName()
Returns the name of this role.long
Returns the primary key of this role.long
Returns the role ID of this role.Returns the subtype of this role.getTitle()
Returns the title of this role.Returns the localized title of this role in the language.Returns the localized title of this role in the language, optionally using the default language if no localization exists for the requested language.Returns the localized title of this role in the language.Returns the localized title of this role 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 role.int
getType()
Returns the type of this role.long
Returns the user ID of this role.Returns the user name of this role.Returns the user uuid of this role.getUuid()
Returns the uuid of this role.boolean
isSystem()
boolean
isTeam()
void
persist()
Updates this model instance in the database or adds it if it does not yet exist.void
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
setCtCollectionId
(long ctCollectionId) Sets the ct collection ID 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
setExternalReferenceCode
(String externalReferenceCode) Sets the external reference code of this role.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
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
Sets the title of this role.void
Sets the localized title of this role in the language.void
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
Sets the uuid of this role.protected RoleWrapper
Methods inherited from class com.liferay.portal.kernel.model.wrapper.BaseModelWrapper
clone, compareTo, equals, getExpandoBridge, getModelClass, getModelClassName, getPrimaryKeyObj, getWrappedModel, hashCode, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toString, toUnescapedModel
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getExpandoBridge, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, 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.ModelWrapper
getWrappedModel
Methods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone
-
Constructor Details
-
RoleWrapper
-
-
Method Details
-
getModelAttributes
- Specified by:
getModelAttributes
in interfaceBaseModel<Role>
-
setModelAttributes
- Specified by:
setModelAttributes
in interfaceBaseModel<Role>
-
cloneWithOriginalValues
- Specified by:
cloneWithOriginalValues
in interfaceBaseModel<Role>
- Specified by:
cloneWithOriginalValues
in interfaceRoleModel
-
getAvailableLanguageIds
- Specified by:
getAvailableLanguageIds
in interfaceLocalizedModel
- Specified by:
getAvailableLanguageIds
in interfaceRoleModel
-
getClassName
Returns the fully qualified class name of this role.- Specified by:
getClassName
in interfaceRoleModel
- Specified by:
getClassName
in interfaceTypedModel
- Returns:
- the fully qualified class name of this role
-
getClassNameId
public long getClassNameId()Returns the class name ID of this role.- Specified by:
getClassNameId
in interfaceRoleModel
- Specified by:
getClassNameId
in interfaceTypedModel
- Returns:
- the class name ID of this role
-
getClassPK
public long getClassPK()Returns the class pk of this role.- Specified by:
getClassPK
in interfaceAttachedModel
- Specified by:
getClassPK
in interfaceRoleModel
- Returns:
- the class pk of this role
-
getCompanyId
public long getCompanyId()Returns the company ID of this role.- Specified by:
getCompanyId
in interfaceAuditedModel
- Specified by:
getCompanyId
in interfaceRoleModel
- Specified by:
getCompanyId
in interfaceShardedModel
- Specified by:
getCompanyId
in interfaceStagedModel
- Returns:
- the company ID of this role
-
getCreateDate
Returns the create date of this role.- Specified by:
getCreateDate
in interfaceAuditedModel
- Specified by:
getCreateDate
in interfaceRoleModel
- Specified by:
getCreateDate
in interfaceStagedModel
- Returns:
- the create date of this role
-
getCtCollectionId
public long getCtCollectionId()Returns the ct collection ID of this role.- Specified by:
getCtCollectionId
in interfaceCTModel<Role>
- Specified by:
getCtCollectionId
in interfaceRoleModel
- Returns:
- the ct collection ID of this role
-
getDefaultLanguageId
- Specified by:
getDefaultLanguageId
in interfaceLocalizedModel
- Specified by:
getDefaultLanguageId
in interfaceRoleModel
-
getDescription
Returns the description of this role.- Specified by:
getDescription
in interfaceRoleModel
- Returns:
- the description of this role
-
getDescription
Returns the localized description of this role in the language. Uses the default language if no localization exists for the requested language.- Specified by:
getDescription
in interfaceRoleModel
- Parameters:
locale
- the locale of the language- Returns:
- the localized description of this role
-
getDescription
Returns the localized description of this role in the language, optionally using the default language if no localization exists for the requested language.- Specified by:
getDescription
in interfaceRoleModel
- Parameters:
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized description of this role. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getDescription
Returns the localized description of this role in the language. Uses the default language if no localization exists for the requested language.- Specified by:
getDescription
in interfaceRoleModel
- Parameters:
languageId
- the ID of the language- Returns:
- the localized description of this role
-
getDescription
Returns the localized description of this role in the language, optionally using the default language if no localization exists for the requested language.- Specified by:
getDescription
in interfaceRoleModel
- Parameters:
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized description of this role
-
getDescriptionCurrentLanguageId
- Specified by:
getDescriptionCurrentLanguageId
in interfaceRoleModel
-
getDescriptionCurrentValue
- Specified by:
getDescriptionCurrentValue
in interfaceRoleModel
-
getDescriptionMap
Returns a map of the locales and localized descriptions of this role.- Specified by:
getDescriptionMap
in interfaceRoleModel
- Returns:
- the locales and localized descriptions of this role
-
getDescriptiveName
- Specified by:
getDescriptiveName
in interfaceRole
- Throws:
PortalException
-
getExternalReferenceCode
Returns the external reference code of this role.- Specified by:
getExternalReferenceCode
in interfaceExternalReferenceCodeModel
- Specified by:
getExternalReferenceCode
in interfaceRoleModel
- Returns:
- the external reference code of this role
-
getIconCssClass
- Specified by:
getIconCssClass
in interfaceRole
-
getModifiedDate
Returns the modified date of this role.- Specified by:
getModifiedDate
in interfaceAuditedModel
- Specified by:
getModifiedDate
in interfaceRoleModel
- Specified by:
getModifiedDate
in interfaceStagedModel
- Returns:
- the modified date of this role
-
getMvccVersion
public long getMvccVersion()Returns the mvcc version of this role.- Specified by:
getMvccVersion
in interfaceMVCCModel
- Specified by:
getMvccVersion
in interfaceRoleModel
- Returns:
- the mvcc version of this role
-
getName
Returns the name of this role. -
getPrimaryKey
public long getPrimaryKey()Returns the primary key of this role.- Specified by:
getPrimaryKey
in interfaceCTModel<Role>
- Specified by:
getPrimaryKey
in interfaceRoleModel
- Returns:
- the primary key of this role
-
getRoleId
public long getRoleId()Returns the role ID of this role. -
getSubtype
Returns the subtype of this role.- Specified by:
getSubtype
in interfaceRoleModel
- Returns:
- the subtype of this role
-
getTitle
Returns the title of this role. -
getTitle
Returns the localized title of this role in the language. Uses the default language if no localization exists for the requested language. -
getTitle
Returns the localized title of this role in the language, optionally using the default language if no localization exists for the requested language.- Specified by:
getTitle
in interfaceRoleModel
- Parameters:
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized title of this role. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getTitle
Returns the localized title of this role in the language. Uses the default language if no localization exists for the requested language. -
getTitle
Returns the localized title of this role in the language, optionally using the default language if no localization exists for the requested language. -
getTitleCurrentLanguageId
- Specified by:
getTitleCurrentLanguageId
in interfaceRoleModel
-
getTitleCurrentValue
- Specified by:
getTitleCurrentValue
in interfaceRoleModel
-
getTitleMap
Returns a map of the locales and localized titles of this role.- Specified by:
getTitleMap
in interfaceRoleModel
- Returns:
- the locales and localized titles of this role
-
getType
public int getType()Returns the type of this role. -
getTypeLabel
- Specified by:
getTypeLabel
in interfaceRole
-
getUserId
public long getUserId()Returns the user ID of this role.- Specified by:
getUserId
in interfaceAuditedModel
- Specified by:
getUserId
in interfaceRoleModel
- Returns:
- the user ID of this role
-
getUserName
Returns the user name of this role.- Specified by:
getUserName
in interfaceAuditedModel
- Specified by:
getUserName
in interfaceRoleModel
- Returns:
- the user name of this role
-
getUserUuid
Returns the user uuid of this role.- Specified by:
getUserUuid
in interfaceAuditedModel
- Specified by:
getUserUuid
in interfaceRoleModel
- Returns:
- the user uuid of this role
-
getUuid
Returns the uuid of this role.- Specified by:
getUuid
in interfaceRoleModel
- Specified by:
getUuid
in interfaceStagedModel
- Returns:
- the uuid of this role
-
isSystem
public boolean isSystem() -
isTeam
public boolean isTeam() -
persist
public void persist()Description copied from interface:PersistedModel
Updates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.- Specified by:
persist
in interfacePersistedModel
-
prepareLocalizedFieldsForImport
- Specified by:
prepareLocalizedFieldsForImport
in interfaceLocalizedModel
- Specified by:
prepareLocalizedFieldsForImport
in interfaceRoleModel
- Throws:
LocaleException
-
prepareLocalizedFieldsForImport
- Specified by:
prepareLocalizedFieldsForImport
in interfaceLocalizedModel
- Specified by:
prepareLocalizedFieldsForImport
in interfaceRoleModel
- Throws:
LocaleException
-
setClassName
- Specified by:
setClassName
in interfaceRoleModel
-
setClassNameId
public void setClassNameId(long classNameId) Sets the class name ID of this role.- Specified by:
setClassNameId
in interfaceRoleModel
- Specified by:
setClassNameId
in interfaceTypedModel
- Parameters:
classNameId
- the class name ID of this role
-
setClassPK
public void setClassPK(long classPK) Sets the class pk of this role.- Specified by:
setClassPK
in interfaceAttachedModel
- Specified by:
setClassPK
in interfaceRoleModel
- Parameters:
classPK
- the class pk of this role
-
setCompanyId
public void setCompanyId(long companyId) Sets the company ID of this role.- Specified by:
setCompanyId
in interfaceAuditedModel
- Specified by:
setCompanyId
in interfaceRoleModel
- Specified by:
setCompanyId
in interfaceShardedModel
- Specified by:
setCompanyId
in interfaceStagedModel
- Parameters:
companyId
- the company ID of this role
-
setCreateDate
Sets the create date of this role.- Specified by:
setCreateDate
in interfaceAuditedModel
- Specified by:
setCreateDate
in interfaceRoleModel
- Specified by:
setCreateDate
in interfaceStagedModel
- Parameters:
createDate
- the create date of this role
-
setCtCollectionId
public void setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this role.- Specified by:
setCtCollectionId
in interfaceCTModel<Role>
- Specified by:
setCtCollectionId
in interfaceRoleModel
- Parameters:
ctCollectionId
- the ct collection ID of this role
-
setDescription
Sets the description of this role.- Specified by:
setDescription
in interfaceRoleModel
- Parameters:
description
- the description of this role
-
setDescription
Sets the localized description of this role in the language.- Specified by:
setDescription
in interfaceRoleModel
- Parameters:
description
- the localized description of this rolelocale
- the locale of the language
-
setDescription
Sets the localized description of this role in the language, and sets the default locale.- Specified by:
setDescription
in interfaceRoleModel
- Parameters:
description
- the localized description of this rolelocale
- the locale of the languagedefaultLocale
- the default locale
-
setDescriptionCurrentLanguageId
- Specified by:
setDescriptionCurrentLanguageId
in interfaceRoleModel
-
setDescriptionMap
Sets the localized descriptions of this role from the map of locales and localized descriptions.- Specified by:
setDescriptionMap
in interfaceRoleModel
- Parameters:
descriptionMap
- the locales and localized descriptions of this role
-
setDescriptionMap
Sets the localized descriptions of this role from the map of locales and localized descriptions, and sets the default locale.- Specified by:
setDescriptionMap
in interfaceRoleModel
- Parameters:
descriptionMap
- the locales and localized descriptions of this roledefaultLocale
- the default locale
-
setExternalReferenceCode
Sets the external reference code of this role.- Specified by:
setExternalReferenceCode
in interfaceExternalReferenceCodeModel
- Specified by:
setExternalReferenceCode
in interfaceRoleModel
- Parameters:
externalReferenceCode
- the external reference code of this role
-
setModifiedDate
Sets the modified date of this role.- Specified by:
setModifiedDate
in interfaceAuditedModel
- Specified by:
setModifiedDate
in interfaceRoleModel
- Specified by:
setModifiedDate
in interfaceStagedModel
- Parameters:
modifiedDate
- the modified date of this role
-
setMvccVersion
public void setMvccVersion(long mvccVersion) Sets the mvcc version of this role.- Specified by:
setMvccVersion
in interfaceMVCCModel
- Specified by:
setMvccVersion
in interfaceRoleModel
- Parameters:
mvccVersion
- the mvcc version of this role
-
setName
Sets the name of this role. -
setPrimaryKey
public void setPrimaryKey(long primaryKey) Sets the primary key of this role.- Specified by:
setPrimaryKey
in interfaceCTModel<Role>
- Specified by:
setPrimaryKey
in interfaceRoleModel
- Parameters:
primaryKey
- the primary key of this role
-
setRoleId
public void setRoleId(long roleId) Sets the role ID of this role. -
setSubtype
Sets the subtype of this role.- Specified by:
setSubtype
in interfaceRoleModel
- Parameters:
subtype
- the subtype of this role
-
setTitle
Sets the title of this role. -
setTitle
Sets the localized title of this role in the language. -
setTitle
Sets the localized title of this role in the language, and sets the default locale. -
setTitleCurrentLanguageId
- Specified by:
setTitleCurrentLanguageId
in interfaceRoleModel
-
setTitleMap
Sets the localized titles of this role from the map of locales and localized titles.- Specified by:
setTitleMap
in interfaceRoleModel
- Parameters:
titleMap
- the locales and localized titles of this role
-
setTitleMap
Sets the localized titles of this role from the map of locales and localized titles, and sets the default locale.- Specified by:
setTitleMap
in interfaceRoleModel
- Parameters:
titleMap
- the locales and localized titles of this roledefaultLocale
- the default locale
-
setType
public void setType(int type) Sets the type of this role. -
setUserId
public void setUserId(long userId) Sets the user ID of this role.- Specified by:
setUserId
in interfaceAuditedModel
- Specified by:
setUserId
in interfaceRoleModel
- Parameters:
userId
- the user ID of this role
-
setUserName
Sets the user name of this role.- Specified by:
setUserName
in interfaceAuditedModel
- Specified by:
setUserName
in interfaceRoleModel
- Parameters:
userName
- the user name of this role
-
setUserUuid
Sets the user uuid of this role.- Specified by:
setUserUuid
in interfaceAuditedModel
- Specified by:
setUserUuid
in interfaceRoleModel
- Parameters:
userUuid
- the user uuid of this role
-
setUuid
Sets the uuid of this role.- Specified by:
setUuid
in interfaceRoleModel
- Specified by:
setUuid
in interfaceStagedModel
- Parameters:
uuid
- the uuid of this role
-
toXmlString
- Specified by:
toXmlString
in interfaceRoleModel
-
getAttributeGetterFunctions
- Specified by:
getAttributeGetterFunctions
in interfaceBaseModel<Role>
-
getAttributeSetterBiConsumers
- Specified by:
getAttributeSetterBiConsumers
in interfaceBaseModel<Role>
-
getStagedModelType
- Specified by:
getStagedModelType
in interfaceStagedModel
-
wrap
- Specified by:
wrap
in classBaseModelWrapper<Role>
-