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
modelFields 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.longReturns the class name ID of this role.longReturns the class pk of this role.longReturns the company ID of this role.Returns the create date of this role.longReturns 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.longReturns the mvcc version of this role.getName()Returns the name of this role.longReturns the primary key of this role.longReturns 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.intgetType()Returns the type of this role.longReturns 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.booleanisSystem()booleanisTeam()voidpersist()Updates this model instance in the database or adds it if it does not yet exist.voidvoidprepareLocalizedFieldsForImport(Locale defaultImportLocale) voidsetClassName(String className) voidsetClassNameId(long classNameId) Sets the class name ID of this role.voidsetClassPK(long classPK) Sets the class pk of this role.voidsetCompanyId(long companyId) Sets the company ID of this role.voidsetCreateDate(Date createDate) Sets the create date of this role.voidsetCtCollectionId(long ctCollectionId) Sets the ct collection ID of this role.voidsetDescription(String description) Sets the description of this role.voidsetDescription(String description, Locale locale) Sets the localized description of this role in the language.voidsetDescription(String description, Locale locale, Locale defaultLocale) Sets the localized description of this role in the language, and sets the default locale.voidsetDescriptionCurrentLanguageId(String languageId) voidsetDescriptionMap(Map<Locale, String> descriptionMap) Sets the localized descriptions of this role from the map of locales and localized descriptions.voidsetDescriptionMap(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.voidsetExternalReferenceCode(String externalReferenceCode) Sets the external reference code of this role.voidsetModelAttributes(Map<String, Object> attributes) voidsetModifiedDate(Date modifiedDate) Sets the modified date of this role.voidsetMvccVersion(long mvccVersion) Sets the mvcc version of this role.voidSets the name of this role.voidsetPrimaryKey(long primaryKey) Sets the primary key of this role.voidsetRoleId(long roleId) Sets the role ID of this role.voidsetSubtype(String subtype) Sets the subtype of this role.voidSets the title of this role.voidSets the localized title of this role in the language.voidSets the localized title of this role in the language, and sets the default locale.voidsetTitleCurrentLanguageId(String languageId) voidsetTitleMap(Map<Locale, String> titleMap) Sets the localized titles of this role from the map of locales and localized titles.voidsetTitleMap(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.voidsetType(int type) Sets the type of this role.voidsetUserId(long userId) Sets the user ID of this role.voidsetUserName(String userName) Sets the user name of this role.voidsetUserUuid(String userUuid) Sets the user uuid of this role.voidSets the uuid of this role.protected RoleWrapperMethods 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, toUnescapedModelMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods 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, toUnescapedModelMethods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassNameMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface com.liferay.portal.kernel.model.ModelWrapper
getWrappedModelMethods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone
-
Constructor Details
-
RoleWrapper
-
-
Method Details
-
getModelAttributes
- Specified by:
getModelAttributesin interfaceBaseModel<Role>
-
setModelAttributes
- Specified by:
setModelAttributesin interfaceBaseModel<Role>
-
cloneWithOriginalValues
- Specified by:
cloneWithOriginalValuesin interfaceBaseModel<Role>- Specified by:
cloneWithOriginalValuesin interfaceRoleModel
-
getAvailableLanguageIds
- Specified by:
getAvailableLanguageIdsin interfaceLocalizedModel- Specified by:
getAvailableLanguageIdsin interfaceRoleModel
-
getClassName
Returns the fully qualified class name of this role.- Specified by:
getClassNamein interfaceRoleModel- Specified by:
getClassNamein interfaceTypedModel- Returns:
- the fully qualified class name of this role
-
getClassNameId
public long getClassNameId()Returns the class name ID of this role.- Specified by:
getClassNameIdin interfaceRoleModel- Specified by:
getClassNameIdin interfaceTypedModel- Returns:
- the class name ID of this role
-
getClassPK
public long getClassPK()Returns the class pk of this role.- Specified by:
getClassPKin interfaceAttachedModel- Specified by:
getClassPKin interfaceRoleModel- Returns:
- the class pk of this role
-
getCompanyId
public long getCompanyId()Returns the company ID of this role.- Specified by:
getCompanyIdin interfaceAuditedModel- Specified by:
getCompanyIdin interfaceRoleModel- Specified by:
getCompanyIdin interfaceShardedModel- Specified by:
getCompanyIdin interfaceStagedModel- Returns:
- the company ID of this role
-
getCreateDate
Returns the create date of this role.- Specified by:
getCreateDatein interfaceAuditedModel- Specified by:
getCreateDatein interfaceRoleModel- Specified by:
getCreateDatein interfaceStagedModel- Returns:
- the create date of this role
-
getCtCollectionId
public long getCtCollectionId()Returns the ct collection ID of this role.- Specified by:
getCtCollectionIdin interfaceCTModel<Role>- Specified by:
getCtCollectionIdin interfaceRoleModel- Returns:
- the ct collection ID of this role
-
getDefaultLanguageId
- Specified by:
getDefaultLanguageIdin interfaceLocalizedModel- Specified by:
getDefaultLanguageIdin interfaceRoleModel
-
getDescription
Returns the description of this role.- Specified by:
getDescriptionin 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:
getDescriptionin 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:
getDescriptionin 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
useDefaultisfalseand 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:
getDescriptionin 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:
getDescriptionin 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:
getDescriptionCurrentLanguageIdin interfaceRoleModel
-
getDescriptionCurrentValue
- Specified by:
getDescriptionCurrentValuein interfaceRoleModel
-
getDescriptionMap
Returns a map of the locales and localized descriptions of this role.- Specified by:
getDescriptionMapin interfaceRoleModel- Returns:
- the locales and localized descriptions of this role
-
getDescriptiveName
- Specified by:
getDescriptiveNamein interfaceRole- Throws:
PortalException
-
getExternalReferenceCode
Returns the external reference code of this role.- Specified by:
getExternalReferenceCodein interfaceExternalReferenceCodeModel- Specified by:
getExternalReferenceCodein interfaceRoleModel- Returns:
- the external reference code of this role
-
getIconCssClass
- Specified by:
getIconCssClassin interfaceRole
-
getModifiedDate
Returns the modified date of this role.- Specified by:
getModifiedDatein interfaceAuditedModel- Specified by:
getModifiedDatein interfaceRoleModel- Specified by:
getModifiedDatein interfaceStagedModel- Returns:
- the modified date of this role
-
getMvccVersion
public long getMvccVersion()Returns the mvcc version of this role.- Specified by:
getMvccVersionin interfaceMVCCModel- Specified by:
getMvccVersionin 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:
getPrimaryKeyin interfaceCTModel<Role>- Specified by:
getPrimaryKeyin 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:
getSubtypein 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:
getTitlein 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
useDefaultisfalseand 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:
getTitleCurrentLanguageIdin interfaceRoleModel
-
getTitleCurrentValue
- Specified by:
getTitleCurrentValuein interfaceRoleModel
-
getTitleMap
Returns a map of the locales and localized titles of this role.- Specified by:
getTitleMapin interfaceRoleModel- Returns:
- the locales and localized titles of this role
-
getType
public int getType()Returns the type of this role. -
getTypeLabel
- Specified by:
getTypeLabelin interfaceRole
-
getUserId
public long getUserId()Returns the user ID of this role.- Specified by:
getUserIdin interfaceAuditedModel- Specified by:
getUserIdin interfaceRoleModel- Returns:
- the user ID of this role
-
getUserName
Returns the user name of this role.- Specified by:
getUserNamein interfaceAuditedModel- Specified by:
getUserNamein interfaceRoleModel- Returns:
- the user name of this role
-
getUserUuid
Returns the user uuid of this role.- Specified by:
getUserUuidin interfaceAuditedModel- Specified by:
getUserUuidin interfaceRoleModel- Returns:
- the user uuid of this role
-
getUuid
Returns the uuid of this role.- Specified by:
getUuidin interfaceRoleModel- Specified by:
getUuidin interfaceStagedModel- Returns:
- the uuid of this role
-
isSystem
public boolean isSystem() -
isTeam
public boolean isTeam() -
persist
public void persist()Description copied from interface:PersistedModelUpdates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.- Specified by:
persistin interfacePersistedModel
-
prepareLocalizedFieldsForImport
- Specified by:
prepareLocalizedFieldsForImportin interfaceLocalizedModel- Specified by:
prepareLocalizedFieldsForImportin interfaceRoleModel- Throws:
LocaleException
-
prepareLocalizedFieldsForImport
- Specified by:
prepareLocalizedFieldsForImportin interfaceLocalizedModel- Specified by:
prepareLocalizedFieldsForImportin interfaceRoleModel- Throws:
LocaleException
-
setClassName
- Specified by:
setClassNamein interfaceRoleModel
-
setClassNameId
public void setClassNameId(long classNameId) Sets the class name ID of this role.- Specified by:
setClassNameIdin interfaceRoleModel- Specified by:
setClassNameIdin 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:
setClassPKin interfaceAttachedModel- Specified by:
setClassPKin interfaceRoleModel- Parameters:
classPK- the class pk of this role
-
setCompanyId
public void setCompanyId(long companyId) Sets the company ID of this role.- Specified by:
setCompanyIdin interfaceAuditedModel- Specified by:
setCompanyIdin interfaceRoleModel- Specified by:
setCompanyIdin interfaceShardedModel- Specified by:
setCompanyIdin interfaceStagedModel- Parameters:
companyId- the company ID of this role
-
setCreateDate
Sets the create date of this role.- Specified by:
setCreateDatein interfaceAuditedModel- Specified by:
setCreateDatein interfaceRoleModel- Specified by:
setCreateDatein 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:
setCtCollectionIdin interfaceCTModel<Role>- Specified by:
setCtCollectionIdin interfaceRoleModel- Parameters:
ctCollectionId- the ct collection ID of this role
-
setDescription
Sets the description of this role.- Specified by:
setDescriptionin interfaceRoleModel- Parameters:
description- the description of this role
-
setDescription
Sets the localized description of this role in the language.- Specified by:
setDescriptionin 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:
setDescriptionin interfaceRoleModel- Parameters:
description- the localized description of this rolelocale- the locale of the languagedefaultLocale- the default locale
-
setDescriptionCurrentLanguageId
- Specified by:
setDescriptionCurrentLanguageIdin interfaceRoleModel
-
setDescriptionMap
Sets the localized descriptions of this role from the map of locales and localized descriptions.- Specified by:
setDescriptionMapin 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:
setDescriptionMapin 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:
setExternalReferenceCodein interfaceExternalReferenceCodeModel- Specified by:
setExternalReferenceCodein interfaceRoleModel- Parameters:
externalReferenceCode- the external reference code of this role
-
setModifiedDate
Sets the modified date of this role.- Specified by:
setModifiedDatein interfaceAuditedModel- Specified by:
setModifiedDatein interfaceRoleModel- Specified by:
setModifiedDatein interfaceStagedModel- Parameters:
modifiedDate- the modified date of this role
-
setMvccVersion
public void setMvccVersion(long mvccVersion) Sets the mvcc version of this role.- Specified by:
setMvccVersionin interfaceMVCCModel- Specified by:
setMvccVersionin 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:
setPrimaryKeyin interfaceCTModel<Role>- Specified by:
setPrimaryKeyin 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:
setSubtypein 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:
setTitleCurrentLanguageIdin interfaceRoleModel
-
setTitleMap
Sets the localized titles of this role from the map of locales and localized titles.- Specified by:
setTitleMapin 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:
setTitleMapin 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:
setUserIdin interfaceAuditedModel- Specified by:
setUserIdin interfaceRoleModel- Parameters:
userId- the user ID of this role
-
setUserName
Sets the user name of this role.- Specified by:
setUserNamein interfaceAuditedModel- Specified by:
setUserNamein interfaceRoleModel- Parameters:
userName- the user name of this role
-
setUserUuid
Sets the user uuid of this role.- Specified by:
setUserUuidin interfaceAuditedModel- Specified by:
setUserUuidin interfaceRoleModel- Parameters:
userUuid- the user uuid of this role
-
setUuid
Sets the uuid of this role.- Specified by:
setUuidin interfaceRoleModel- Specified by:
setUuidin interfaceStagedModel- Parameters:
uuid- the uuid of this role
-
toXmlString
- Specified by:
toXmlStringin interfaceRoleModel
-
getAttributeGetterFunctions
- Specified by:
getAttributeGetterFunctionsin interfaceBaseModel<Role>
-
getAttributeSetterBiConsumers
- Specified by:
getAttributeSetterBiConsumersin interfaceBaseModel<Role>
-
getStagedModelType
- Specified by:
getStagedModelTypein interfaceStagedModel
-
wrap
- Specified by:
wrapin classBaseModelWrapper<Role>
-