Liferay 6.0.5

com.liferay.portal.model
Interface ShardModel

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

public interface ShardModel
extends 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.

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

See Also:
Shard, ShardImpl, ShardModelImpl
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(Shard shard)
           
 String getClassName()
          Gets the class name of the model instance this shard is polymorphically associated with.
 long getClassNameId()
          Gets the class name id of this shard.
 long getClassPK()
          Gets the class p k of this shard.
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 String getName()
          Gets the name of this shard.
 long getPrimaryKey()
          Gets the primary key of this shard.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 long getShardId()
          Gets the shard id of this shard.
 int hashCode()
           
 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 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 shard.
 void setClassPK(long classPK)
          Sets the class p k of this shard.
 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 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 pk)
          Sets the primary key of this shard
 void setShardId(long shardId)
          Sets the shard id of this shard.
 Shard toEscapedModel()
          Gets a copy of this shard 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 shard.

Returns:
the primary key of this shard

setPrimaryKey

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

Parameters:
pk - the primary key of this shard

getShardId

long getShardId()
Gets 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()
Gets the class name of the model instance this shard is polymorphically associated with.

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

getClassNameId

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

Returns:
the class name id of this shard

setClassNameId

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

Parameters:
classNameId - the class name id of this shard

getClassPK

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

Returns:
the class p k of this shard

setClassPK

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

Parameters:
classPK - the class p k of this shard

getName

@AutoEscape
String getName()
Gets 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

toEscapedModel

Shard toEscapedModel()
Gets a copy of this shard 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<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
Determines 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
Determines if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<Shard>
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<Shard>
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<Shard>
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<Shard>
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<Shard>
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<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

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

Liferay 6.0.5