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.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.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.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.default StringMethods 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, 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.StagedModel
clone, getStagedModelType
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this role.- Specified by:
getPrimaryKeyin interfaceCTModel<Role>- Returns:
- the primary key of this role
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this role.- Specified by:
setPrimaryKeyin interfaceCTModel<Role>- Parameters:
primaryKey- the primary key of this role
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this role.- Specified by:
getMvccVersionin interfaceMVCCModel- Returns:
- the mvcc version of this role
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this role.- Specified by:
setMvccVersionin interfaceMVCCModel- Parameters:
mvccVersion- the mvcc version of this role
-
getCtCollectionId
long getCtCollectionId()Returns the ct collection ID of this role.- Specified by:
getCtCollectionIdin 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:
setCtCollectionIdin interfaceCTModel<Role>- Parameters:
ctCollectionId- the ct collection ID of this role
-
getUuid
Returns the uuid of this role.- Specified by:
getUuidin interfaceStagedModel- Returns:
- the uuid of this role
-
setUuid
Sets the uuid of this role.- Specified by:
setUuidin interfaceStagedModel- Parameters:
uuid- the uuid of this role
-
getExternalReferenceCode
Returns the external reference code of this role.- Specified by:
getExternalReferenceCodein interfaceExternalReferenceCodeModel- Returns:
- the external reference code of this role
-
setExternalReferenceCode
Sets the external reference code of this role.- Specified by:
setExternalReferenceCodein 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:
getCompanyIdin interfaceAuditedModel- Specified by:
getCompanyIdin interfaceShardedModel- Specified by:
getCompanyIdin interfaceStagedModel- Returns:
- the company ID of this role
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this role.- Specified by:
setCompanyIdin interfaceAuditedModel- Specified by:
setCompanyIdin interfaceShardedModel- Specified by:
setCompanyIdin interfaceStagedModel- Parameters:
companyId- the company ID of this role
-
getUserId
long getUserId()Returns the user ID of this role.- Specified by:
getUserIdin interfaceAuditedModel- Returns:
- the user ID of this role
-
setUserId
void setUserId(long userId) Sets the user ID of this role.- Specified by:
setUserIdin interfaceAuditedModel- Parameters:
userId- the user ID of this role
-
getUserUuid
String getUserUuid()Returns the user uuid of this role.- Specified by:
getUserUuidin interfaceAuditedModel- Returns:
- the user uuid of this role
-
setUserUuid
Sets the user uuid of this role.- Specified by:
setUserUuidin interfaceAuditedModel- Parameters:
userUuid- the user uuid of this role
-
getUserName
Returns the user name of this role.- Specified by:
getUserNamein interfaceAuditedModel- Returns:
- the user name of this role
-
setUserName
Sets the user name of this role.- Specified by:
setUserNamein interfaceAuditedModel- Parameters:
userName- the user name of this role
-
getCreateDate
Date getCreateDate()Returns the create date of this role.- Specified by:
getCreateDatein interfaceAuditedModel- Specified by:
getCreateDatein interfaceStagedModel- Returns:
- the create date of this role
-
setCreateDate
Sets the create date of this role.- Specified by:
setCreateDatein interfaceAuditedModel- Specified by:
setCreateDatein interfaceStagedModel- Parameters:
createDate- the create date of this role
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this role.- Specified by:
getModifiedDatein interfaceAuditedModel- Specified by:
getModifiedDatein interfaceStagedModel- Returns:
- the modified date of this role
-
setModifiedDate
Sets the modified date of this role.- Specified by:
setModifiedDatein interfaceAuditedModel- Specified by:
setModifiedDatein interfaceStagedModel- Parameters:
modifiedDate- the modified date of this role
-
getClassName
String getClassName()Returns the fully qualified class name of this role.- Specified by:
getClassNamein interfaceTypedModel- Returns:
- the fully qualified class name of this role
-
setClassName
-
getClassNameId
long getClassNameId()Returns the class name ID of this role.- Specified by:
getClassNameIdin interfaceTypedModel- Returns:
- the class name ID of this role
-
setClassNameId
void setClassNameId(long classNameId) Sets the class name ID of this role.- Specified by:
setClassNameIdin interfaceTypedModel- Parameters:
classNameId- the class name ID of this role
-
getClassPK
long getClassPK()Returns the class pk of this role.- Specified by:
getClassPKin interfaceAttachedModel- Returns:
- the class pk of this role
-
setClassPK
void setClassPK(long classPK) Sets the class pk of this role.- Specified by:
setClassPKin 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
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.- 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
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.- 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:
getAvailableLanguageIdsin interfaceLocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageIdin interfaceLocalizedModel
-
prepareLocalizedFieldsForImport
- Specified by:
prepareLocalizedFieldsForImportin interfaceLocalizedModel- Throws:
LocaleException
-
prepareLocalizedFieldsForImport
- Specified by:
prepareLocalizedFieldsForImportin interfaceLocalizedModel- Throws:
LocaleException
-
cloneWithOriginalValues
Role cloneWithOriginalValues()- Specified by:
cloneWithOriginalValuesin interfaceBaseModel<Role>
-
toXmlString
-