Liferay 6.0-ee

com.liferay.portal.model
Class RoleWrapper

java.lang.Object
  extended by com.liferay.portal.model.RoleWrapper
All Implemented Interfaces:
BaseModel<Role>, Role, RoleModel, Serializable, Cloneable, Comparable<Role>

public class RoleWrapper
extends Object
implements Role

This class is a wrapper for Role.

See Also:
Role, Serialized Form
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
RoleWrapper(Role role)
           
 
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.
 String getDescriptiveName()
           
 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.
 String getTypeLabel()
           
 Role getWrappedRole()
           
 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.
 boolean isTeam()
           
 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 entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 String toXmlString()
          Gets the XML representation of this model instance.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RoleWrapper

public RoleWrapper(Role role)
Method Detail

getPrimaryKey

public long getPrimaryKey()
Gets the primary key of this role.

Specified by:
getPrimaryKey in interface RoleModel
Returns:
the primary key of this role

setPrimaryKey

public void setPrimaryKey(long pk)
Sets the primary key of this role

Specified by:
setPrimaryKey in interface RoleModel
Parameters:
pk - the primary key of this role

getRoleId

public long getRoleId()
Gets the role id of this role.

Specified by:
getRoleId in interface RoleModel
Returns:
the role id of this role

setRoleId

public void setRoleId(long roleId)
Sets the role id of this role.

Specified by:
setRoleId in interface RoleModel
Parameters:
roleId - the role id of this role

getCompanyId

public long getCompanyId()
Gets the company id of this role.

Specified by:
getCompanyId in interface RoleModel
Returns:
the company id of this role

setCompanyId

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

Specified by:
setCompanyId in interface RoleModel
Parameters:
companyId - the company id of this role

getClassName

public String getClassName()
Gets the class name of the model instance this role is polymorphically associated with.

Specified by:
getClassName in interface RoleModel
Returns:
the class name of the model instance this role is polymorphically associated with

getClassNameId

public long getClassNameId()
Gets the class name id of this role.

Specified by:
getClassNameId in interface RoleModel
Returns:
the class name id of this role

setClassNameId

public void setClassNameId(long classNameId)
Sets the class name id of this role.

Specified by:
setClassNameId in interface RoleModel
Parameters:
classNameId - the class name id of this role

getClassPK

public long getClassPK()
Gets the class p k of this role.

Specified by:
getClassPK in interface RoleModel
Returns:
the class p k of this role

setClassPK

public void setClassPK(long classPK)
Sets the class p k of this role.

Specified by:
setClassPK in interface RoleModel
Parameters:
classPK - the class p k of this role

getName

public String getName()
Gets the name of this role.

Specified by:
getName in interface RoleModel
Returns:
the name of this role

setName

public void setName(String name)
Sets the name of this role.

Specified by:
setName in interface RoleModel
Parameters:
name - the name of this role

getTitle

public String getTitle()
Gets the title of this role.

Specified by:
getTitle in interface RoleModel
Returns:
the title of this role

getTitle

public String getTitle(Locale locale)
Gets the localized title of this role. Uses the default language if no localization exists for the requested language.

Specified by:
getTitle in interface RoleModel
Parameters:
locale - the locale to get the localized title for
Returns:
the localized title of this role

getTitle

public 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.

Specified by:
getTitle in interface RoleModel
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

public String getTitle(String languageId)
Gets the localized title of this role. Uses the default language if no localization exists for the requested language.

Specified by:
getTitle in interface Role
Specified by:
getTitle in interface RoleModel
Parameters:
languageId - the id of the language to get the localized title for
Returns:
the localized title of this role

getTitle

public 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.

Specified by:
getTitle in interface Role
Specified by:
getTitle in interface RoleModel
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

public Map<Locale,String> getTitleMap()
Gets a map of the locales and localized title of this role.

Specified by:
getTitleMap in interface RoleModel
Returns:
the locales and localized title

setTitle

public void setTitle(String title)
Sets the title of this role.

Specified by:
setTitle in interface RoleModel
Parameters:
title - the title of this role

setTitle

public void setTitle(Locale locale,
                     String title)
Sets the localized title of this role.

Specified by:
setTitle in interface RoleModel
Parameters:
locale - the locale to set the localized title for
title - the localized title of this role

