com.liferay.portal.kernel.model

Class ClassNameWrapper

Object

com.liferay.portal.kernel.model.ClassNameWrapper

All Implemented Interfaces:

BaseModel<ClassName>, ClassedModel, ClassName, ClassNameModel, ModelWrapper<ClassName>, MVCCModel, PersistedModel, TypedModel, Serializable, Cloneable, Comparable<ClassName>

@ProviderType
public class ClassNameWrapper
extends Object
implements ClassName, ModelWrapper<ClassName>

This class is a wrapper for ClassName.

Author:

Brian Wing Shun Chan

See Also:

ClassName, Serialized Form

{$generated.description}

Field Summary

Fields inherited from interface com.liferay.portal.kernel.model.ClassName

CLASS_NAME_ID_ACCESSOR

Constructor Summary

Constructors

Constructor and Description
ClassNameWrapper(ClassName className)

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates a shallow clone of this model instance.
int	compareTo(ClassName className)
boolean	equals(Object obj)
String	getClassName() Returns the fully qualified class name of this class name.
long	getClassNameId() Returns the class name ID of this class name.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
Map<String,Object>	getModelAttributes()
Class<?>	getModelClass()
String	getModelClassName()
long	getMvccVersion() Returns the mvcc version of this class name.
long	getPrimaryKey() Returns the primary key of this class name.
Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
String	getValue() Returns the value of this class name.
ClassName	getWrappedModel()
int	hashCode()
boolean	isCachedModel() Returns true if this model instance was retrieved from the entity cache.
boolean	isEntityCacheEnabled() Returns true if this model's entity cache is enabled.
boolean	isEscapedModel() Returns true if this model instance is escaped.
boolean	isFinderCacheEnabled() Returns true if this model's finder cache is enabled.
boolean	isNew() Returns true if this model instance does not yet exist in the database.
void	persist() Updates this model instance in the database or adds it if it does not yet exist.
void	resetOriginalValues() Reset all original fields to current values.
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 class name.
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	setModelAttributes(Map<String,Object> attributes)
void	setMvccVersion(long mvccVersion) Sets the mvcc version of this class name.
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 class name.
void	setPrimaryKeyObj(Serializable primaryKeyObj) Sets the primary key of this model instance.
void	setValue(String value) Sets the value of this class name.
CacheModel<ClassName>	toCacheModel() Returns a cache model object for this entity used by entity cache.
ClassName	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
ClassName	toUnescapedModel()
String	toXmlString() Returns the XML representation of this model instance.

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ClassNameWrapper

public ClassNameWrapper(ClassName className)

Method Detail

getModelClass

public Class<?> getModelClass()

Specified by:

getModelClass in interface ClassedModel

getModelClassName

public String getModelClassName()

Specified by:

getModelClassName in interface ClassedModel

getModelAttributes

public Map<String,Object> getModelAttributes()

Specified by:

getModelAttributes in interface BaseModel<ClassName>

setModelAttributes

public void setModelAttributes(Map<String,Object> attributes)

Specified by:

setModelAttributes in interface BaseModel<ClassName>

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>

getClassName

public String getClassName()

Returns the fully qualified class name of this class name.

Specified by:

getClassName in interface ClassNameModel

Specified by:

getClassName in interface TypedModel

Returns:

the fully qualified class name of this class name

getClassNameId

public long getClassNameId()

Returns the class name ID of this class name.

Specified by:

getClassNameId in interface ClassNameModel

Specified by:

getClassNameId in interface TypedModel

Returns:

the class name ID of this class name

getExpandoBridge

public ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Returns the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<ClassName>

Specified by:

getExpandoBridge in interface ClassedModel

Specified by:

getExpandoBridge in interface ClassNameModel

Returns:

the expando bridge for this model instance

getMvccVersion

public long getMvccVersion()

Returns the mvcc version of this class name.

Specified by:

getMvccVersion in interface ClassNameModel

Specified by:

getMvccVersion in interface MVCCModel

Returns:

the mvcc version of this class name

getPrimaryKey

public long getPrimaryKey()

Returns the primary key of this class name.

Specified by:

getPrimaryKey in interface ClassNameModel

Returns:

the primary key of this class name

getPrimaryKeyObj

public Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Returns the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<ClassName>

