com.liferay.portal.model
Interface RoleModel

All Superinterfaces:

AttachedModel, AuditedModel, BaseModel<Role>, ClassedModel, java.lang.Cloneable, java.lang.Comparable<Role>, java.io.Serializable, StagedAuditedModel, StagedModel, TypedModel

All Known Subinterfaces:

Role

All Known Implementing Classes:

RoleWrapper

@ProviderType
public interface RoleModel
extends AttachedModel, BaseModel<Role>, 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 RoleModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in RoleImpl.

Author:

Brian Wing Shun Chan

See Also:

Role, RoleImpl, RoleModelImpl

Generated:

Method Summary

java.lang.Object	clone() Creates a shallow clone of this model instance.
int	compareTo(Role role)
java.lang.String[]	getAvailableLanguageIds()
java.lang.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 p k of this role.
long	getCompanyId() Returns the company ID of this role.
java.util.Date	getCreateDate() Returns the create date of this role.
java.lang.String	getDefaultLanguageId()
java.lang.String	getDescription() Returns the description of this role.
java.lang.String	getDescription(java.util.Locale locale) Returns the localized description of this role in the language.
java.lang.String	getDescription(java.util.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.
java.lang.String	getDescription(java.lang.String languageId) Returns the localized description of this role in the language.
java.lang.String	getDescription(java.lang.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.
java.lang.String	getDescriptionCurrentLanguageId()
java.lang.String	getDescriptionCurrentValue()
java.util.Map<java.util.Locale,java.lang.String>	getDescriptionMap() Returns a map of the locales and localized descriptions of this role.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
java.util.Date	getModifiedDate() Returns the modified date of this role.
java.lang.String	getName() Returns the name of this role.
long	getPrimaryKey() Returns the primary key of this role.
java.io.Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
long	getRoleId() Returns the role ID of this role.
java.lang.String	getSubtype() Returns the subtype of this role.
java.lang.String	getTitle() Returns the title of this role.
java.lang.String	getTitle(java.util.Locale locale) Returns the localized title of this role in the language.
java.lang.String	getTitle(java.util.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.
java.lang.String	getTitle(java.lang.String languageId) Returns the localized title of this role in the language.
java.lang.String	getTitle(java.lang.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.
java.lang.String	getTitleCurrentLanguageId()
java.lang.String	getTitleCurrentValue()
java.util.Map<java.util.Locale,java.lang.String>	getTitleMap() Returns a map of the locales and localized titles of this role.
int	getType() Returns the type of this role.
long	getUserId() Returns the user ID of this role.
java.lang.String	getUserName() Returns the user name of this role.
java.lang.String	getUserUuid() Returns the user uuid of this role.
java.lang.String	getUuid() Returns the uuid of this role.
int	hashCode()
boolean	isCachedModel() Returns true if this model instance was retrieved from the entity cache.
boolean	isEscapedModel() Returns true if this model instance is escaped.
boolean	isNew() Returns true if this model instance does not yet exist in the database.
void	prepareLocalizedFieldsForImport()
void	prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setClassName(java.lang.String className)
void	setClassNameId(long classNameId) Sets the class name ID of this role.
void	setClassPK(long classPK) Sets the class p k of this role.
void	setCompanyId(long companyId) Sets the company ID of this role.
void	setCreateDate(java.util.Date createDate) Sets the create date of this role.
void	setDescription(java.lang.String description) Sets the description of this role.
void	setDescription(java.lang.String description, java.util.Locale locale) Sets the localized description of this role in the language.
void	setDescription(java.lang.String description, java.util.Locale locale, java.util.Locale defaultLocale) Sets the localized description of this role in the language, and sets the default locale.
void	setDescriptionCurrentLanguageId(java.lang.String languageId)
void	setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap) Sets the localized descriptions of this role from the map of locales and localized descriptions.
void	setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.util.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	setModifiedDate(java.util.Date modifiedDate) Sets the modified date of this role.
void	setName(java.lang.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(java.io.Serializable primaryKeyObj) Sets the primary key of this model instance.
void	setRoleId(long roleId) Sets the role ID of this role.
void	setSubtype(java.lang.String subtype) Sets the subtype of this role.
void	setTitle(java.lang.String title) Sets the title of this role.
void	setTitle(java.lang.String title, java.util.Locale locale) Sets the localized title of this role in the language.
void	setTitle(java.lang.String title, java.util.Locale locale, java.util.Locale defaultLocale) Sets the localized title of this role in the language, and sets the default locale.
void	setTitleCurrentLanguageId(java.lang.String languageId)
void	setTitleMap(java.util.Map<java.util.Locale,java.lang.String> titleMap) Sets the localized titles of this role from the map of locales and localized titles.
void	setTitleMap(java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.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(java.lang.String userName) Sets the user name of this role.
void	setUserUuid(java.lang.String userUuid) Sets the user uuid of this role.
void	setUuid(java.lang.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.
java.lang.String	toString()
Role	toUnescapedModel()
java.lang.String	toXmlString() Returns the XML representation of this model instance.

Methods inherited from interface com.liferay.portal.model.BaseModel

getModelAttributes, resetOriginalValues, setModelAttributes

Methods inherited from interface com.liferay.portal.model.StagedModel

getStagedModelType

Methods inherited from interface com.liferay.portal.model.ClassedModel

getModelClass, getModelClassName

Method Detail

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this role.

Returns:

the primary key of this role

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this role.

Parameters:

primaryKey - the primary key of this role

getUuid

@AutoEscape
java.lang.String getUuid()

Returns the uuid of this role.

Specified by:

getUuid in interface StagedModel

Returns:

the uuid of this role

setUuid

void setUuid(java.lang.String uuid)

Sets the uuid of this role.

Specified by:

setUuid in interface StagedModel

Parameters:

uuid - the uuid 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 interface AuditedModel

Specified by:

getCompanyId in interface StagedModel

Returns:

the company ID of this role

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this role.

Specified by:

setCompanyId in interface AuditedModel

Specified by:

setCompanyId in interface StagedModel

Parameters:

companyId - the company ID of this role

getUserId

long getUserId()

Returns the user ID of this role.

Specified by:

getUserId in interface AuditedModel

Returns:

the user ID of this role

setUserId

void setUserId(long userId)

Sets the user ID of this role.

Specified by:

setUserId in interface AuditedModel

Parameters:

userId - the user ID of this role

getUserUuid

java.lang.String getUserUuid()
                             throws SystemException

Returns the user uuid of this role.

Specified by:

getUserUuid in interface AuditedModel

Returns:

the user uuid of this role

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(java.lang.String userUuid)

Sets the user uuid of this role.

Specified by:

setUserUuid in interface AuditedModel

Parameters:

userUuid - the user uuid of this role

getUserName

@AutoEscape
java.lang.String getUserName()

Returns the user name of this role.

Specified by:

getUserName in interface AuditedModel

Returns:

the user name of this role

setUserName

void setUserName(java.lang.String userName)

Sets the user name of this role.

Specified by:

setUserName in interface AuditedModel

Parameters:

userName - the user name of this role

getCreateDate

java.util.Date getCreateDate()

Returns the create date of this role.

Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface StagedModel

Returns:

the create date of this role

setCreateDate

void setCreateDate(java.util.Date createDate)

Sets the create date of this role.

Specified by:

setCreateDate in interface AuditedModel

Specified by:

setCreateDate in interface StagedModel

Parameters:

createDate - the create date of this role

getModifiedDate

java.util.Date getModifiedDate()

Returns the modified date of this role.

Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface StagedModel

Returns:

the modified date of this role

setModifiedDate

void setModifiedDate(java.util.Date modifiedDate)

Sets the modified date of this role.

Specified by:

setModifiedDate in interface AuditedModel

Specified by:

setModifiedDate in interface StagedModel

Parameters:

modifiedDate - the modified date of this role

getClassName

java.lang.String getClassName()

Returns the fully qualified class name of this role.

Specified by:

getClassName in interface TypedModel

Returns:

the fully qualified class name of this role

setClassName

void setClassName(java.lang.String className)

getClassNameId

long getClassNameId()

Returns the class name ID of this role.

Specified by:

getClassNameId in interface TypedModel

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 interface TypedModel

Parameters:

classNameId - the class name ID of this role

getClassPK

long getClassPK()

Returns the class p k of this role.

Specified by:

getClassPK in interface AttachedModel

Returns:

the class p k of this role

setClassPK

void setClassPK(long classPK)

Sets the class p k of this role.

Specified by:

setClassPK in interface AttachedModel

Parameters:

classPK - the class p k of this role

getName

@AutoEscape
java.lang.String getName()

Returns the name of this role.

Returns:

the name of this role

setName

void setName(java.lang.String name)

Sets the name of this role.

Parameters:

name - the name of this role

getTitle

java.lang.String getTitle()

Returns the title of this role.

Returns:

the title of this role

getTitle

@AutoEscape
java.lang.String getTitle(java.util.Locale locale)

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

@AutoEscape
java.lang.String getTitle(java.util.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.

Parameters:

locale - the local of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized title of this role. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getTitle

@AutoEscape
java.lang.String getTitle(java.lang.String languageId)

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

@AutoEscape
java.lang.String getTitle(java.lang.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.

Parameters:

languageId - the ID of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized title of this role

getTitleCurrentLanguageId

@AutoEscape
java.lang.String getTitleCurrentLanguageId()

getTitleCurrentValue

@AutoEscape
java.lang.String getTitleCurrentValue()

getTitleMap

java.util.Map<java.util.Locale,java.lang.String> getTitleMap()

Returns a map of the locales and localized titles of this role.

Returns:

the locales and localized titles of this role

setTitle

void setTitle(java.lang.String title)

Sets the title of this role.

Parameters:

title - the title of this role

setTitle

void setTitle(java.lang.String title,
              java.util.Locale locale)

Sets the localized title of this role in the language.

Parameters:

title - the localized title of this role

locale - the locale of the language

setTitle

void setTitle(java.lang.String title,
              java.util.Locale locale,
              java.util.Locale defaultLocale)

Sets the localized title of this role in the language, and sets the default locale.

Parameters:

title - the localized title of this role

locale - the locale of the language

defaultLocale - the default locale

setTitleCurrentLanguageId

void setTitleCurrentLanguageId(java.lang.String languageId)

setTitleMap

void setTitleMap(java.util.Map<java.util.Locale,java.lang.String> titleMap)

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

void setTitleMap(java.util.Map<java.util.Locale,java.lang.String> titleMap,
                 java.util.Locale defaultLocale)

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 role

defaultLocale - the default locale

getDescription

java.lang.String getDescription()

Returns the description of this role.

Returns:

the description of this role

getDescription

@AutoEscape
java.lang.String getDescription(java.util.Locale locale)

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

@AutoEscape
java.lang.String getDescription(java.util.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.

Parameters:

locale - the local of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized description of this role. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getDescription

@AutoEscape
java.lang.String getDescription(java.lang.String languageId)

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

@AutoEscape
java.lang.String getDescription(java.lang.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.

Parameters:

languageId - the ID of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized description of this role

getDescriptionCurrentLanguageId

@AutoEscape
java.lang.String getDescriptionCurrentLanguageId()

getDescriptionCurrentValue

@AutoEscape
java.lang.String getDescriptionCurrentValue()

getDescriptionMap

java.util.Map<java.util.Locale,java.lang.String> getDescriptionMap()

Returns a map of the locales and localized descriptions of this role.

Returns:

the locales and localized descriptions of this role

setDescription

void setDescription(java.lang.String description)

Sets the description of this role.

Parameters:

description - the description of this role

setDescription

void setDescription(java.lang.String description,
                    java.util.Locale locale)

Sets the localized description of this role in the language.

Parameters:

description - the localized description of this role

locale - the locale of the language

setDescription

void setDescription(java.lang.String description,
                    java.util.Locale locale,
                    java.util.Locale defaultLocale)

Sets the localized description of this role in the language, and sets the default locale.

Parameters:

description - the localized description of this role

locale - the locale of the language

defaultLocale - the default locale

setDescriptionCurrentLanguageId

void setDescriptionCurrentLanguageId(java.lang.String languageId)

setDescriptionMap

void setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap)

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

void setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                       java.util.Locale defaultLocale)

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 role

defaultLocale - 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

@AutoEscape
java.lang.String getSubtype()

Returns the subtype of this role.

Returns:

the subtype of this role

setSubtype

void setSubtype(java.lang.String subtype)

Sets the subtype of this role.

Parameters:

subtype - the subtype of this role

isNew

boolean isNew()

Description copied from interface: BaseModel

Returns true if this model instance does not yet exist in the database.

Specified by:

isNew in interface BaseModel<Role>

Returns:

true if this model instance does not yet exist in the database; false otherwise

setNew

void setNew(boolean n)

Description copied from interface: BaseModel

Sets whether this model instance does not yet exist in the database.

Specified by:

setNew in interface BaseModel<Role>

Parameters:

n - whether this model instance does not yet exist in the database

isCachedModel

boolean isCachedModel()

Description copied from interface: BaseModel

Returns true if this model instance was retrieved from the entity cache.

Specified by:

isCachedModel in interface BaseModel<Role>

Returns:

true if this model instance was retrieved from the entity cache; false otherwise

See Also:

BaseModel.setCachedModel(boolean)

setCachedModel

void setCachedModel(boolean cachedModel)

Description copied from interface: BaseModel

Sets whether this model instance was retrieved from the entity cache.

Specified by:

setCachedModel in interface BaseModel<Role>

Parameters:

cachedModel - whether this model instance was retrieved from the entity cache

See Also:

EntityCache

isEscapedModel

boolean isEscapedModel()

Description copied from interface: BaseModel

Returns true if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<Role>

Returns:

true if this model instance is escaped; false otherwise

getPrimaryKeyObj

java.io.Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Returns the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<Role>

Specified by:

getPrimaryKeyObj in interface ClassedModel

Returns:

the primary key of this model instance

setPrimaryKeyObj

void setPrimaryKeyObj(java.io.Serializable primaryKeyObj)

Description copied from interface: BaseModel

Sets the primary key of this model instance.

Specified by:

setPrimaryKeyObj in interface BaseModel<Role>

Specified by:

setPrimaryKeyObj in interface ClassedModel

Parameters:

primaryKeyObj - the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Returns the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<Role>

Specified by:

getExpandoBridge in interface ClassedModel

Returns:

the expando bridge for this model instance

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(BaseModel<?> baseModel)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<Role>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<Role>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ServiceContext serviceContext)

Description copied from interface: BaseModel

Sets the expando bridge attributes for this model instance to the attributes stored in the service context.

Specified by:

setExpandoBridgeAttributes in interface BaseModel<Role>

Parameters:

serviceContext - the service context to be applied

See Also:

ServiceContext.getExpandoBridgeAttributes( )

getAvailableLanguageIds

java.lang.String[] getAvailableLanguageIds()

getDefaultLanguageId

java.lang.String getDefaultLanguageId()

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport()
                                     throws LocaleException

Throws:

LocaleException

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
                                     throws LocaleException

Throws:

LocaleException

clone

java.lang.Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<Role>

Specified by:

clone in interface StagedModel

Returns:

the shallow clone of this model instance

compareTo

int compareTo(Role role)

Specified by:

compareTo in interface java.lang.Comparable<Role>

hashCode

int hashCode()

Overrides:

hashCode in class java.lang.Object

toCacheModel

CacheModel<Role> toCacheModel()

Description copied from interface: BaseModel

Returns a cache model object for this entity used by entity cache.

Specified by:

toCacheModel in interface BaseModel<Role>

Returns:

the cache model object

toEscapedModel

Role toEscapedModel()

Description copied from interface: BaseModel

Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:

toEscapedModel in interface BaseModel<Role>

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

Role toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<Role>

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object

toXmlString

java.lang.String toXmlString()

Description copied from interface: BaseModel

Returns the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<Role>

Returns:

the XML representation of this model instance