Liferay 6.0.3

com.liferay.portal.model
Interface GroupModel

All Superinterfaces:
BaseModel<Group>, Cloneable, Comparable<Group>, Serializable
All Known Subinterfaces:
Group
All Known Implementing Classes:
GroupImpl, GroupModelImpl, GroupWrapper

public interface GroupModel
extends BaseModel<Group>

This interface is a model that represents the Group_ table in the database.

See Also:
Group, GroupImpl, GroupModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(Group group)
           
 boolean getActive()
           
 String getClassName()
           
 long getClassNameId()
           
 long getClassPK()
           
 long getCompanyId()
           
 long getCreatorUserId()
           
 String getCreatorUserUuid()
           
 String getDescription()
           
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 String getFriendlyURL()
           
 long getGroupId()
           
 long getLiveGroupId()
           
 String getName()
           
 long getParentGroupId()
           
 long getPrimaryKey()
           
 Serializable getPrimaryKeyObj()
          Gets the primary key for this model instance.
 int getType()
           
 String getTypeSettings()
           
 int hashCode()
           
 boolean isActive()
           
 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.
 void setActive(boolean active)
           
 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 setCreatorUserId(long creatorUserId)
           
 void setCreatorUserUuid(String creatorUserUuid)
           
 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 setFriendlyURL(String friendlyURL)
           
 void setGroupId(long groupId)
           
 void setLiveGroupId(long liveGroupId)
           
 void setName(String name)
           
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setParentGroupId(long parentGroupId)
           
 void setPrimaryKey(long pk)
           
 void setType(int type)
           
 void setTypeSettings(String typeSettings)
           
 Group toEscapedModel()
           
 String toString()
           
 String toXmlString()
          Gets the XML representation of this model instance.
 

Method Detail

getPrimaryKey

long getPrimaryKey()

setPrimaryKey

void setPrimaryKey(long pk)

getGroupId

long getGroupId()

setGroupId

void setGroupId(long groupId)

getCompanyId

long getCompanyId()

setCompanyId

void setCompanyId(long companyId)

getCreatorUserId

long getCreatorUserId()

setCreatorUserId

void setCreatorUserId(long creatorUserId)

getCreatorUserUuid

String getCreatorUserUuid()
                          throws SystemException
Throws:
SystemException

setCreatorUserUuid

void setCreatorUserUuid(String creatorUserUuid)

getClassName

String getClassName()

getClassNameId

long getClassNameId()

setClassNameId

void setClassNameId(long classNameId)

getClassPK

long getClassPK()

setClassPK

void setClassPK(long classPK)

getParentGroupId

long getParentGroupId()

setParentGroupId

void setParentGroupId(long parentGroupId)

getLiveGroupId

long getLiveGroupId()

setLiveGroupId

void setLiveGroupId(long liveGroupId)

getName

String getName()

setName

void setName(String name)

getDescription

String getDescription()

setDescription

void setDescription(String description)

getType

int getType()

setType

void setType(int type)

getTypeSettings

String getTypeSettings()

setTypeSettings

void setTypeSettings(String typeSettings)

getFriendlyURL

String getFriendlyURL()

setFriendlyURL

void setFriendlyURL(String friendlyURL)

getActive

boolean getActive()

isActive

boolean isActive()

setActive

void setActive(boolean active)

toEscapedModel

Group toEscapedModel()

isNew

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

isCachedModel

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

Specified by:
isCachedModel in interface BaseModel<Group>
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<Group>
Parameters:
cachedModel - whether this model instance was retrieved from the entity cache
See Also:
EntityCache

isEscapedModel

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<Group>
Returns:
true if this model instance has been wrapped with an HTML auto escape handler; false otherwise
See Also:
BaseModel.setEscapedModel(boolean)

setEscapedModel

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<Group>
Parameters:
escapedModel - whether this model instance has been wrapped with an HTML auto escape handler
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

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

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

getExpandoBridge

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

Specified by:
getExpandoBridge in interface BaseModel<Group>
Returns:
the expando bridge

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<Group>
Parameters:
serviceContext - the service context to retrieve the expando bridge attributes from
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<Group>
Returns:
the clone

compareTo

int compareTo(Group group)
Specified by:
compareTo in interface Comparable<Group>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toString

String toString()
Overrides:
toString in class Object

toXmlString

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

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

Liferay 6.0.3