com.liferay.portal.model
Interface RoleModel

All Superinterfaces:

BaseModel<Role>, Cloneable, Comparable<Role>, Serializable

All Known Subinterfaces:

Role

All Known Implementing Classes:

RoleImpl, RoleModelImpl, RoleWrapper

public interface RoleModel
extends 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.

Never modify or reference this interface directly. All methods that expect a role model instance should use the Role interface instead.

See Also:

Role, RoleImpl, RoleModelImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(Role role)
String	getClassName() Gets the class name of the model instance this role is polymorphically associated with.
long	getClassNameId() Gets the class name id of this role.
long	getClassPK() Gets the class p k of this role.
long	getCompanyId() Gets the company id of this role.
String	getDescription() Gets the description of this role.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
String	getName() Gets the name of this role.
long	getPrimaryKey() Gets the primary key of this role.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
long	getRoleId() Gets the role id of this role.
String	getSubtype() Gets the subtype of this role.
String	getTitle() Gets the title of this role.
String	getTitle(Locale locale) Gets the localized title of this role.
String	getTitle(Locale locale, boolean useDefault) Gets the localized title of this role, optionally using the default language if no localization exists for the requested language.
String	getTitle(String languageId) Gets the localized title of this role.
String	getTitle(String languageId, boolean useDefault) Gets the localized title of this role, optionally using the default language if no localization exists for the requested language.
Map<Locale,String>	getTitleMap() Gets a map of the locales and localized title of this role.
int	getType() Gets the type of this role.
int	hashCode()
boolean	isCachedModel() Determines if this model instance was retrieved from the entity cache.
boolean	isEscapedModel() Determines if this model instance is escaped.
boolean	isNew() Determines if this model instance does not yet exist in the database.
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
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	setEscapedModel(boolean escapedModel) Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.
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 pk) 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	setTitle(Locale locale, String title) Sets the localized title of this role.
void	setTitle(String title) Sets the title of this role.
void	setTitleMap(Map<Locale,String> titleMap) Sets the localized titles of this role from the map of locales and localized titles.
void	setType(int type) Sets the type of this role.
Role	toEscapedModel() Gets a copy of this role as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
String	toXmlString() Gets the XML representation of this model instance.

Method Detail

getPrimaryKey

long getPrimaryKey()

Gets the primary key of this role.

Returns:

the primary key of this role

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this role

Parameters:

pk - the primary key of this role

getRoleId

long getRoleId()

Gets 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()

Gets 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()

Gets the class name of the model instance this role is polymorphically associated with.

Returns:

the class name of the model instance this role is polymorphically associated with

getClassNameId

long getClassNameId()

Gets the class name id of this role.

Returns:

the class name id of this role

setClassNameId

void setClassNameId(long classNameId)

Sets the class name id of this role.

Parameters:

classNameId - the class name id of this role

getClassPK

long getClassPK()

Gets the class p k of this role.

Returns:

the class p k of this role

setClassPK

void setClassPK(long classPK)

Sets the class p k of this role.

Parameters:

classPK - the class p k of this role

getName

@AutoEscape
String getName()

Gets 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()

Gets the title of this role.

Returns:

the title of this role

getTitle

String getTitle(Locale locale)

Gets the localized title of this role. Uses the default language if no localization exists for the requested language.

Parameters:

locale - the locale to get the localized title for

Returns:

the localized title of this role

getTitle

String getTitle(Locale locale,
                boolean useDefault)

Gets the localized title of this role, optionally using the default language if no localization exists for the requested language.

Parameters:

locale - the local to get the localized title for

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

String getTitle(String languageId)

Gets the localized title of this role. Uses the default language if no localization exists for the requested language.

Parameters:

languageId - the id of the language to get the localized title for

Returns:

the localized title of this role

getTitle

String getTitle(String languageId,
                boolean useDefault)

Gets the localized title of this role, optionally using the default language if no localization exists for the requested language.

Parameters:

languageId - the id of the language to get the localized title for

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

Returns:

the localized title of this role

getTitleMap

Map<Locale,String> getTitleMap()

Gets a map of the locales and localized title of this role.

Returns:

the locales and localized title

setTitle

void setTitle(String title)

Sets the title of this role.

Parameters:

title - the title of this role

setTitle

void setTitle(Locale locale,
              String title)

Sets the localized title of this role.

Parameters:

locale - the locale to set the localized title for

title - the localized title of this role

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

getDescription

@AutoEscape
String getDescription()

Gets the description of this role.

Returns:

the description of this role

setDescription

void setDescription(String description)

Sets the description of this role.

Parameters:

description - the description of this role

getType

int getType()

Gets 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()

Gets 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

toEscapedModel

Role toEscapedModel()

Gets a copy of this role as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

isNew

boolean isNew()

Description copied from interface: BaseModel

Determines 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

Determines 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

Determines if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<Role>

Returns:

true if this model instance is escaped; false otherwise

See Also:

BaseModel.setEscapedModel(boolean)

setEscapedModel

void setEscapedModel(boolean escapedModel)

Description copied from interface: BaseModel

Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.

A model instance can be made escaped by wrapping it with an HTML auto escape handler using its toEscapedModel method. For example, UserModel.toEscapedModel().

Specified by:

setEscapedModel in interface BaseModel<Role>

Parameters:

escapedModel - whether this model instance is escaped

See Also:

AutoEscapeBeanHandler

getPrimaryKeyObj

Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Gets the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<Role>

Returns:

the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Gets the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<Role>

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 to retrieve the expando bridge attributes from

See Also:

ServiceContext.getExpandoBridgeAttributes( )

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

toString

String toString()

Overrides:

toString in class Object

toXmlString

String toXmlString()

Description copied from interface: BaseModel

Gets the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<Role>

Returns:

the XML representation of this model instance