Liferay 6.0-ee

com.liferay.portal.model
Interface ClassNameModel

All Superinterfaces:
BaseModel<ClassName>, Cloneable, Comparable<ClassName>, Serializable
All Known Subinterfaces:
ClassName
All Known Implementing Classes:
ClassNameImpl, ClassNameModelImpl, ClassNameWrapper

public interface ClassNameModel
extends BaseModel<ClassName>

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

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

Never modify or reference this interface directly. All methods that expect a class name model instance should use the ClassName interface instead.

See Also:
ClassName, ClassNameImpl, ClassNameModelImpl
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(ClassName className)
           
 String getClassName()
          Gets the class name of the model instance this class name is polymorphically associated with.
 long getClassNameId()
          Gets the class name id of this class name.
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 long getPrimaryKey()
          Gets the primary key of this class name.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 String getValue()
          Gets the value of this class name.
 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 class name.
 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 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 class name
 void setValue(String value)
          Sets the value of this class name.
 ClassName toEscapedModel()
          Gets a copy of this entity 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 class name.

Returns:
the primary key of this class name

setPrimaryKey

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

Parameters:
pk - the primary key of this class name

getClassName

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

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

getClassNameId

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

Returns:
the class name id of this class name

setClassNameId

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

Parameters:
classNameId - the class name id of this class name

getValue

@AutoEscape
String getValue()
Gets the value of this class name.

Returns:
the value of this class name

setValue

void setValue(String value)
Sets the value of this class name.

Parameters:
value - the value of this class name

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

compareTo

int compareTo(ClassName className)
Specified by:
compareTo in interface Comparable<ClassName>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toEscapedModel

ClassName toEscapedModel()
Description copied from interface: BaseModel
Gets a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:
toEscapedModel in interface BaseModel<ClassName>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

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

Liferay 6.0-ee