Liferay 6.0.3

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>

This interface is a model that represents the Role_ table in the database.

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()
           
 long getClassNameId()
           
 long getClassPK()
           
 long getCompanyId()
           
 String getDescription()
           
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 String getName()
           
 long getPrimaryKey()
           
 Serializable getPrimaryKeyObj()
          Gets the primary key for this model instance.
 long getRoleId()
           
 String getSubtype()
           
 String getTitle()
           
 String getTitle(Locale locale)
           
 String getTitle(Locale locale, boolean useDefault)
           
 String getTitle(String languageId)
           
 String getTitle(String languageId, boolean useDefault)
           
 Map<Locale,String> getTitleMap()
           
 int getType()
           
 int hashCode()
           
 boolean isCachedModel()
          Determines if this model instance was retrieved from the entity cache.
 boolean isEscapedModel()
          Determines if this model instance has been wrapped with an HTML auto escape handler.
 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)
           
 void setClassPK(long classPK)
           
 void setCompanyId(long companyId)
           
 void setDescription(String description)
           
 void setEscapedModel(boolean escapedModel)
          Sets whether this model instance has been wrapped with an HTML auto escape handler.
 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)
           
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setPrimaryKey(long pk)
           
 void setRoleId(long roleId)
           
 void setSubtype(String subtype)
           
 void setTitle(Locale locale, String title)
           
 void setTitle(String title)
           
 void setTitleMap(Map<Locale,String> titleMap)
           
 void setType(int type)
           
 Role toEscapedModel()
           
 String toString()
           
 String toXmlString()
          Gets the XML representation of this model instance.
 

Method Detail

getPrimaryKey

long getPrimaryKey()

setPrimaryKey

void setPrimaryKey(long pk)

getRoleId

long getRoleId()

setRoleId

void setRoleId(long roleId)

getCompanyId

long getCompanyId()

setCompanyId

void setCompanyId(long companyId)

getClassName

String getClassName()

getClassNameId

long getClassNameId()

setClassNameId

void setClassNameId(long classNameId)

getClassPK

long getClassPK()

setClassPK

void setClassPK(long classPK)

getName

String getName()

setName

void setName(String name)

getTitle

String getTitle()

getTitle

String getTitle(Locale locale)

getTitle

String getTitle(Locale locale,
                boolean useDefault)

getTitle

String getTitle(String languageId)

getTitle

String getTitle(String languageId,
                boolean useDefault)

getTitleMap

Map<Locale,String> getTitleMap()

setTitle

void setTitle(String title)

setTitle

void setTitle(Locale locale,
              String title)

setTitleMap

void setTitleMap(Map<Locale,String> titleMap)

getDescription

String getDescription()

setDescription

void setDescription(String description)

getType

int getType()

setType

void setType(int type)

getSubtype

String getSubtype()

setSubtype

void setSubtype(String subtype)

toEscapedModel

Role toEscapedModel()

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 has been wrapped with an HTML auto escape handler.

Specified by:
isEscapedModel in interface BaseModel<Role>
Returns:
true if this model instance has been wrapped with an HTML auto escape handler; false otherwise
See Also:
BaseModel.setEscapedModel(boolean)

setEscapedModel

void setEscapedModel(boolean escapedModel)
Description copied from interface: BaseModel
Sets whether this model instance has been wrapped with an HTML auto escape handler.

A model instance can be wrapped 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 has been wrapped with an HTML auto escape handler
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Gets the primary key for this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<Role>
Returns:
the primary key

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

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 clone

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

Liferay 6.0.3