Liferay 6.0.3

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 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()
           
 long getClassNameId()
           
 long getClassPK()
           
 long getCompanyId()
           
 String getDescription()
           
 String getDescriptiveName()
           
 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()
           
 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 has been wrapped with an HTML auto escape handler.
 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)
           
 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.
 
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()
Specified by:
getPrimaryKey in interface RoleModel

setPrimaryKey

public void setPrimaryKey(long pk)
Specified by:
setPrimaryKey in interface RoleModel

getRoleId

public long getRoleId()
Specified by:
getRoleId in interface RoleModel

setRoleId

public void setRoleId(long roleId)
Specified by:
setRoleId in interface RoleModel

getCompanyId

public long getCompanyId()
Specified by:
getCompanyId in interface RoleModel

setCompanyId

public void setCompanyId(long companyId)
Specified by:
setCompanyId in interface RoleModel

getClassName

public String getClassName()
Specified by:
getClassName in interface RoleModel

getClassNameId

public long getClassNameId()
Specified by:
getClassNameId in interface RoleModel

setClassNameId

public void setClassNameId(long classNameId)
Specified by:
setClassNameId in interface RoleModel

getClassPK

public long getClassPK()
Specified by:
getClassPK in interface RoleModel

setClassPK

public void setClassPK(long classPK)
Specified by:
setClassPK in interface RoleModel

getName

public String getName()
Specified by:
getName in interface RoleModel

setName

public void setName(String name)
Specified by:
setName in interface RoleModel

getTitle

public String getTitle()
Specified by:
getTitle in interface RoleModel

getTitle

public String getTitle(Locale locale)
Specified by:
getTitle in interface RoleModel

getTitle

public String getTitle(Locale locale,
                       boolean useDefault)
Specified by:
getTitle in interface RoleModel

getTitle

public String getTitle(String languageId)
Specified by:
getTitle in interface Role
Specified by:
getTitle in interface RoleModel

getTitle

public String getTitle(String languageId,
                       boolean useDefault)
Specified by:
getTitle in interface Role
Specified by:
getTitle in interface RoleModel

getTitleMap

public Map<Locale,String> getTitleMap()
Specified by:
getTitleMap in interface RoleModel

setTitle

public void setTitle(String title)
Specified by:
setTitle in interface RoleModel

setTitle

public void setTitle(Locale locale,
                     String title)
Specified by:
setTitle in interface RoleModel

setTitleMap

public void setTitleMap(Map<Locale,String> titleMap)
Specified by:
setTitleMap in interface RoleModel

getDescription

public String getDescription()
Specified by:
getDescription in interface RoleModel

setDescription

public void setDescription(String description)
Specified by:
setDescription in interface RoleModel

getType

public int getType()
Specified by:
getType in interface RoleModel

setType

public void setType(int type)
Specified by:
setType in interface RoleModel

getSubtype

public String getSubtype()
Specified by:
getSubtype in interface RoleModel

setSubtype

public void setSubtype(String subtype)
Specified by:
setSubtype in interface RoleModel

toEscapedModel

public Role toEscapedModel()
Specified by:
toEscapedModel in interface RoleModel

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

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

setEscapedModel

public 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>
Specified by:
setEscapedModel in interface RoleModel
Parameters:
escapedModel - whether this model instance has been wrapped with an HTML auto escape handler
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

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

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

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

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 clone

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

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