|
Liferay 6.0-ee | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.liferay.portal.model.RoleWrapper
public class RoleWrapper
This class is a wrapper for Role
.
Role
,
Serialized FormConstructor 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 |
---|
public RoleWrapper(Role role)
Method Detail |
---|
public long getPrimaryKey()
getPrimaryKey
in interface RoleModel
public void setPrimaryKey(long pk)
setPrimaryKey
in interface RoleModel
pk
- the primary key of this rolepublic long getRoleId()
getRoleId
in interface RoleModel
public void setRoleId(long roleId)
setRoleId
in interface RoleModel
roleId
- the role id of this rolepublic long getCompanyId()
getCompanyId
in interface RoleModel
public void setCompanyId(long companyId)
setCompanyId
in interface RoleModel
companyId
- the company id of this rolepublic String getClassName()
getClassName
in interface RoleModel
public long getClassNameId()
getClassNameId
in interface RoleModel
public void setClassNameId(long classNameId)
setClassNameId
in interface RoleModel
classNameId
- the class name id of this rolepublic long getClassPK()
getClassPK
in interface RoleModel
public void setClassPK(long classPK)
setClassPK
in interface RoleModel
classPK
- the class p k of this rolepublic String getName()
getName
in interface RoleModel
public void setName(String name)
setName
in interface RoleModel
name
- the name of this rolepublic String getTitle()
getTitle
in interface RoleModel
public String getTitle(Locale locale)
getTitle
in interface RoleModel
locale
- the locale to get the localized title for
public String getTitle(Locale locale, boolean useDefault)
getTitle
in interface RoleModel
locale
- the local to get the localized title foruseDefault
- whether to use the default language if no localization exists for the requested language
useDefault
is false
and no localization exists for the requested language, an empty string will be returned.public String getTitle(String languageId)
getTitle
in interface Role
getTitle
in interface RoleModel
languageId
- the id of the language to get the localized title for
public String getTitle(String languageId, boolean useDefault)
getTitle
in interface Role
getTitle
in interface RoleModel
languageId
- the id of the language to get the localized title foruseDefault
- whether to use the default language if no localization exists for the requested language
public Map<Locale,String> getTitleMap()
getTitleMap
in interface RoleModel
public void setTitle(String title)
setTitle
in interface RoleModel
title
- the title of this rolepublic void setTitle(Locale locale, String title)
setTitle
in interface RoleModel
locale
- the locale to set the localized title fortitle
- the localized title of this rolepublic void setTitleMap(Map<Locale,String> titleMap)
setTitleMap
in interface RoleModel
titleMap
- the locales and localized titles of this rolepublic String getDescription()
getDescription
in interface RoleModel
public void setDescription(String description)
setDescription
in interface RoleModel
description
- the description of this rolepublic int getType()
getType
in interface RoleModel
public void setType(int type)
setType
in interface RoleModel
type
- the type of this rolepublic String getSubtype()
getSubtype
in interface RoleModel
public void setSubtype(String subtype)
setSubtype
in interface RoleModel
subtype
- the subtype of this rolepublic boolean isNew()
BaseModel
isNew
in interface BaseModel<Role>
isNew
in interface RoleModel
true
if this model instance does not yet exist in
the database; false
otherwisepublic void setNew(boolean n)
BaseModel
setNew
in interface BaseModel<Role>
setNew
in interface RoleModel
n
- whether this model instance does not yet exist in the databasepublic boolean isCachedModel()
BaseModel
isCachedModel
in interface BaseModel<Role>
isCachedModel
in interface RoleModel
true
if this model instance was retrieved from the
entity cache; false
otherwiseBaseModel.setCachedModel(boolean)
public void setCachedModel(boolean cachedModel)
BaseModel
setCachedModel
in interface BaseModel<Role>
setCachedModel
in interface RoleModel
cachedModel
- whether this model instance was retrieved from the
entity cacheEntityCache
public boolean isEscapedModel()
BaseModel
isEscapedModel
in interface BaseModel<Role>
isEscapedModel
in interface RoleModel
true
if this model instance is escaped;
false
otherwiseBaseModel.setEscapedModel(boolean)
public void setEscapedModel(boolean escapedModel)
BaseModel
A model instance can be made escaped by wrapping it with an HTML auto
escape handler using its toEscapedModel
method. For example,
UserModel.toEscapedModel()
.
setEscapedModel
in interface BaseModel<Role>
setEscapedModel
in interface RoleModel
escapedModel
- whether this model instance is escapedAutoEscapeBeanHandler
public Serializable getPrimaryKeyObj()
BaseModel
getPrimaryKeyObj
in interface BaseModel<Role>
getPrimaryKeyObj
in interface RoleModel
public ExpandoBridge getExpandoBridge()
BaseModel
getExpandoBridge
in interface BaseModel<Role>
getExpandoBridge
in interface RoleModel
public void setExpandoBridgeAttributes(ServiceContext serviceContext)
BaseModel
setExpandoBridgeAttributes
in interface BaseModel<Role>
setExpandoBridgeAttributes
in interface RoleModel
serviceContext
- the service context to retrieve the expando bridge
attributes fromServiceContext.getExpandoBridgeAttributes(
)
public Object clone()
BaseModel
clone
in interface BaseModel<Role>
clone
in interface RoleModel
clone
in class Object
public int compareTo(Role role)
compareTo
in interface RoleModel
compareTo
in interface Comparable<Role>
public int hashCode()
hashCode
in interface RoleModel
hashCode
in class Object
public Role toEscapedModel()
BaseModel
AutoEscapeBeanHandler
.
toEscapedModel
in interface BaseModel<Role>
toEscapedModel
in interface RoleModel
AutoEscapeBeanHandler
public String toString()
toString
in interface RoleModel
toString
in class Object
public String toXmlString()
BaseModel
toXmlString
in interface BaseModel<Role>
toXmlString
in interface RoleModel
public String getDescriptiveName() throws PortalException, SystemException
getDescriptiveName
in interface Role
PortalException
SystemException
public String getTypeLabel()
getTypeLabel
in interface Role
public boolean isTeam()
isTeam
in interface Role
public Role getWrappedRole()
|
Liferay 6.0-ee | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |