com.liferay.portal.kernel.model

Interface ClusterGroupModel

All Superinterfaces:

BaseModel<ClusterGroup>, ClassedModel, Cloneable, Comparable<ClusterGroup>, MVCCModel, Serializable

All Known Subinterfaces:

ClusterGroup

All Known Implementing Classes:

ClusterGroupWrapper

@ProviderType
public interface ClusterGroupModel
extends BaseModel<ClusterGroup>, MVCCModel

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

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

Author:

Brian Wing Shun Chan

See Also:

ClusterGroup, ClusterGroupImpl, ClusterGroupModelImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates a shallow clone of this model instance.
int	compareTo(ClusterGroup clusterGroup)
long	getClusterGroupId() Returns the cluster group ID of this cluster group.
String	getClusterNodeIds() Returns the cluster node IDs of this cluster group.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
long	getMvccVersion() Returns the mvcc version of this cluster group.
String	getName() Returns the name of this cluster group.
long	getPrimaryKey() Returns the primary key of this cluster group.
Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
boolean	getWholeCluster() Returns the whole cluster of this cluster group.
int	hashCode()
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	isWholeCluster() Returns true if this cluster group is whole cluster.
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setClusterGroupId(long clusterGroupId) Sets the cluster group ID of this cluster group.
void	setClusterNodeIds(String clusterNodeIds) Sets the cluster node IDs of this cluster group.
void	setExpandoBridgeAttributes(BaseModel<?> baseModel)
void	setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
void	setExpandoBridgeAttributes(ServiceContext serviceContext) Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
void	setMvccVersion(long mvccVersion) Sets the mvcc version of this cluster group.
void	setName(String name) Sets the name of this cluster group.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setPrimaryKey(long primaryKey) Sets the primary key of this cluster group.
void	setPrimaryKeyObj(Serializable primaryKeyObj) Sets the primary key of this model instance.
void	setWholeCluster(boolean wholeCluster) Sets whether this cluster group is whole cluster.
CacheModel<ClusterGroup>	toCacheModel() Returns a cache model object for this entity used by entity cache.
ClusterGroup	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
ClusterGroup	toUnescapedModel()
String	toXmlString() Returns the XML representation of this model instance.

Methods inherited from interface com.liferay.portal.kernel.model.BaseModel

getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

getModelClass, getModelClassName

Method Detail

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this cluster group.

Returns:

the primary key of this cluster group

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this cluster group.

Parameters:

primaryKey - the primary key of this cluster group

getMvccVersion

long getMvccVersion()

Returns the mvcc version of this cluster group.

Specified by:

getMvccVersion in interface MVCCModel

Returns:

the mvcc version of this cluster group

setMvccVersion

void setMvccVersion(long mvccVersion)

Sets the mvcc version of this cluster group.

Specified by:

setMvccVersion in interface MVCCModel

Parameters:

mvccVersion - the mvcc version of this cluster group

getClusterGroupId

long getClusterGroupId()

Returns the cluster group ID of this cluster group.

Returns:

the cluster group ID of this cluster group

setClusterGroupId

void setClusterGroupId(long clusterGroupId)

Sets the cluster group ID of this cluster group.

Parameters:

clusterGroupId - the cluster group ID of this cluster group

getName

@AutoEscape
String getName()

Returns the name of this cluster group.

Returns:

the name of this cluster group

setName

void setName(String name)

Sets the name of this cluster group.

Parameters:

name - the name of this cluster group

getClusterNodeIds

@AutoEscape
String getClusterNodeIds()

Returns the cluster node IDs of this cluster group.

Returns:

the cluster node IDs of this cluster group

setClusterNodeIds

void setClusterNodeIds(String clusterNodeIds)

Sets the cluster node IDs of this cluster group.

Parameters:

clusterNodeIds - the cluster node IDs of this cluster group

getWholeCluster

boolean getWholeCluster()

Returns the whole cluster of this cluster group.

Returns:

the whole cluster of this cluster group

isWholeCluster

boolean isWholeCluster()

Returns true if this cluster group is whole cluster.

Returns:

true if this cluster group is whole cluster; false otherwise

setWholeCluster

void setWholeCluster(boolean wholeCluster)

Sets whether this cluster group is whole cluster.

Parameters:

wholeCluster - the whole cluster of this cluster 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<ClusterGroup>

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

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

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

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

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

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

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

Specified by:

getExpandoBridge in interface ClassedModel

Returns:

the expando bridge for this model instance

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(BaseModel<?> baseModel)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<ClusterGroup>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<ClusterGroup>

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

Parameters:

serviceContext - the service context to be applied

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(ClusterGroup clusterGroup)

Specified by:

compareTo in interface Comparable<ClusterGroup>

hashCode

int hashCode()

Overrides:

hashCode in class Object

toCacheModel

CacheModel<ClusterGroup> toCacheModel()

Description copied from interface: BaseModel

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

Specified by:

toCacheModel in interface BaseModel<ClusterGroup>

Returns:

the cache model object

toEscapedModel

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

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

ClusterGroup toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<ClusterGroup>

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

Returns:

the XML representation of this model instance