|
Liferay 6.0.4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface UserGroupModel
The base model interface for the UserGroup service. Represents a row in the "UserGroup" database table, with each column mapped to a property of this class.
This interface and its corresponding implementation UserGroupModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in UserGroupImpl.
Never modify or reference this interface directly. All methods that expect a user group model instance should use the UserGroup interface instead.
UserGroup,
UserGroupImpl,
UserGroupModelImpl| Method Summary | |
|---|---|
Object |
clone()
Creates a shallow clone of this model instance. |
int |
compareTo(UserGroup userGroup)
|
long |
getCompanyId()
Gets the company id of this user group. |
String |
getDescription()
Gets the description of this user group. |
ExpandoBridge |
getExpandoBridge()
Gets the expando bridge for this model instance. |
String |
getName()
Gets the name of this user group. |
long |
getParentUserGroupId()
Gets the parent user group id of this user group. |
long |
getPrimaryKey()
Gets the primary key of this user group. |
Serializable |
getPrimaryKeyObj()
Gets the primary key of this model instance. |
long |
getUserGroupId()
Gets the user group id of this user group. |
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. |
void |
setCachedModel(boolean cachedModel)
Sets whether this model instance was retrieved from the entity cache. |
void |
setCompanyId(long companyId)
Sets the company id of this user group. |
void |
setDescription(String description)
Sets the description of this user group. |
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 user group. |
void |
setNew(boolean n)
Sets whether this model instance does not yet exist in the database. |
void |
setParentUserGroupId(long parentUserGroupId)
Sets the parent user group id of this user group. |
void |
setPrimaryKey(long pk)
Sets the primary key of this user group |
void |
setUserGroupId(long userGroupId)
Sets the user group id of this user group. |
UserGroup |
toEscapedModel()
Gets a copy of this user group as an escaped model instance by wrapping it with an AutoEscapeBeanHandler. |
String |
toString()
|
String |
toXmlString()
Gets the XML representation of this model instance. |
| Method Detail |
|---|
long getPrimaryKey()
void setPrimaryKey(long pk)
pk - the primary key of this user grouplong getUserGroupId()
void setUserGroupId(long userGroupId)
userGroupId - the user group id of this user grouplong getCompanyId()
void setCompanyId(long companyId)
companyId - the company id of this user grouplong getParentUserGroupId()
void setParentUserGroupId(long parentUserGroupId)
parentUserGroupId - the parent user group id of this user group@AutoEscape String getName()
void setName(String name)
name - the name of this user group@AutoEscape String getDescription()
void setDescription(String description)
description - the description of this user groupUserGroup toEscapedModel()
AutoEscapeBeanHandler.
AutoEscapeBeanHandlerboolean isNew()
BaseModel
isNew in interface BaseModel<UserGroup>true if this model instance does not yet exist in
the database; false otherwisevoid setNew(boolean n)
BaseModel
setNew in interface BaseModel<UserGroup>n - whether this model instance does not yet exist in the databaseboolean isCachedModel()
BaseModel
isCachedModel in interface BaseModel<UserGroup>true if this model instance was retrieved from the
entity cache; false otherwiseBaseModel.setCachedModel(boolean)void setCachedModel(boolean cachedModel)
BaseModel
setCachedModel in interface BaseModel<UserGroup>cachedModel - whether this model instance was retrieved from the
entity cacheEntityCacheboolean isEscapedModel()
BaseModel
isEscapedModel in interface BaseModel<UserGroup>true if this model instance is escaped;
false otherwiseBaseModel.setEscapedModel(boolean)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<UserGroup>escapedModel - whether this model instance is escapedAutoEscapeBeanHandlerSerializable getPrimaryKeyObj()
BaseModel
getPrimaryKeyObj in interface BaseModel<UserGroup>ExpandoBridge getExpandoBridge()
BaseModel
getExpandoBridge in interface BaseModel<UserGroup>void setExpandoBridgeAttributes(ServiceContext serviceContext)
BaseModel
setExpandoBridgeAttributes in interface BaseModel<UserGroup>serviceContext - the service context to retrieve the expando bridge
attributes fromServiceContext.getExpandoBridgeAttributes(
)Object clone()
BaseModel
clone in interface BaseModel<UserGroup>int compareTo(UserGroup userGroup)
compareTo in interface Comparable<UserGroup>int hashCode()
hashCode in class ObjectString toString()
toString in class ObjectString toXmlString()
BaseModel
toXmlString in interface BaseModel<UserGroup>
|
Liferay 6.0.4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||