Liferay 6.0.5

com.liferay.portal.model
Class LayoutPrototypeWrapper

java.lang.Object
  extended by com.liferay.portal.model.LayoutPrototypeWrapper
All Implemented Interfaces:
BaseModel<LayoutPrototype>, LayoutPrototype, LayoutPrototypeModel, Serializable, Cloneable, Comparable<LayoutPrototype>

public class LayoutPrototypeWrapper
extends Object
implements LayoutPrototype

This class is a wrapper for LayoutPrototype.

See Also:
LayoutPrototype, Serialized Form
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary
LayoutPrototypeWrapper(LayoutPrototype layoutPrototype)
           
 
Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(LayoutPrototype layoutPrototype)
           
 boolean getActive()
          Gets the active of this layout prototype.
 long getCompanyId()
          Gets the company id of this layout prototype.
 String getDescription()
          Gets the description of this layout prototype.
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 Group getGroup()
           
 Layout getLayout()
           
 long getLayoutPrototypeId()
          Gets the layout prototype id of this layout prototype.
 String getName()
          Gets the name of this layout prototype.
 String getName(Locale locale)
          Gets the localized name of this layout prototype.
 String getName(Locale locale, boolean useDefault)
          Gets the localized name of this layout prototype, optionally using the default language if no localization exists for the requested language.
 String getName(String languageId)
          Gets the localized name of this layout prototype.
 String getName(String languageId, boolean useDefault)
          Gets the localized name of this layout prototype, optionally using the default language if no localization exists for the requested language.
 Map<Locale,String> getNameMap()
          Gets a map of the locales and localized name of this layout prototype.
 long getPrimaryKey()
          Gets the primary key of this layout prototype.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 String getSettings()
          Gets the settings of this layout prototype.
 LayoutPrototype getWrappedLayoutPrototype()
           
 int hashCode()
           
 boolean isActive()
          Determines whether this layout prototype 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 layout prototype.
 void setDescription(String description)
          Sets the description of this layout prototype.
 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 setLayoutPrototypeId(long layoutPrototypeId)
          Sets the layout prototype id of this layout prototype.
 void setName(Locale locale, String name)
          Sets the localized name of this layout prototype.
 void setName(String name)
          Sets the name of this layout prototype.
 void setNameMap(Map<Locale,String> nameMap)
          Sets the localized names of this layout prototype from the map of locales and localized names.
 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 layout prototype
 void setSettings(String settings)
          Sets the settings of this layout prototype.
 LayoutPrototype toEscapedModel()
          Gets a copy of this layout prototype 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

LayoutPrototypeWrapper

public LayoutPrototypeWrapper(LayoutPrototype layoutPrototype)
Method Detail

getPrimaryKey

public long getPrimaryKey()
Description copied from interface: LayoutPrototypeModel
Gets the primary key of this layout prototype.

Specified by:
getPrimaryKey in interface LayoutPrototypeModel
Returns:
the primary key of this layout prototype

setPrimaryKey

public void setPrimaryKey(long pk)
Description copied from interface: LayoutPrototypeModel
Sets the primary key of this layout prototype

Specified by:
setPrimaryKey in interface LayoutPrototypeModel
Parameters:
pk - the primary key of this layout prototype

getLayoutPrototypeId

public long getLayoutPrototypeId()
Description copied from interface: LayoutPrototypeModel
Gets the layout prototype id of this layout prototype.

Specified by:
getLayoutPrototypeId in interface LayoutPrototypeModel
Returns:
the layout prototype id of this layout prototype

setLayoutPrototypeId

public void setLayoutPrototypeId(long layoutPrototypeId)
Description copied from interface: LayoutPrototypeModel
Sets the layout prototype id of this layout prototype.

Specified by:
setLayoutPrototypeId in interface LayoutPrototypeModel
Parameters:
layoutPrototypeId - the layout prototype id of this layout prototype

getCompanyId

public long getCompanyId()
Description copied from interface: LayoutPrototypeModel
Gets the company id of this layout prototype.

Specified by:
getCompanyId in interface LayoutPrototypeModel
Returns:
the company id of this layout prototype

setCompanyId

public void setCompanyId(long companyId)
Description copied from interface: LayoutPrototypeModel
Sets the company id of this layout prototype.

Specified by:
setCompanyId in interface LayoutPrototypeModel
Parameters:
companyId - the company id of this layout prototype

getName

public String getName()
Description copied from interface: LayoutPrototypeModel
Gets the name of this layout prototype.

Specified by:
getName in interface LayoutPrototypeModel
Returns:
the name of this layout prototype

getName

public String getName(Locale locale)
Description copied from interface: LayoutPrototypeModel
Gets the localized name of this layout prototype. Uses the default language if no localization exists for the requested language.

Specified by:
getName in interface LayoutPrototypeModel
Parameters:
locale - the locale to get the localized name for
Returns:
the localized name of this layout prototype

getName

public String getName(Locale locale,
                      boolean useDefault)
Description copied from interface: LayoutPrototypeModel
Gets the localized name of this layout prototype, optionally using the default language if no localization exists for the requested language.

Specified by:
getName in interface LayoutPrototypeModel
Parameters:
locale - the local to get the localized name for
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized name of this layout prototype. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getName

public String getName(String languageId)
Description copied from interface: LayoutPrototypeModel
Gets the localized name of this layout prototype. Uses the default language if no localization exists for the requested language.

