|
Liferay 6.0.4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface ClassNameModel
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.
ClassName,
ClassNameImpl,
ClassNameModelImpl| 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 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. |
| Method Detail |
|---|
long getPrimaryKey()
void setPrimaryKey(long pk)
pk - the primary key of this class nameString getClassName()
long getClassNameId()
void setClassNameId(long classNameId)
classNameId - the class name id of this class name@AutoEscape String getValue()
void setValue(String value)
value - the value of this class nameClassName toEscapedModel()
AutoEscapeBeanHandler.
AutoEscapeBeanHandlerboolean isNew()
BaseModel
isNew in interface BaseModel<ClassName>true if this model instance does not yet exist in
the database; false otherwisevoid setNew(boolean n)
BaseModel
setNew in interface BaseModel<ClassName>n - whether this model instance does not yet exist in the databaseboolean isCachedModel()
BaseModel
isCachedModel in interface BaseModel<ClassName>true if this model instance was retrieved from the
entity cache; false otherwiseBaseModel.setCachedModel(boolean)void setCachedModel(boolean cachedModel)
BaseModel
setCachedModel in interface BaseModel<ClassName>cachedModel - whether this model instance was retrieved from the
entity cacheEntityCacheboolean isEscapedModel()
BaseModel
isEscapedModel in interface BaseModel<ClassName>true if this model instance is escaped;
false otherwiseBaseModel.setEscapedModel(boolean)void setEscapedModel(boolean escapedModel)
BaseModel
A model instance can be made escaped by wrapping it with an HTML auto
escape handler using its toEscapedModel method. For example,
UserModel.toEscapedModel().
setEscapedModel in interface BaseModel<ClassName>escapedModel - whether this model instance is escapedAutoEscapeBeanHandlerSerializable getPrimaryKeyObj()
BaseModel
getPrimaryKeyObj in interface BaseModel<ClassName>ExpandoBridge getExpandoBridge()
BaseModel
getExpandoBridge in interface BaseModel<ClassName>void setExpandoBridgeAttributes(ServiceContext serviceContext)
BaseModel
setExpandoBridgeAttributes in interface BaseModel<ClassName>serviceContext - the service context to retrieve the expando bridge
attributes fromServiceContext.getExpandoBridgeAttributes(
)Object clone()
BaseModel
clone in interface BaseModel<ClassName>int compareTo(ClassName className)
compareTo in interface Comparable<ClassName>int hashCode()
hashCode in class ObjectString toString()
toString in class ObjectString toXmlString()
BaseModel
toXmlString in interface BaseModel<ClassName>
|
Liferay 6.0.4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||