Liferay 6.2-ce-ga5

com.liferay.portal.model
Class ClassNameWrapper

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

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

This class is a wrapper for ClassName.

See Also:
ClassName, Serialized Form

Constructor Summary
ClassNameWrapper(ClassName className)
           
 
Method Summary
 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 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 getWrappedClassName()
          Deprecated. As of 6.1.0, replaced by getWrappedModel()
 ClassName getWrappedModel()
           
 int hashCode()
           
 boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
 boolean isEscapedModel()
          Returns true if this model instance is escaped.
 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 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 java.lang.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>

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

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

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

setClassName

public void setClassName(String className)
Specified by:
setClassName in interface ClassNameModel

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

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

getValue

public String getValue()
Returns 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)
Sets the value of this class name.

Specified by:
setValue in interface ClassNameModel
Parameters:
value - the value of this class name

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

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

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

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

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

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

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

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

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

toUnescapedModel

public ClassName toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<ClassName>
Specified by:
toUnescapedModel in interface ClassNameModel

toString

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

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

persist

public void persist()
             throws SystemException
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
Throws:
SystemException - if a system exception occurred

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

getWrappedClassName

public ClassName getWrappedClassName()
Deprecated. As of 6.1.0, replaced by getWrappedModel()


getWrappedModel

public ClassName getWrappedModel()
Specified by:
getWrappedModel in interface ModelWrapper<ClassName>

resetOriginalValues

public void resetOriginalValues()
Description copied from interface: BaseModel
Reset all original fields to current values.

Specified by:
resetOriginalValues in interface BaseModel<ClassName>

Liferay 6.2-ce-ga5