com.liferay.portal.model
Class ClassNameWrapper

java.lang.Object
  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() 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.
ClassName	getWrappedClassName()
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 class name as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
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()

Description copied from interface: ClassNameModel

Gets the primary key of this class name.

Specified by:

getPrimaryKey in interface ClassNameModel

Returns:

the primary key of this class name

setPrimaryKey

public void setPrimaryKey(long pk)

Description copied from interface: ClassNameModel

Sets the primary key of this class name

Specified by:

setPrimaryKey in interface ClassNameModel

Parameters:

pk - the primary key of this class name

getClassName

public String getClassName()

Description copied from interface: ClassNameModel

Gets the class name of the model instance this class name is polymorphically associated with.

Specified by:

getClassName in interface ClassNameModel

Returns:

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

getClassNameId

public long getClassNameId()

Description copied from interface: ClassNameModel

Gets the class name id of this class name.

Specified by:

getClassNameId in interface ClassNameModel

Returns:

the class name id of this class name

setClassNameId

public void setClassNameId(long classNameId)

Description copied from interface: ClassNameModel

Sets the class name id of this class name.

Specified by:

setClassNameId in interface ClassNameModel

Parameters:

classNameId - the class name id of this class name

getValue

public String getValue()

Description copied from interface: ClassNameModel

Gets the value of this class name.

Specified by:

getValue in interface ClassNameModel

Returns:

the value of this class name

setValue

public void setValue(String value)

Description copied from interface: ClassNameModel

Sets the value of this class name.

Specified by:

setValue in interface ClassNameModel

Parameters:

value - the value of this class name

toEscapedModel

public ClassName toEscapedModel()

Description copied from interface: ClassNameModel

Gets a copy of this class name as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:

toEscapedModel in interface ClassNameModel

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

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 is escaped.

Specified by:

isEscapedModel in interface BaseModel<ClassName>

Specified by:

isEscapedModel in interface ClassNameModel

Returns:

true if this model instance is escaped; false otherwise

See Also:

BaseModel.setEscapedModel(boolean)

setEscapedModel

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

Specified by:

setEscapedModel in interface ClassNameModel

Parameters:

escapedModel - whether this model instance is escaped

See Also:

AutoEscapeBeanHandler

getPrimaryKeyObj

public Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Gets the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<ClassName>

Specified by:

getPrimaryKeyObj in interface ClassNameModel

Returns:

the primary key of this model instance

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 for this model instance

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 shallow clone of this model instance

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()