Liferay 6.1.2-ce-ga3

com.liferay.portal.model
Interface UserGroupModel

All Superinterfaces:
BaseModel<UserGroup>, ClassedModel, Cloneable, Comparable<UserGroup>, Serializable
All Known Subinterfaces:
UserGroup
All Known Implementing Classes:
UserGroupWrapper

public interface UserGroupModel
extends BaseModel<UserGroup>

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.

See Also:
UserGroup, UserGroupImpl, UserGroupModelImpl

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(UserGroup userGroup)
           
 boolean getAddedByLDAPImport()
          Returns the added by l d a p import of this user group.
 long getCompanyId()
          Returns the company ID of this user group.
 String getDescription()
          Returns the description of this user group.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 String getName()
          Returns the name of this user group.
 long getParentUserGroupId()
          Returns the parent user group ID of this user group.
 long getPrimaryKey()
          Returns the primary key of this user group.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 long getUserGroupId()
          Returns the user group ID of this user group.
 int hashCode()
           
 boolean isAddedByLDAPImport()
          Returns true if this user group is added by l d a p import.
 boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
 boolean isEscapedModel()
          Returns true if this model instance is escaped.
 boolean isNew()
          Returns true if this model instance does not yet exist in the database.
 void setAddedByLDAPImport(boolean addedByLDAPImport)
          Sets whether this user group is added by l d a p import.
 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 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 primaryKey)
          Sets the primary key of this user group.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setUserGroupId(long userGroupId)
          Sets the user group ID of this user group.
 CacheModel<UserGroup> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 UserGroup toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 UserGroup toUnescapedModel()
           
 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.ClassedModel
getModelClass, getModelClassName
 

Method Detail

getPrimaryKey

long getPrimaryKey()
Returns the primary key of this user group.

Returns:
the primary key of this user group

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this user group.

Parameters:
primaryKey - the primary key of this user group

getUserGroupId

long getUserGroupId()
Returns the user group ID of this user group.

Returns:
the user group ID of this user group

setUserGroupId

void setUserGroupId(long userGroupId)
Sets the user group ID of this user group.

Parameters:
userGroupId - the user group ID of this user group

getCompanyId

long getCompanyId()
Returns the company ID of this user group.

Returns:
the company ID of this user group

setCompanyId

void setCompanyId(long companyId)
Sets the company ID of this user group.

Parameters:
companyId - the company ID of this user group

getParentUserGroupId

long getParentUserGroupId()
Returns the parent user group ID of this user group.

Returns:
the parent user group ID of this user group

setParentUserGroupId

void setParentUserGroupId(long parentUserGroupId)
Sets the parent user group ID of this user group.

Parameters:
parentUserGroupId - the parent user group ID of this user group

getName

@AutoEscape
String getName()
Returns the name of this user group.

Returns:
the name of this user group

setName

void setName(String name)
Sets the name of this user group.

Parameters:
name - the name of this user group

getDescription

@AutoEscape
String getDescription()
Returns the description of this user group.

Returns:
the description of this user group

setDescription

void setDescription(String description)
Sets the description of this user group.

Parameters:
description - the description of this user group

getAddedByLDAPImport

boolean getAddedByLDAPImport()
Returns the added by l d a p import of this user group.

Returns:
the added by l d a p import of this user group

isAddedByLDAPImport

boolean isAddedByLDAPImport()
Returns true if this user group is added by l d a p import.

Returns:
true if this user group is added by l d a p import; false otherwise

setAddedByLDAPImport

void setAddedByLDAPImport(boolean addedByLDAPImport)
Sets whether this user group is added by l d a p import.

Parameters:
addedByLDAPImport - the added by l d a p import of this user group

isNew

boolean isNew()
Description copied from interface: BaseModel
Returns true if this model instance does not yet exist in the database.

Specified by:
isNew in interface BaseModel<UserGroup>
Returns:
true if this model instance does not yet exist in the database; false otherwise

setNew

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<UserGroup>
Parameters:
n - whether this model instance does not yet exist in the database

isCachedModel

boolean isCachedModel()
Description copied from interface: BaseModel
Returns true if this model instance was retrieved from the entity cache.

Specified by:
isCachedModel in interface BaseModel<UserGroup>
Returns:
true if this model instance was retrieved from the entity cache; false otherwise
See Also:
BaseModel.setCachedModel(boolean)

setCachedModel

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<UserGroup>
Parameters:
cachedModel - whether this model instance was retrieved from the entity cache
See Also:
EntityCache

isEscapedModel

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

Specified by:
isEscapedModel in interface BaseModel<UserGroup>
Returns:
true if this model instance is escaped; false otherwise

getPrimaryKeyObj

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

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

setPrimaryKeyObj

void setPrimaryKeyObj(Serializable primaryKeyObj)
Description copied from interface: BaseModel
Sets the primary key of this model instance.

Specified by:
setPrimaryKeyObj in interface BaseModel<UserGroup>
Specified by:
setPrimaryKeyObj in interface ClassedModel
Parameters:
primaryKeyObj - the primary key of this model instance

getExpandoBridge

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

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

setExpandoBridgeAttributes

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<UserGroup>
Parameters:
serviceContext - the service context
See Also:
ServiceContext.getExpandoBridgeAttributes( )

clone

Object clone()
Description copied from interface: BaseModel
Creates a shallow clone of this model instance.

Specified by:
clone in interface BaseModel<UserGroup>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(UserGroup userGroup)
Specified by:
compareTo in interface Comparable<UserGroup>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

CacheModel<UserGroup> toCacheModel()
Description copied from interface: BaseModel
Returns a cache model object for this entity used by entity cache.

Specified by:
toCacheModel in interface BaseModel<UserGroup>
Returns:
the cache model object

toEscapedModel

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

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

toUnescapedModel

UserGroup toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<UserGroup>

toString

String toString()
Overrides:
toString in class Object

toXmlString

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

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

Liferay 6.1.2-ce-ga3