Liferay 6.2-ce-ga5

com.liferay.portal.model
Interface ShardModel

All Superinterfaces:
AttachedModel, BaseModel<Shard>, ClassedModel, Cloneable, Comparable<Shard>, Serializable, TypedModel
All Known Subinterfaces:
Shard
All Known Implementing Classes:
ShardBaseImpl, ShardImpl, ShardModelImpl, ShardWrapper

@ProviderType
public interface ShardModel
extends AttachedModel, BaseModel<Shard>

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

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

See Also:
Shard, ShardImpl, ShardModelImpl
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(Shard shard)
           
 String getClassName()
          Returns the fully qualified class name of this shard.
 long getClassNameId()
          Returns the class name ID of this shard.
 long getClassPK()
          Returns the class p k of this shard.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 String getName()
          Returns the name of this shard.
 long getPrimaryKey()
          Returns the primary key of this shard.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 long getShardId()
          Returns the shard ID of this shard.
 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.
 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 shard.
 void setClassPK(long classPK)
          Sets the class p k of this shard.
 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 setName(String name)
          Sets the name of this shard.
 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 shard.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setShardId(long shardId)
          Sets the shard ID of this shard.
 CacheModel<Shard> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 Shard toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 Shard 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 shard.

Returns:
the primary key of this shard

setPrimaryKey

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

Parameters:
primaryKey - the primary key of this shard

getShardId

long getShardId()
Returns the shard ID of this shard.

Returns:
the shard ID of this shard

setShardId

void setShardId(long shardId)
Sets the shard ID of this shard.

Parameters:
shardId - the shard ID of this shard

getClassName

String getClassName()
Returns the fully qualified class name of this shard.

Specified by:
getClassName in interface TypedModel
Returns:
the fully qualified class name of this shard

setClassName

void setClassName(String className)

getClassNameId

long getClassNameId()
Returns the class name ID of this shard.

Specified by:
getClassNameId in interface TypedModel
Returns:
the class name ID of this shard

setClassNameId

void setClassNameId(long classNameId)
Sets the class name ID of this shard.

Specified by:
setClassNameId in interface TypedModel
Parameters:
classNameId - the class name ID of this shard

getClassPK

long getClassPK()
Returns the class p k of this shard.

Specified by:
getClassPK in interface AttachedModel
Returns:
the class p k of this shard

setClassPK

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

Specified by:
setClassPK in interface AttachedModel
Parameters:
classPK - the class p k of this shard

getName

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

Returns:
the name of this shard

setName

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

Parameters:
name - the name of this shard

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

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<Shard>

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<Shard>
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<Shard>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(Shard shard)
Specified by:
compareTo in interface Comparable<Shard>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

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

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

toEscapedModel

Shard 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<Shard>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

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

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<Shard>
Returns:
the XML representation of this model instance

Liferay 6.2-ce-ga5