Specified by:
getName in interface LayoutPrototypeModel
Parameters:
languageId - the id of the language to get the localized name for
Returns:
the localized name of this layout prototype

getName

public String getName(String languageId,
                      boolean useDefault)
Description copied from interface: LayoutPrototypeModel
Gets the localized name of this layout prototype, optionally using the default language if no localization exists for the requested language.

Specified by:
getName in interface LayoutPrototypeModel
Parameters:
languageId - the id of the language to get the localized name for
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized name of this layout prototype

getNameMap

public Map<Locale,String> getNameMap()
Description copied from interface: LayoutPrototypeModel
Gets a map of the locales and localized name of this layout prototype.

Specified by:
getNameMap in interface LayoutPrototypeModel
Returns:
the locales and localized name

setName

public void setName(String name)
Description copied from interface: LayoutPrototypeModel
Sets the name of this layout prototype.

Specified by:
setName in interface LayoutPrototypeModel
Parameters:
name - the name of this layout prototype

setName

public void setName(Locale locale,
                    String name)
Description copied from interface: LayoutPrototypeModel
Sets the localized name of this layout prototype.

Specified by:
setName in interface LayoutPrototypeModel
Parameters:
locale - the locale to set the localized name for
name - the localized name of this layout prototype

setNameMap

public void setNameMap(Map<Locale,String> nameMap)
Description copied from interface: LayoutPrototypeModel
Sets the localized names of this layout prototype from the map of locales and localized names.

Specified by:
setNameMap in interface LayoutPrototypeModel
Parameters:
nameMap - the locales and localized names of this layout prototype

getDescription

public String getDescription()
Description copied from interface: LayoutPrototypeModel
Gets the description of this layout prototype.

Specified by:
getDescription in interface LayoutPrototypeModel
Returns:
the description of this layout prototype

setDescription

public void setDescription(String description)
Description copied from interface: LayoutPrototypeModel
Sets the description of this layout prototype.

Specified by:
setDescription in interface LayoutPrototypeModel
Parameters:
description - the description of this layout prototype

getSettings

public String getSettings()
Description copied from interface: LayoutPrototypeModel
Gets the settings of this layout prototype.

Specified by:
getSettings in interface LayoutPrototypeModel
Returns:
the settings of this layout prototype

setSettings

public void setSettings(String settings)
Description copied from interface: LayoutPrototypeModel
Sets the settings of this layout prototype.

Specified by:
setSettings in interface LayoutPrototypeModel
Parameters:
settings - the settings of this layout prototype

getActive

public boolean getActive()
Description copied from interface: LayoutPrototypeModel
Gets the active of this layout prototype.

Specified by:
getActive in interface LayoutPrototypeModel
Returns:
the active of this layout prototype

isActive

public boolean isActive()
Description copied from interface: LayoutPrototypeModel
Determines whether this layout prototype is active.

Specified by:
isActive in interface LayoutPrototypeModel
Returns:
whether this layout prototype is active

setActive

public void setActive(boolean active)
Description copied from interface: LayoutPrototypeModel
Sets whether this {$entity.humanName} is active.

Specified by:
setActive in interface LayoutPrototypeModel
Parameters:
active - the active of this layout prototype

toEscapedModel

public LayoutPrototype toEscapedModel()
Description copied from interface: LayoutPrototypeModel
Gets a copy of this layout prototype as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:
toEscapedModel in interface LayoutPrototypeModel
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<LayoutPrototype>
Specified by:
isNew in interface LayoutPrototypeModel
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<LayoutPrototype>
Specified by:
setNew in interface LayoutPrototypeModel
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<LayoutPrototype>
Specified by:
isCachedModel in interface LayoutPrototypeModel
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<LayoutPrototype>
Specified by:
setCachedModel in interface LayoutPrototypeModel
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<LayoutPrototype>
Specified by:
isEscapedModel in interface LayoutPrototypeModel
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<LayoutPrototype>
Specified by:
setEscapedModel in interface LayoutPrototypeModel
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<LayoutPrototype>
Specified by:
getPrimaryKeyObj in interface LayoutPrototypeModel
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<LayoutPrototype>
Specified by:
getExpandoBridge in interface LayoutPrototypeModel
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<LayoutPrototype>
Specified by:
setExpandoBridgeAttributes in interface LayoutPrototypeModel
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<LayoutPrototype>
Specified by:
clone in interface LayoutPrototypeModel
Overrides:
clone in class Object
Returns:
the shallow clone of this model instance

compareTo

public int compareTo(LayoutPrototype layoutPrototype)
Specified by:
compareTo in interface LayoutPrototypeModel
Specified by:
compareTo in interface Comparable<LayoutPrototype>

hashCode

public int hashCode()
Specified by:
hashCode in interface LayoutPrototypeModel
Overrides:
hashCode in class Object

toString

public String toString()
Specified by:
toString in interface LayoutPrototypeModel
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<LayoutPrototype>
Specified by:
toXmlString in interface LayoutPrototypeModel
Returns:
the XML representation of this model instance

getGroup

public Group getGroup()
               throws PortalException,
                      SystemException
Specified by:
getGroup in interface LayoutPrototype
Throws:
PortalException
SystemException

getLayout

public Layout getLayout()
                 throws PortalException,
                        SystemException
Specified by:
getLayout in interface LayoutPrototype
Throws:
PortalException
SystemException

getWrappedLayoutPrototype

public LayoutPrototype getWrappedLayoutPrototype()

Liferay 6.0.5