|
Liferay 6.0.4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface PortletModel
The base model interface for the Portlet service. Represents a row in the "Portlet" database table, with each column mapped to a property of this class.
This interface and its corresponding implementation PortletModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in PortletImpl.
Never modify or reference this interface directly. All methods that expect a portlet model instance should use the Portlet interface instead.
Portlet,
PortletImpl,
PortletModelImpl| Method Summary | |
|---|---|
Object |
clone()
Creates a shallow clone of this model instance. |
int |
compareTo(Portlet portlet)
|
boolean |
getActive()
Gets the active of this portlet. |
long |
getCompanyId()
Gets the company id of this portlet. |
ExpandoBridge |
getExpandoBridge()
Gets the expando bridge for this model instance. |
long |
getId()
Gets the id of this portlet. |
String |
getPortletId()
Gets the portlet id of this portlet. |
long |
getPrimaryKey()
Gets the primary key of this portlet. |
Serializable |
getPrimaryKeyObj()
Gets the primary key of this model instance. |
String |
getRoles()
Gets the roles of this portlet. |
int |
hashCode()
|
boolean |
isActive()
Determines whether this portlet is active. |
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 |
setActive(boolean active)
Sets whether this {$entity.humanName} is active. |
void |
setCachedModel(boolean cachedModel)
Sets whether this model instance was retrieved from the entity cache. |
void |
setCompanyId(long companyId)
Sets the company id of this portlet. |
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 |
setId(long id)
Sets the id of this portlet. |
void |
setNew(boolean n)
Sets whether this model instance does not yet exist in the database. |
void |
setPortletId(String portletId)
Sets the portlet id of this portlet. |
void |
setPrimaryKey(long pk)
Sets the primary key of this portlet |
void |
setRoles(String roles)
Sets the roles of this portlet. |
Portlet |
toEscapedModel()
Gets a copy of this portlet 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 portletlong getId()
void setId(long id)
id - the id of this portletlong getCompanyId()
void setCompanyId(long companyId)
companyId - the company id of this portlet@AutoEscape String getPortletId()
void setPortletId(String portletId)
portletId - the portlet id of this portlet@AutoEscape String getRoles()
void setRoles(String roles)
roles - the roles of this portletboolean getActive()
boolean isActive()
void setActive(boolean active)
active - the active of this portletPortlet toEscapedModel()
AutoEscapeBeanHandler.
AutoEscapeBeanHandlerboolean isNew()
BaseModel
isNew in interface BaseModel<Portlet>true if this model instance does not yet exist in
the database; false otherwisevoid setNew(boolean n)
BaseModel
setNew in interface BaseModel<Portlet>n - whether this model instance does not yet exist in the databaseboolean isCachedModel()
BaseModel
isCachedModel in interface BaseModel<Portlet>true if this model instance was retrieved from the
entity cache; false otherwiseBaseModel.setCachedModel(boolean)void setCachedModel(boolean cachedModel)
BaseModel
setCachedModel in interface BaseModel<Portlet>cachedModel - whether this model instance was retrieved from the
entity cacheEntityCacheboolean isEscapedModel()
BaseModel
isEscapedModel in interface BaseModel<Portlet>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<Portlet>escapedModel - whether this model instance is escapedAutoEscapeBeanHandlerSerializable getPrimaryKeyObj()
BaseModel
getPrimaryKeyObj in interface BaseModel<Portlet>ExpandoBridge getExpandoBridge()
BaseModel
getExpandoBridge in interface BaseModel<Portlet>void setExpandoBridgeAttributes(ServiceContext serviceContext)
BaseModel
setExpandoBridgeAttributes in interface BaseModel<Portlet>serviceContext - the service context to retrieve the expando bridge
attributes fromServiceContext.getExpandoBridgeAttributes(
)Object clone()
BaseModel
clone in interface BaseModel<Portlet>int compareTo(Portlet portlet)
compareTo in interface Comparable<Portlet>int hashCode()
hashCode in class ObjectString toString()
toString in class ObjectString toXmlString()
BaseModel
toXmlString in interface BaseModel<Portlet>
|
Liferay 6.0.4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||