Liferay 6.0.5

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>

The base model interface for the Group service. Represents a row in the "Group_" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation GroupModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in GroupImpl.

Never modify or reference this interface directly. All methods that expect a group model instance should use the Group interface instead.

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()
          Gets the active of this group.
 String getClassName()
          Gets the class name of the model instance this group is polymorphically associated with.
 long getClassNameId()
          Gets the class name id of this group.
 long getClassPK()
          Gets the class p k of this group.
 long getCompanyId()
          Gets the company id of this group.
 long getCreatorUserId()
          Gets the creator user id of this group.
 String getCreatorUserUuid()
          Gets the creator user uuid of this group.
 String getDescription()
          Gets the description of this group.
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 String getFriendlyURL()
          Gets the friendly u r l of this group.
 long getGroupId()
          Gets the group id of this group.
 long getLiveGroupId()
          Gets the live group id of this group.
 String getName()
          Gets the name of this group.
 long getParentGroupId()
          Gets the parent group id of this group.
 long getPrimaryKey()
          Gets the primary key of this group.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 int getType()
          Gets the type of this group.
 String getTypeSettings()
          Gets the type settings of this group.
 int hashCode()
           
 boolean isActive()
          Determines whether this group is active.
 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 setActive(boolean active)
          Sets whether this {$entity.humanName} is active.
 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 group.
 void setClassPK(long classPK)
          Sets the class p k of this group.
 void setCompanyId(long companyId)
          Sets the company id of this group.
 void setCreatorUserId(long creatorUserId)
          Sets the creator user id of this group.
 void setCreatorUserUuid(String creatorUserUuid)
          Sets the creator user uuid of this group.
 void setDescription(String description)
          Sets the description of this 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 setFriendlyURL(String friendlyURL)
          Sets the friendly u r l of this group.
 void setGroupId(long groupId)
          Sets the group id of this group.
 void setLiveGroupId(long liveGroupId)
          Sets the live group id of this group.
 void setName(String name)
          Sets the name of this group.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setParentGroupId(long parentGroupId)
          Sets the parent group id of this group.
 void setPrimaryKey(long pk)
          Sets the primary key of this group
 void setType(int type)
          Sets the type of this group.
 void setTypeSettings(String typeSettings)
          Sets the type settings of this group.
 Group toEscapedModel()
          Gets a copy of this 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

getPrimaryKey

long getPrimaryKey()
Gets the primary key of this group.

Returns:
the primary key of this group

setPrimaryKey

void setPrimaryKey(long pk)
Sets the primary key of this group

Parameters:
pk - the primary key of this group

getGroupId

long getGroupId()
Gets the group id of this group.

Returns:
the group id of this group

setGroupId

void setGroupId(long groupId)
Sets the group id of this group.

Parameters:
groupId - the group id of this group

getCompanyId

long getCompanyId()
Gets the company id of this group.

Returns:
the company id of this group

setCompanyId

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

Parameters:
companyId - the company id of this group

getCreatorUserId

long getCreatorUserId()
Gets the creator user id of this group.

Returns:
the creator user id of this group

setCreatorUserId

void setCreatorUserId(long creatorUserId)
Sets the creator user id of this group.

Parameters:
creatorUserId - the creator user id of this group

getCreatorUserUuid

String getCreatorUserUuid()
                          throws SystemException
Gets the creator user uuid of this group.

Returns:
the creator user uuid of this group
Throws:
SystemException - if a system exception occurred

setCreatorUserUuid

void setCreatorUserUuid(String creatorUserUuid)
Sets the creator user uuid of this group.

Parameters:
creatorUserUuid - the creator user uuid of this group

getClassName

String getClassName()
Gets the class name of the model instance this group is polymorphically associated with.

Returns:
the class name of the model instance this group is polymorphically associated with

getClassNameId

long getClassNameId()
Gets the class name id of this group.

Returns:
the class name id of this group

setClassNameId

void setClassNameId(long classNameId)
Sets the class name id of this group.

Parameters:
classNameId - the class name id of this group

getClassPK

long getClassPK()
Gets the class p k of this group.

Returns:
the class p k of this group

setClassPK

void setClassPK(long classPK)
Sets the class p k of this group.

Parameters:
classPK - the class p k of this group

getParentGroupId

long getParentGroupId()
Gets the parent group id of this group.

Returns:
the parent group id of this group

setParentGroupId

void setParentGroupId(long parentGroupId)
Sets the parent group id of this group.

Parameters:
parentGroupId - the parent group id of this group

getLiveGroupId

long getLiveGroupId()
Gets the live group id of this group.

Returns:
the live group id of this group

setLiveGroupId

void setLiveGroupId(long liveGroupId)
Sets the live group id of this group.

Parameters:
liveGroupId - the live group id of this group

getName

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

Returns:
the name of this group

setName

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

Parameters:
name - the name of this group

getDescription

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

Returns:
the description of this group

setDescription

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

Parameters:
description - the description of this group

getType

int getType()
Gets the type of this group.

Returns:
the type of this group

setType

void setType(int type)
Sets the type of this group.

Parameters:
type - the type of this group

getTypeSettings

@AutoEscape
String getTypeSettings()
Gets the type settings of this group.

Returns:
the type settings of this group

setTypeSettings

void setTypeSettings(String typeSettings)
Sets the type settings of this group.

Parameters:
typeSettings - the type settings of this group

getFriendlyURL

@AutoEscape
String getFriendlyURL()
Gets the friendly u r l of this group.

Returns:
the friendly u r l of this group

setFriendlyURL

void setFriendlyURL(String friendlyURL)
Sets the friendly u r l of this group.

Parameters:
friendlyURL - the friendly u r l of this group

getActive

boolean getActive()
Gets the active of this group.

Returns:
the active of this group

isActive

boolean isActive()
Determines whether this group is active.

Returns:
whether this group is active

setActive

void setActive(boolean active)
Sets whether this {$entity.humanName} is active.

Parameters:
active - the active of this group

toEscapedModel

Group toEscapedModel()
Gets a copy of this group as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

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 is escaped.

Specified by:
isEscapedModel in interface BaseModel<Group>
Returns:
true if this model instance is escaped; false otherwise
See Also:
BaseModel.setEscapedModel(boolean)

setEscapedModel

void setEscapedModel(boolean escapedModel)
Description copied from interface: BaseModel
Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.

A model instance can be made escaped by wrapping it 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 is escaped
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

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

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

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 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<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 shallow clone of this model instance

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.5