|
Liferay 6.2.0 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@ProviderType public interface RoleModel
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 com.liferay.portal.model.impl.RoleModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in com.liferay.portal.model.impl.RoleImpl.
Role,
com.liferay.portal.model.impl.RoleImpl,
com.liferay.portal.model.impl.RoleModelImpl| Method Summary | |
|---|---|
abstract Object |
clone()
Creates a shallow clone of this model instance. |
abstract int |
compareTo(Role role)
|
abstract String[] |
getAvailableLanguageIds()
|
abstract String |
getClassName()
Returns the fully qualified class name of this role. |
abstract long |
getClassNameId()
Returns the class name ID of this role. |
abstract long |
getClassPK()
Returns the class p k of this role. |
abstract long |
getCompanyId()
Returns the company ID of this role. |
abstract Date |
getCreateDate()
Returns the create date of this role. |
abstract String |
getDefaultLanguageId()
|
abstract String |
getDescription()
Returns the description of this role. |
abstract String |
getDescription(Locale locale)
Returns the localized description of this role in the language. |
abstract String |
getDescription(Locale locale,
boolean useDefault)
Returns the localized description of this role in the language, optionally using the default language if no localization exists for the requested language. |
abstract String |
getDescription(String languageId)
Returns the localized description of this role in the language. |
abstract String |
getDescription(String languageId,
boolean useDefault)
Returns the localized description of this role in the language, optionally using the default language if no localization exists for the requested language. |
abstract String |
getDescriptionCurrentLanguageId()
|
abstract String |
getDescriptionCurrentValue()
|
abstract Map<Locale,String> |
getDescriptionMap()
Returns a map of the locales and localized descriptions of this role. |
abstract ExpandoBridge |
getExpandoBridge()
Returns the expando bridge for this model instance. |
abstract Date |
getModifiedDate()
Returns the modified date of this role. |
abstract String |
getName()
Returns the name of this role. |
abstract long |
getPrimaryKey()
Returns the primary key of this role. |
abstract Serializable |
getPrimaryKeyObj()
Returns the primary key of this model instance. |
abstract long |
getRoleId()
Returns the role ID of this role. |
abstract String |
getSubtype()
Returns the subtype of this role. |
abstract String |
getTitle()
Returns the title of this role. |
abstract String |
getTitle(Locale locale)
Returns the localized title of this role in the language. |
abstract String |
getTitle(Locale locale,
boolean useDefault)
Returns the localized title of this role in the language, optionally using the default language if no localization exists for the requested language. |
abstract String |
getTitle(String languageId)
Returns the localized title of this role in the language. |
abstract String |
getTitle(String languageId,
boolean useDefault)
Returns the localized title of this role in the language, optionally using the default language if no localization exists for the requested language. |
abstract String |
getTitleCurrentLanguageId()
|
abstract String |
getTitleCurrentValue()
|
abstract Map<Locale,String> |
getTitleMap()
Returns a map of the locales and localized titles of this role. |
abstract int |
getType()
Returns the type of this role. |
abstract long |
getUserId()
Returns the user ID of this role. |
abstract String |
getUserName()
Returns the user name of this role. |
abstract String |
getUserUuid()
Returns the user uuid of this role. |
abstract String |
getUuid()
Returns the uuid of this role. |
abstract int |
hashCode()
|
abstract boolean |
isCachedModel()
Returns true if this model instance was retrieved from the
entity cache. |
abstract boolean |
isEscapedModel()
Returns true if this model instance is escaped. |
abstract boolean |
isNew()
Returns true if this model instance does not yet exist in
the database. |
abstract void |
prepareLocalizedFieldsForImport()
|
abstract void |
prepareLocalizedFieldsForImport(Locale defaultImportLocale)
|
abstract void |
setCachedModel(boolean cachedModel)
Sets whether this model instance was retrieved from the entity cache. |
abstract void |
setClassName(String className)
|
abstract void |
setClassNameId(long classNameId)
Sets the class name ID of this role. |
abstract void |
setClassPK(long classPK)
Sets the class p k of this role. |
abstract void |
setCompanyId(long companyId)
Sets the company ID of this role. |
abstract void |
setCreateDate(Date createDate)
Sets the create date of this role. |
abstract void |
setDescription(String description)
Sets the description of this role. |
abstract void |
setDescription(String description,
Locale locale)
Sets the localized description of this role in the language. |
abstract void |
setDescription(String description,
Locale locale,
Locale defaultLocale)
Sets the localized description of this role in the language, and sets the default locale. |
abstract void |
setDescriptionCurrentLanguageId(String languageId)
|
abstract void |
setDescriptionMap(Map<Locale,String> descriptionMap)
Sets the localized descriptions of this role from the map of locales and localized descriptions. |
abstract void |
setDescriptionMap(Map<Locale,String> descriptionMap,
Locale defaultLocale)
Sets the localized descriptions of this role from the map of locales and localized descriptions, and sets the default locale. |
abstract void |
setExpandoBridgeAttributes(BaseModel<?> baseModel)
|
abstract void |
setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
|
abstract void |
setExpandoBridgeAttributes(ServiceContext serviceContext)
Sets the expando bridge attributes for this model instance to the attributes stored in the service context. |
abstract void |
setModifiedDate(Date modifiedDate)
Sets the modified date of this role. |
abstract void |
setName(String name)
Sets the name of this role. |
abstract void |
setNew(boolean n)
Sets whether this model instance does not yet exist in the database. |
abstract void |
setPrimaryKey(long primaryKey)
Sets the primary key of this role. |
abstract void |
setPrimaryKeyObj(Serializable primaryKeyObj)
Sets the primary key of this model instance. |
abstract void |
setRoleId(long roleId)
Sets the role ID of this role. |
abstract void |
setSubtype(String subtype)
Sets the subtype of this role. |
abstract void |
setTitle(String title)
Sets the title of this role. |
abstract void |
setTitle(String title,
Locale locale)
Sets the localized title of this role in the language. |
abstract void |
setTitle(String title,
Locale locale,
Locale defaultLocale)
Sets the localized title of this role in the language, and sets the default locale. |
abstract void |
setTitleCurrentLanguageId(String languageId)
|
abstract void |
setTitleMap(Map<Locale,String> titleMap)
Sets the localized titles of this role from the map of locales and localized titles. |
abstract void |
setTitleMap(Map<Locale,String> titleMap,
Locale defaultLocale)
Sets the localized titles of this role from the map of locales and localized titles, and sets the default locale. |
abstract void |
setType(int type)
Sets the type of this role. |
abstract void |
setUserId(long userId)
Sets the user ID of this role. |
abstract void |
setUserName(String userName)
Sets the user name of this role. |
abstract void |
setUserUuid(String userUuid)
Sets the user uuid of this role. |
abstract void |
setUuid(String uuid)
Sets the uuid of this role. |
abstract CacheModel<Role> |
toCacheModel()
Returns a cache model object for this entity used by entity cache. |
abstract Role |
toEscapedModel()
Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler. |
abstract String |
toString()
|
abstract Role |
toUnescapedModel()
|
abstract String |
toXmlString()
Returns the XML representation of this model instance. |
| Methods inherited from interface com.liferay.portal.model.BaseModel |
|---|
getModelAttributes, resetOriginalValues, setModelAttributes |
| Methods inherited from interface com.liferay.portal.model.StagedModel |
|---|
getStagedModelType |
| Methods inherited from interface com.liferay.portal.model.ClassedModel |
|---|
getModelClass, getModelClassName |
| Method Detail |
|---|
long getPrimaryKey()
void setPrimaryKey(long primaryKey)
primaryKey - the primary key of this role@AutoEscape String getUuid()
getUuid in interface StagedModelvoid setUuid(String uuid)
setUuid in interface StagedModeluuid - the uuid of this rolelong getRoleId()
void setRoleId(long roleId)
roleId - the role ID of this rolelong getCompanyId()
getCompanyId in interface AuditedModelgetCompanyId in interface StagedModelvoid setCompanyId(long companyId)
setCompanyId in interface AuditedModelsetCompanyId in interface StagedModelcompanyId - the company ID of this rolelong getUserId()
getUserId in interface AuditedModelvoid setUserId(long userId)
setUserId in interface AuditedModeluserId - the user ID of this role
String getUserUuid()
throws SystemException
getUserUuid in interface AuditedModelSystemException - if a system exception occurredvoid setUserUuid(String userUuid)
setUserUuid in interface AuditedModeluserUuid - the user uuid of this role@AutoEscape String getUserName()
getUserName in interface AuditedModelvoid setUserName(String userName)
setUserName in interface AuditedModeluserName - the user name of this roleDate getCreateDate()
getCreateDate in interface AuditedModelgetCreateDate in interface StagedModelvoid setCreateDate(Date createDate)
setCreateDate in interface AuditedModelsetCreateDate in interface StagedModelcreateDate - the create date of this roleDate getModifiedDate()
getModifiedDate in interface AuditedModelgetModifiedDate in interface StagedModelvoid setModifiedDate(Date modifiedDate)
setModifiedDate in interface AuditedModelsetModifiedDate in interface StagedModelmodifiedDate - the modified date of this roleString getClassName()
getClassName in interface TypedModelvoid setClassName(String className)
long getClassNameId()
getClassNameId in interface TypedModelvoid setClassNameId(long classNameId)
setClassNameId in interface TypedModelclassNameId - the class name ID of this rolelong getClassPK()
getClassPK in interface AttachedModelvoid setClassPK(long classPK)
setClassPK in interface AttachedModelclassPK - the class p k of this role@AutoEscape String getName()
void setName(String name)
name - the name of this roleString getTitle()
@AutoEscape String getTitle(Locale locale)
locale - the locale of the language
@AutoEscape
String getTitle(Locale locale,
boolean useDefault)
locale - the local of the languageuseDefault - 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.@AutoEscape String getTitle(String languageId)
languageId - the ID of the language
@AutoEscape
String getTitle(String languageId,
boolean useDefault)
languageId - the ID of the languageuseDefault - whether to use the default language if no localization exists for the requested language
@AutoEscape String getTitleCurrentLanguageId()
@AutoEscape String getTitleCurrentValue()
Map<Locale,String> getTitleMap()
void setTitle(String title)
title - the title of this role
void setTitle(String title,
Locale locale)
title - the localized title of this rolelocale - the locale of the language
void setTitle(String title,
Locale locale,
Locale defaultLocale)
title - the localized title of this rolelocale - the locale of the languagedefaultLocale - the default localevoid setTitleCurrentLanguageId(String languageId)
void setTitleMap(Map<Locale,String> titleMap)
titleMap - the locales and localized titles of this role
void setTitleMap(Map<Locale,String> titleMap,
Locale defaultLocale)
titleMap - the locales and localized titles of this roledefaultLocale - the default localeString getDescription()
@AutoEscape String getDescription(Locale locale)
locale - the locale of the language
@AutoEscape
String getDescription(Locale locale,
boolean useDefault)
locale - the local of the languageuseDefault - 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.@AutoEscape String getDescription(String languageId)
languageId - the ID of the language
@AutoEscape
String getDescription(String languageId,
boolean useDefault)
languageId - the ID of the languageuseDefault - whether to use the default language if no localization exists for the requested language
@AutoEscape String getDescriptionCurrentLanguageId()
@AutoEscape String getDescriptionCurrentValue()
Map<Locale,String> getDescriptionMap()
void setDescription(String description)
description - the description of this role
void setDescription(String description,
Locale locale)
description - the localized description of this rolelocale - the locale of the language
void setDescription(String description,
Locale locale,
Locale defaultLocale)
description - the localized description of this rolelocale - the locale of the languagedefaultLocale - the default localevoid setDescriptionCurrentLanguageId(String languageId)
void setDescriptionMap(Map<Locale,String> descriptionMap)
descriptionMap - the locales and localized descriptions of this role
void setDescriptionMap(Map<Locale,String> descriptionMap,
Locale defaultLocale)
descriptionMap - the locales and localized descriptions of this roledefaultLocale - the default localeint getType()
void setType(int type)
type - the type of this role@AutoEscape String getSubtype()
void setSubtype(String subtype)
subtype - the subtype of this roleboolean isNew()
BaseModeltrue if this model instance does not yet exist in
the database.
isNew in interface BaseModel<Role>true if this model instance does not yet exist in
the database; false otherwisevoid setNew(boolean n)
BaseModel
setNew in interface BaseModel<Role>n - whether this model instance does not yet exist in the databaseboolean isCachedModel()
BaseModeltrue if this model instance was retrieved from the
entity cache.
isCachedModel in interface BaseModel<Role>true if this model instance was retrieved from the
entity cache; false otherwiseBaseModel.setCachedModel(boolean)void setCachedModel(boolean cachedModel)
BaseModel
setCachedModel in interface BaseModel<Role>cachedModel - whether this model instance was retrieved from the
entity cacheEntityCacheboolean isEscapedModel()
BaseModeltrue if this model instance is escaped.
isEscapedModel in interface BaseModel<Role>true if this model instance is escaped;
false otherwiseSerializable getPrimaryKeyObj()
BaseModel
getPrimaryKeyObj in interface BaseModel<Role>getPrimaryKeyObj in interface ClassedModelvoid setPrimaryKeyObj(Serializable primaryKeyObj)
BaseModel
setPrimaryKeyObj in interface BaseModel<Role>setPrimaryKeyObj in interface ClassedModelprimaryKeyObj - the primary key of this model instanceExpandoBridge getExpandoBridge()
BaseModel
getExpandoBridge in interface BaseModel<Role>getExpandoBridge in interface ClassedModelvoid setExpandoBridgeAttributes(BaseModel<?> baseModel)
setExpandoBridgeAttributes in interface BaseModel<Role>void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
setExpandoBridgeAttributes in interface BaseModel<Role>void setExpandoBridgeAttributes(ServiceContext serviceContext)
BaseModel
setExpandoBridgeAttributes in interface BaseModel<Role>serviceContext - the service context to be appliedServiceContext.getExpandoBridgeAttributes(
)String[] getAvailableLanguageIds()
String getDefaultLanguageId()
void prepareLocalizedFieldsForImport()
throws LocaleException
LocaleException
void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
throws LocaleException
LocaleExceptionObject clone()
BaseModel
clone in interface BaseModel<Role>clone in interface StagedModelint compareTo(Role role)
compareTo in interface Comparable<Role>int hashCode()
hashCode in class ObjectCacheModel<Role> toCacheModel()
BaseModel
toCacheModel in interface BaseModel<Role>Role toEscapedModel()
BaseModelAutoEscapeBeanHandler.
toEscapedModel in interface BaseModel<Role>AutoEscapeBeanHandlerRole toUnescapedModel()
toUnescapedModel in interface BaseModel<Role>String toString()
toString in class ObjectString toXmlString()
BaseModel
toXmlString in interface BaseModel<Role>
|
Liferay 6.2.0 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||