Liferay 6.1.2-ce-ga3

com.liferay.portal.model
Interface RoleModel

All Superinterfaces:
AttachedModel, BaseModel<Role>, ClassedModel, Cloneable, Comparable<Role>, Serializable
All Known Subinterfaces:
Role
All Known Implementing Classes:
RoleWrapper

public interface RoleModel
extends AttachedModel, BaseModel<Role>

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.

See Also:
Role, RoleImpl, RoleModelImpl

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(Role role)
           
 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.
 String getDescription()
          Returns the description of this role.
 String getDescription(Locale locale)
          Returns the localized description of this role in the language.
 String 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.
 String getDescription(String languageId)
          Returns the localized description of this role in the language.
 String 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.
 String getDescriptionCurrentLanguageId()
           
 String getDescriptionCurrentValue()
           
 Map<Locale,String> getDescriptionMap()
          Returns a map of the locales and localized descriptions of this role.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 String getName()
          Returns the name of this role.
 long getPrimaryKey()
          Returns the primary key of this role.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 long getRoleId()
          Returns the role ID of this role.
 String getSubtype()
          Returns the subtype of this role.
 String getTitle()
          Returns the title of this role.
 String getTitle(Locale locale)
          Returns the localized title of this role in the language.
 String getTitle(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.
 String getTitle(String languageId)
          Returns the localized title of this role in the language.
 String getTitle(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.
 String getTitleCurrentLanguageId()
           
 String getTitleCurrentValue()
           
 Map<Locale,String> getTitleMap()
          Returns a map of the locales and localized titles of this role.
 int getType()
          Returns the type 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(Locale defaultImportLocale)
           
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setClassName(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 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 setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
 void setName(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(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setRoleId(long roleId)
          Sets the role ID of this role.
 void setSubtype(String subtype)
          Sets the subtype of this role.
 void setTitle(String title)
          Sets the title of this role.
 void setTitle(String title, Locale locale)
          Sets the localized title of this role in the language.
 void setTitle(String title, Locale locale, Locale defaultLocale)
          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.
 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.
 String toString()
           
 Role toUnescapedModel()
           
 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.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

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.

Returns:
the company ID of this role

setCompanyId

void setCompanyId(long companyId)
Sets the company ID of this role.

Parameters:
companyId - the company ID of this role

getClassName

String getClassName()
Returns the fully qualified class name of this role.

Specified by:
getClassName in interface AttachedModel
Returns:
the fully qualified class name of this role

setClassName

void setClassName(String className)

getClassNameId

long getClassNameId()
Returns the class name ID of this role.

Specified by:
getClassNameId in interface AttachedModel
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 AttachedModel
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
String getName()
Returns the name of this role.

Returns:
the name of this role

setName

void setName(String name)
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

@AutoEscape
String getTitle(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
String getTitle(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
String getTitle(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
String getTitle(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
String getTitleCurrentLanguageId()

getTitleCurrentValue

@AutoEscape
String getTitleCurrentValue()

getTitleMap

Map<Locale,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(String title)
Sets the title of this role.

Parameters:
title - the title of this role

setTitle

void setTitle(String title,
              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(String title,
              Locale locale,
              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(String languageId)

setTitleMap

void setTitleMap(Map<Locale,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(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.

Parameters:
titleMap - the locales and localized titles of this role
defaultLocale - the default locale

getDescription

String getDescription()
Returns the description of this role.

Returns:
the description of this role

getDescription

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

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
String getDescription(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
String 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.

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
String getDescriptionCurrentLanguageId()

getDescriptionCurrentValue

@AutoEscape
String getDescriptionCurrentValue()

getDescriptionMap

Map<Locale,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(String description)
Sets the description of this role.

Parameters:
description - the description of this role

setDescription

void setDescription(String description,
                    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(String description,
                    Locale locale,
                    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(String languageId)

setDescriptionMap

void setDescriptionMap(Map<Locale,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(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.

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
String getSubtype()
Returns the subtype of this role.

Returns:
the subtype of this role

setSubtype

void setSubtype(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

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(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(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
See Also:
ServiceContext.getExpandoBridgeAttributes( )

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
                                     throws LocaleException
Throws:
LocaleException

clone

Object clone()
Description copied from interface: BaseModel
Creates a shallow clone of this model instance.

Specified by:
clone in interface BaseModel<Role>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(Role role)
Specified by:
compareTo in interface Comparable<Role>

hashCode

int hashCode()
Overrides:
hashCode in class 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

String toString()
Overrides:
toString in class Object

toXmlString

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

Liferay 6.1.2-ce-ga3