setTitleMap

public void setTitleMap(Map<Locale,String> titleMap)
Sets the localized titles of this role from the map of locales and localized titles.

Specified by:
setTitleMap in interface RoleModel
Parameters:
titleMap - the locales and localized titles of this role

getDescription

public String getDescription()
Gets the description of this role.

Specified by:
getDescription in interface RoleModel
Returns:
the description of this role

setDescription

public void setDescription(String description)
Sets the description of this role.

Specified by:
setDescription in interface RoleModel
Parameters:
description - the description of this role

getType

public int getType()
Gets the type of this role.

Specified by:
getType in interface RoleModel
Returns:
the type of this role

setType

public void setType(int type)
Sets the type of this role.

Specified by:
setType in interface RoleModel
Parameters:
type - the type of this role

getSubtype

public String getSubtype()
Gets the subtype of this role.

Specified by:
getSubtype in interface RoleModel
Returns:
the subtype of this role

setSubtype

public void setSubtype(String subtype)
Sets the subtype of this role.

Specified by:
setSubtype in interface RoleModel
Parameters:
subtype - the subtype of this role

isNew

public 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>
Specified by:
isNew in interface RoleModel
Returns:
true if this model instance does not yet exist in the database; false otherwise

setNew

public 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>
Specified by:
setNew in interface RoleModel
Parameters:
n - whether this model instance does not yet exist in the database

isCachedModel

public 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>
Specified by:
isCachedModel in interface RoleModel
Returns:
true if this model instance was retrieved from the entity cache; false otherwise
See Also:
BaseModel.setCachedModel(boolean)

setCachedModel

public 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>
Specified by:
setCachedModel in interface RoleModel
Parameters:
cachedModel - whether this model instance was retrieved from the entity cache
See Also:
EntityCache

isEscapedModel

public boolean isEscapedModel()
Description copied from interface: BaseModel
Determines if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<Role>
Specified by:
isEscapedModel in interface RoleModel
Returns:
true if this model instance is escaped; false otherwise
See Also:
BaseModel.setEscapedModel(boolean)

setEscapedModel

public 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>
Specified by:
setEscapedModel in interface RoleModel
Parameters:
escapedModel - whether this model instance is escaped
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

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

Specified by:
getPrimaryKeyObj in interface BaseModel<Role>
Specified by:
getPrimaryKeyObj in interface RoleModel
Returns:
the primary key of this model instance

getExpandoBridge

public ExpandoBridge getExpandoBridge()
Description copied from interface: BaseModel
Gets the expando bridge for this model instance.

Specified by:
getExpandoBridge in interface BaseModel<Role>
Specified by:
getExpandoBridge in interface RoleModel
Returns:
the expando bridge for this model instance

setExpandoBridgeAttributes

public 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>
Specified by:
setExpandoBridgeAttributes in interface RoleModel
Parameters:
serviceContext - the service context to retrieve the expando bridge attributes from
See Also:
ServiceContext.getExpandoBridgeAttributes( )

clone

public 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 RoleModel
Overrides:
clone in class Object
Returns:
the shallow clone of this model instance

compareTo

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

hashCode

public int hashCode()
Specified by:
hashCode in interface RoleModel
Overrides:
hashCode in class Object

toEscapedModel

public Role toEscapedModel()
Description copied from interface: BaseModel
Gets a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:
toEscapedModel in interface BaseModel<Role>
Specified by:
toEscapedModel in interface RoleModel
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toString

public String toString()
Specified by:
toString in interface RoleModel
Overrides:
toString in class Object

toXmlString

public String toXmlString()
Description copied from interface: BaseModel
Gets the XML representation of this model instance.

Specified by:
toXmlString in interface BaseModel<Role>
Specified by:
toXmlString in interface RoleModel
Returns:
the XML representation of this model instance

getDescriptiveName

public String getDescriptiveName()
                          throws PortalException,
                                 SystemException
Specified by:
getDescriptiveName in interface Role
Throws:
PortalException
SystemException

getTypeLabel

public String getTypeLabel()
Specified by:
getTypeLabel in interface Role

isTeam

public boolean isTeam()
Specified by:
isTeam in interface Role

getWrappedRole

public Role getWrappedRole()

Liferay 6.0-ee