Package com.liferay.portal.kernel.model
Interface RoleModel
- All Superinterfaces:
AttachedModel
,AuditedModel
,BaseModel<Role>
,ClassedModel
,Cloneable
,Comparable<Role>
,CTModel<Role>
,ExternalReferenceCodeModel
,LocalizedModel
,MVCCModel
,Serializable
,ShardedModel
,StagedAuditedModel
,StagedModel
,TypedModel
- All Known Subinterfaces:
Role
- All Known Implementing Classes:
RoleWrapper
@ProviderType
public interface RoleModel
extends AttachedModel, BaseModel<Role>, CTModel<Role>, ExternalReferenceCodeModel, LocalizedModel, MVCCModel, ShardedModel, StagedAuditedModel
The base model interface for the Role service. Represents a row in the "Role_" database table, with each column mapped to a property of this class.
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
.
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
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.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
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.default String
Methods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, 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.StagedModel
clone, getStagedModelType
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this role.- Specified by:
getPrimaryKey
in interfaceCTModel<Role>
- Returns:
- the primary key of this role
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this role.- Specified by:
setPrimaryKey
in interfaceCTModel<Role>
- Parameters:
primaryKey
- the primary key of this role
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this role.- Specified by:
getMvccVersion
in interfaceMVCCModel
- Returns:
- the mvcc version of this role
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this role.- Specified by:
setMvccVersion
in interfaceMVCCModel
- Parameters:
mvccVersion
- the mvcc version of this role
-
getCtCollectionId
long getCtCollectionId()Returns the ct collection ID of this role.- Specified by:
getCtCollectionId
in interfaceCTModel<Role>
- Returns:
- the ct collection ID of this role
-
setCtCollectionId
void setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this role.- Specified by:
setCtCollectionId
in interfaceCTModel<Role>
- Parameters:
ctCollectionId
- the ct collection ID of this role
-
getUuid
Returns the uuid of this role.- Specified by:
getUuid
in interfaceStagedModel
- Returns:
- the uuid of this role
-
setUuid
Sets the uuid of this role.- Specified by:
setUuid
in interfaceStagedModel
- Parameters:
uuid
- the uuid of this role
-
getExternalReferenceCode
Returns the external reference code of this role.- Specified by:
getExternalReferenceCode
in interfaceExternalReferenceCodeModel
- Returns:
- the external reference code of this role
-
setExternalReferenceCode
Sets the external reference code of this role.- Specified by:
setExternalReferenceCode
in interfaceExternalReferenceCodeModel
- Parameters:
externalReferenceCode
- the external reference code of this role
-
getRoleId
long getRoleId()Returns the role ID of this role.- Returns:
- the role ID of this role
-
setRoleId
void setRoleId(long roleId) Sets the role ID of this role.- Parameters:
roleId
- the role ID of this role
-
getCompanyId
long getCompanyId()Returns the company ID of this role.- Specified by:
getCompanyId
in interfaceAuditedModel
- Specified by:
getCompanyId
in interfaceShardedModel
- Specified by:
getCompanyId
in interfaceStagedModel
- Returns:
- the company ID of this role
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this role.- Specified by:
setCompanyId
in interfaceAuditedModel
- Specified by:
setCompanyId
in interfaceShardedModel
- Specified by:
setCompanyId
in interfaceStagedModel
- Parameters:
companyId
- the company ID of this role
-
getUserId
long getUserId()Returns the user ID of this role.- Specified by:
getUserId
in interfaceAuditedModel
- Returns:
- the user ID of this role
-
setUserId
void setUserId(long userId) Sets the user ID of this role.- Specified by:
setUserId
in interfaceAuditedModel
- Parameters:
userId
- the user ID of this role
-
getUserUuid
String getUserUuid()Returns the user uuid of this role.- Specified by:
getUserUuid
in interfaceAuditedModel
- Returns:
- the user uuid of this role
-
setUserUuid
Sets the user uuid of this role.- Specified by:
setUserUuid
in interfaceAuditedModel
- Parameters:
userUuid
- the user uuid of this role
-
getUserName
Returns the user name of this role.- Specified by:
getUserName
in interfaceAuditedModel
- Returns:
- the user name of this role
-
setUserName
Sets the user name of this role.- Specified by:
setUserName
in interfaceAuditedModel
- Parameters:
userName
- the user name of this role
-
getCreateDate
Date getCreateDate()Returns the create date of this role.- Specified by:
getCreateDate
in interfaceAuditedModel
- Specified by:
getCreateDate
in interfaceStagedModel
- Returns:
- the create date of this role
-
setCreateDate
Sets the create date of this role.- Specified by:
setCreateDate
in interfaceAuditedModel
- Specified by:
setCreateDate
in interfaceStagedModel
- Parameters:
createDate
- the create date of this role
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this role.- Specified by:
getModifiedDate
in interfaceAuditedModel
- Specified by:
getModifiedDate
in interfaceStagedModel
- Returns:
- the modified date of this role
-
setModifiedDate
Sets the modified date of this role.- Specified by:
setModifiedDate
in interfaceAuditedModel
- Specified by:
setModifiedDate
in interfaceStagedModel
- Parameters:
modifiedDate
- the modified date of this role
-
getClassName
String getClassName()Returns the fully qualified class name of this role.- Specified by:
getClassName
in interfaceTypedModel
- Returns:
- the fully qualified class name of this role
-
setClassName
-
getClassNameId
long getClassNameId()Returns the class name ID of this role.- Specified by:
getClassNameId
in interfaceTypedModel
- Returns:
- the class name ID of this role
-
setClassNameId
void setClassNameId(long classNameId) Sets the class name ID of this role.- Specified by:
setClassNameId
in interfaceTypedModel
- Parameters:
classNameId
- the class name ID of this role
-
getClassPK
long getClassPK()Returns the class pk of this role.- Specified by:
getClassPK
in interfaceAttachedModel
- Returns:
- the class pk of this role
-
setClassPK
void setClassPK(long classPK) Sets the class pk of this role.- Specified by:
setClassPK
in interfaceAttachedModel
- Parameters:
classPK
- the class pk of this role
-
getName
Returns the name of this role.- Returns:
- the name of this role
-
setName
Sets the name of this role.- Parameters:
name
- the name of this role
-
getTitle
String getTitle()Returns the title of this role.- 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.- Parameters:
locale
- the locale of the language- Returns:
- the localized title of this role
-
getTitle
Returns the localized title of this role in the language, optionally using the default language if no localization exists for the requested language.- 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.- Parameters:
languageId
- the ID of the language- Returns:
- the localized title of this role
-
getTitle
Returns the localized title of this role in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized title of this role
-
getTitleCurrentLanguageId
-
getTitleCurrentValue
-
getTitleMap
Returns a map of the locales and localized titles of this role.- Returns:
- the locales and localized titles of this role
-
setTitle
Sets the title of this role.- Parameters:
title
- the title of this role
-
setTitle
Sets the localized title of this role in the language.- Parameters:
title
- the localized title of this rolelocale
- the locale of the language
-
setTitle
Sets the localized title of this role in the language, and sets the default locale.- Parameters:
title
- the localized title of this rolelocale
- the locale of the languagedefaultLocale
- the default locale
-
setTitleCurrentLanguageId
-
setTitleMap
Sets the localized titles of this role from the map of locales and localized titles.- 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.- Parameters:
titleMap
- the locales and localized titles of this roledefaultLocale
- the default locale
-
getDescription
String getDescription()Returns the description of this role.- 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.- 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.- 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.- 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.- 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
-
getDescriptionCurrentValue
-
getDescriptionMap
Returns a map of the locales and localized descriptions of this role.- Returns:
- the locales and localized descriptions of this role
-
setDescription
Sets the description of this role.- Parameters:
description
- the description of this role
-
setDescription
Sets the localized description of this role in the language.- 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.- Parameters:
description
- the localized description of this rolelocale
- the locale of the languagedefaultLocale
- the default locale
-
setDescriptionCurrentLanguageId
-
setDescriptionMap
Sets the localized descriptions of this role from the map of locales and localized descriptions.- 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.- Parameters:
descriptionMap
- the locales and localized descriptions of this roledefaultLocale
- the default locale
-
getType
int getType()Returns the type of this role.- Returns:
- the type of this role
-
setType
void setType(int type) Sets the type of this role.- Parameters:
type
- the type of this role
-
getSubtype
Returns the subtype of this role.- Returns:
- the subtype of this role
-
setSubtype
Sets the subtype of this role.- Parameters:
subtype
- the subtype of this role
-
getAvailableLanguageIds
String[] getAvailableLanguageIds()- Specified by:
getAvailableLanguageIds
in interfaceLocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageId
in interfaceLocalizedModel
-
prepareLocalizedFieldsForImport
- Specified by:
prepareLocalizedFieldsForImport
in interfaceLocalizedModel
- Throws:
LocaleException
-
prepareLocalizedFieldsForImport
- Specified by:
prepareLocalizedFieldsForImport
in interfaceLocalizedModel
- Throws:
LocaleException
-
cloneWithOriginalValues
Role cloneWithOriginalValues()- Specified by:
cloneWithOriginalValues
in interfaceBaseModel<Role>
-
toXmlString
-