Specified by:

getPrimaryKeyObj in interface ClassedModel

Specified by:

getPrimaryKeyObj in interface ClassNameModel

Returns:

the primary key of this model instance

getValue

public String getValue()

Returns the value of this class name.

Specified by:

getValue in interface ClassNameModel

Returns:

the value of this class name

hashCode

public int hashCode()

Specified by:

hashCode in interface ClassNameModel

Overrides:

hashCode in class Object

isCachedModel

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

isEscapedModel

public boolean isEscapedModel()

Description copied from interface: BaseModel

Returns true 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

isNew

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

Specified by:

isNew in interface ClassNameModel

Returns:

true if this model instance does not yet exist in the database; false otherwise

persist

public void persist()

Description copied from interface: PersistedModel

Updates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Specified by:

persist in interface PersistedModel

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

setClassName

public void setClassName(String className)

Specified by:

setClassName in interface ClassNameModel

setClassNameId

public void setClassNameId(long classNameId)

Sets the class name ID of this class name.

Specified by:

setClassNameId in interface ClassNameModel

Specified by:

setClassNameId in interface TypedModel

Parameters:

classNameId - the class name ID of this class name

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(BaseModel<?> baseModel)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<ClassName>

Specified by:

setExpandoBridgeAttributes in interface ClassNameModel

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<ClassName>

Specified by:

setExpandoBridgeAttributes in interface ClassNameModel

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 be applied

See Also:

ServiceContext.getExpandoBridgeAttributes()

setMvccVersion

public void setMvccVersion(long mvccVersion)

Sets the mvcc version of this class name.

Specified by:

setMvccVersion in interface ClassNameModel

Specified by:

setMvccVersion in interface MVCCModel

Parameters:

mvccVersion - the mvcc version of this class name

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

setPrimaryKey

public void setPrimaryKey(long primaryKey)

Sets the primary key of this class name.

Specified by:

setPrimaryKey in interface ClassNameModel

Parameters:

primaryKey - the primary key of this class name

setPrimaryKeyObj

public void setPrimaryKeyObj(Serializable primaryKeyObj)

Description copied from interface: BaseModel

Sets the primary key of this model instance.

Specified by:

setPrimaryKeyObj in interface BaseModel<ClassName>

Specified by:

setPrimaryKeyObj in interface ClassedModel

Specified by:

setPrimaryKeyObj in interface ClassNameModel

Parameters:

primaryKeyObj - the primary key of this model instance

setValue

public void setValue(String value)

Sets the value of this class name.

Specified by:

setValue in interface ClassNameModel

Parameters:

value - the value of this class name

toCacheModel

public CacheModel<ClassName> toCacheModel()

Description copied from interface: BaseModel

Returns a cache model object for this entity used by entity cache.

Specified by:

toCacheModel in interface BaseModel<ClassName>

Specified by:

toCacheModel in interface ClassNameModel

Returns:

the cache model object

toEscapedModel

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

Specified by:

toEscapedModel in interface ClassNameModel

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toString

public String toString()

Specified by:

toString in interface ClassNameModel

Overrides:

toString in class Object

toUnescapedModel

public ClassName toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<ClassName>

Specified by:

toUnescapedModel in interface ClassNameModel

toXmlString

public String toXmlString()

Description copied from interface: BaseModel

Returns 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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getWrappedModel

public ClassName getWrappedModel()

Specified by:

getWrappedModel in interface ModelWrapper<ClassName>

isEntityCacheEnabled

public boolean isEntityCacheEnabled()

Description copied from interface: BaseModel

Returns true if this model's entity cache is enabled.

Specified by:

isEntityCacheEnabled in interface BaseModel<ClassName>

Returns:

true if this model's entity cache is enabled; false otherwise

isFinderCacheEnabled

public boolean isFinderCacheEnabled()

Description copied from interface: BaseModel

Returns true if this model's finder cache is enabled.

Specified by:

isFinderCacheEnabled in interface BaseModel<ClassName>

Returns:

true if this model's finder cache is enabled; false otherwise

resetOriginalValues

public void resetOriginalValues()

Description copied from interface: BaseModel

Reset all original fields to current values.

Specified by:

resetOriginalValues in interface BaseModel<ClassName>