Liferay 6.0.3

com.liferay.portal.model
Class ClassNameWrapper

java.lang.Object
  extended by com.liferay.portal.model.ClassNameWrapper
All Implemented Interfaces:
BaseModel<ClassName>, ClassName, ClassNameModel, Serializable, Cloneable, Comparable<ClassName>

public class ClassNameWrapper
extends Object
implements ClassName

This class is a wrapper for ClassName.

See Also:
ClassName, Serialized Form
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary
ClassNameWrapper(ClassName className)
           
 
Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(ClassName className)
           
 String getClassName()
           
 long getClassNameId()
           
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 long getPrimaryKey()
           
 Serializable getPrimaryKeyObj()
          Gets the primary key for this model instance.
 String getValue()
           
 ClassName getWrappedClassName()
           
 int hashCode()
           
 boolean isCachedModel()
          Determines if this model instance was retrieved from the entity cache.
 boolean isEscapedModel()
          Determines if this model instance has been wrapped with an HTML auto escape handler.
 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)
           
 void setEscapedModel(boolean escapedModel)
          Sets whether this model instance has been wrapped with an HTML auto escape handler.
 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)
           
 void setValue(String value)
           
 ClassName toEscapedModel()
           
 String toString()
           
 String toXmlString()
          Gets the XML representation of this model instance.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ClassNameWrapper

public ClassNameWrapper(ClassName className)
Method Detail

getPrimaryKey

public long getPrimaryKey()
Specified by:
getPrimaryKey in interface ClassNameModel

setPrimaryKey

public void setPrimaryKey(long pk)
Specified by:
setPrimaryKey in interface ClassNameModel

getClassName

public String getClassName()
Specified by:
getClassName in interface ClassNameModel

getClassNameId

public long getClassNameId()
Specified by:
getClassNameId in interface ClassNameModel

setClassNameId

public void setClassNameId(long classNameId)
Specified by:
setClassNameId in interface ClassNameModel

getValue

public String getValue()
Specified by:
getValue in interface ClassNameModel

setValue

public void setValue(String value)
Specified by:
setValue in interface ClassNameModel

toEscapedModel

public ClassName toEscapedModel()
Specified by:
toEscapedModel in interface ClassNameModel

isNew

public 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>
Specified by:
isNew in interface ClassNameModel
Returns:
true if this model instance does not yet exist in the database; false otherwise

setNew

public 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>
Specified by:
setNew in interface ClassNameModel
Parameters:
n - whether this model instance does not yet exist in the database

isCachedModel

public 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>
Specified by:
isCachedModel in interface ClassNameModel
Returns:
true if this model instance was retrieved from the entity cache; false otherwise
See Also:
BaseModel.setCachedModel(boolean)

setCachedModel

public 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>
Specified by:
setCachedModel in interface ClassNameModel
Parameters:
cachedModel - whether this model instance was retrieved from the entity cache
See Also:
EntityCache

isEscapedModel

public boolean isEscapedModel()
Description copied from interface: BaseModel
Determines if this model instance has been wrapped with an HTML auto escape handler.

Specified by:
isEscapedModel in interface BaseModel<ClassName>
Specified by:
isEscapedModel in interface ClassNameModel
Returns:
true if this model instance has been wrapped with an HTML auto escape handler; false otherwise
See Also:
BaseModel.setEscapedModel(boolean)

setEscapedModel

public void setEscapedModel(boolean escapedModel)
Description copied from interface: BaseModel
Sets whether this model instance has been wrapped with an HTML auto escape handler.

A model instance can be wrapped with an HTML auto escape handler using its toEscapedModel method. For example, UserModel.toEscapedModel().

Specified by:
setEscapedModel in interface BaseModel<ClassName>
Specified by:
setEscapedModel in interface ClassNameModel
Parameters:
escapedModel - whether this model instance has been wrapped with an HTML auto escape handler
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

public Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Gets the primary key for this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<ClassName>
Specified by:
getPrimaryKeyObj in interface ClassNameModel
Returns:
the primary key

getExpandoBridge

public ExpandoBridge getExpandoBridge()
Description copied from interface: BaseModel
Gets the expando bridge for this model instance.

Specified by:
getExpandoBridge in interface BaseModel<ClassName>
Specified by:
getExpandoBridge in interface ClassNameModel
Returns:
the expando bridge

setExpandoBridgeAttributes

public 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>
Specified by:
setExpandoBridgeAttributes in interface ClassNameModel
Parameters:
serviceContext - the service context to retrieve the expando bridge attributes from
See Also:
ServiceContext.getExpandoBridgeAttributes( )

clone

public Object clone()
Description copied from interface: BaseModel
Creates a shallow clone of this model instance.

Specified by:
clone in interface BaseModel<ClassName>
Specified by:
clone in interface ClassNameModel
Overrides:
clone in class Object
Returns:
the clone

compareTo

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

hashCode

public int hashCode()
Specified by:
hashCode in interface ClassNameModel
Overrides:
hashCode in class Object

toString

public String toString()
Specified by:
toString in interface ClassNameModel
Overrides:
toString in class Object

toXmlString

public String toXmlString()
Description copied from interface: BaseModel
Gets the XML representation of this model instance.

Specified by:
toXmlString in interface BaseModel<ClassName>
Specified by:
toXmlString in interface ClassNameModel
Returns:
the XML representation of this model instance

getWrappedClassName

public ClassName getWrappedClassName()

Liferay 6.0.3