com.liferay.portal.model
Interface GroupModel

All Superinterfaces:

AttachedModel, BaseModel<Group>, ClassedModel, Cloneable, Comparable<Group>, Serializable

All Known Subinterfaces:

Group

All Known Implementing Classes:

GroupBaseImpl, GroupImpl, GroupModelImpl, GroupWrapper

public interface GroupModel
extends AttachedModel, 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.

See Also:

Group, GroupImpl, GroupModelImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(Group group)
boolean	getActive() Returns the active of this group.
String	getClassName() Returns the fully qualified class name of this group.
long	getClassNameId() Returns the class name ID of this group.
long	getClassPK() Returns the class p k of this group.
long	getCompanyId() Returns the company ID of this group.
long	getCreatorUserId() Returns the creator user ID of this group.
String	getCreatorUserUuid() Returns the creator user uuid of this group.
String	getDescription() Returns the description of this group.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
String	getFriendlyURL() Returns the friendly u r l of this group.
long	getGroupId() Returns the group ID of this group.
long	getLiveGroupId() Returns the live group ID of this group.
String	getName() Returns the name of this group.
long	getParentGroupId() Returns the parent group ID of this group.
long	getPrimaryKey() Returns the primary key of this group.
Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
boolean	getSite() Returns the site of this group.
int	getType() Returns the type of this group.
String	getTypeSettings() Returns the type settings of this group.
int	hashCode()
boolean	isActive() Returns true if this group is active.
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.
boolean	isSite() Returns true if this group is site.
void	setActive(boolean active) Sets whether this group is active.
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setClassName(String className)
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	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 primaryKey) Sets the primary key of this group.
void	setPrimaryKeyObj(Serializable primaryKeyObj) Sets the primary key of this model instance.
void	setSite(boolean site) Sets whether this group is site.
void	setType(int type) Sets the type of this group.
void	setTypeSettings(String typeSettings) Sets the type settings of this group.
CacheModel<Group>	toCacheModel() Returns a cache model object for this entity used by entity cache.
Group	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
Group	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 group.

Returns:

the primary key of this group

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this group.

Parameters:

primaryKey - the primary key of this group

getGroupId

long getGroupId()

Returns 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()

Returns 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()

Returns 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

Returns 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()

Returns the fully qualified class name of this group.

Specified by:

getClassName in interface AttachedModel

Returns:

the fully qualified class name of this group

setClassName

void setClassName(String className)

getClassNameId

long getClassNameId()

Returns the class name ID of this group.

Specified by:

getClassNameId in interface AttachedModel

Returns:

the class name ID of this group

setClassNameId

void setClassNameId(long classNameId)

Sets the class name ID of this group.

Specified by:

setClassNameId in interface AttachedModel

Parameters:

classNameId - the class name ID of this group

getClassPK

long getClassPK()

Returns the class p k of this group.

Specified by:

getClassPK in interface AttachedModel

Returns:

the class p k of this group

setClassPK

void setClassPK(long classPK)

Sets the class p k of this group.

Specified by:

setClassPK in interface AttachedModel

Parameters:

classPK - the class p k of this group

getParentGroupId

long getParentGroupId()

Returns 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()

Returns 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()

Returns 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()

Returns 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()

Returns 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()

Returns 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()

Returns 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

getSite

boolean getSite()

Returns the site of this group.

Returns:

the site of this group

isSite

boolean isSite()

Returns true if this group is site.

Returns:

true if this group is site; false otherwise

setSite

void setSite(boolean site)

Sets whether this group is site.

Parameters:

site - the site of this group

getActive

boolean getActive()

Returns the active of this group.

Returns:

the active of this group

isActive

boolean isActive()

Returns true if this group is active.

Returns:

true if this group is active; false otherwise

setActive

void setActive(boolean active)

Sets whether this group is active.

Parameters:

active - the active of this 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<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

Returns true 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

Returns true if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<Group>

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<Group>

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<Group>

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<Group>

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<Group>

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

toCacheModel

CacheModel<Group> toCacheModel()

Description copied from interface: BaseModel

Returns a cache model object for this entity used by entity cache.

Specified by:

toCacheModel in interface BaseModel<Group>

Returns:

the cache model object

toEscapedModel

Group 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<Group>

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

Group toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<Group>

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<Group>

Returns:

the XML representation of this model instance