Liferay 6.2-ce-ga5

com.liferay.portal.model
Class LayoutWrapper

java.lang.Object
  extended by com.liferay.portal.model.LayoutWrapper
All Implemented Interfaces:
AuditedModel, BaseModel<Layout>, ClassedModel, GroupedModel, Layout, LayoutModel, ModelWrapper<Layout>, PersistedModel, StagedGroupedModel, StagedModel, Serializable, Cloneable, Comparable<Layout>
Direct Known Subclasses:
VirtualLayout

@ProviderType
public class LayoutWrapper
extends Object
implements Layout, ModelWrapper<Layout>

This class is a wrapper for Layout.

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

Field Summary
 
Fields inherited from interface com.liferay.portal.model.Layout
LAYOUT_ID_ACCESSOR
 
Constructor Summary
LayoutWrapper(Layout layout)
           
 
Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(Layout layout)
           
 boolean equals(Object obj)
           
 List<Layout> getAllChildren()
           
 long getAncestorLayoutId()
           
 long getAncestorPlid()
           
 List<Layout> getAncestors()
           
 String[] getAvailableLanguageIds()
           
 List<Layout> getChildren()
           
 List<Layout> getChildren(PermissionChecker permissionChecker)
           
 ColorScheme getColorScheme()
           
 String getColorSchemeId()
          Returns the color scheme ID of this layout.
 long getCompanyId()
          Returns the company ID of this layout.
 Date getCreateDate()
          Returns the create date of this layout.
 String getCss()
          Returns the css of this layout.
 String getCssText()
           
 String getDefaultLanguageId()
           
 String getDescription()
          Returns the description of this layout.
 String getDescription(Locale locale)
          Returns the localized description of this layout in the language.
 String getDescription(Locale locale, boolean useDefault)
          Returns the localized description of this layout in the language, optionally using the default language if no localization exists for the requested language.
 String getDescription(String languageId)
          Returns the localized description of this layout in the language.
 String getDescription(String languageId, boolean useDefault)
          Returns the localized description of this layout in the language, optionally using the default language if no localization exists for the requested language.
 String getDescriptionCurrentLanguageId()
           
 String getDescriptionCurrentValue()
           
 Map<Locale,String> getDescriptionMap()
          Returns a map of the locales and localized descriptions of this layout.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 String getFriendlyURL()
          Returns the friendly u r l of this layout.
 String getFriendlyURL(Locale locale)
           
 Map<Locale,String> getFriendlyURLMap()
           
 String getFriendlyURLsXML()
           
 Group getGroup()
           
 long getGroupId()
          Returns the group ID of this layout.
 boolean getHidden()
          Returns the hidden of this layout.
 String getHTMLTitle(Locale locale)
           
 String getHTMLTitle(String localeLanguageId)
           
 boolean getIconImage()
          Returns the icon image of this layout.
 long getIconImageId()
          Returns the icon image ID of this layout.
 String getKeywords()
          Returns the keywords of this layout.
 String getKeywords(Locale locale)
          Returns the localized keywords of this layout in the language.
 String getKeywords(Locale locale, boolean useDefault)
          Returns the localized keywords of this layout in the language, optionally using the default language if no localization exists for the requested language.
 String getKeywords(String languageId)
          Returns the localized keywords of this layout in the language.
 String getKeywords(String languageId, boolean useDefault)
          Returns the localized keywords of this layout in the language, optionally using the default language if no localization exists for the requested language.
 String getKeywordsCurrentLanguageId()
           
 String getKeywordsCurrentValue()
           
 Map<Locale,String> getKeywordsMap()
          Returns a map of the locales and localized keywordses of this layout.
 long getLayoutId()
          Returns the layout ID of this layout.
 boolean getLayoutPrototypeLinkEnabled()
          Returns the layout prototype link enabled of this layout.
 String getLayoutPrototypeUuid()
          Returns the layout prototype uuid of this layout.
 LayoutSet getLayoutSet()
           
 LayoutType getLayoutType()
           
 Map<String,Object> getModelAttributes()
           
 Class<?> getModelClass()
           
 String getModelClassName()
           
 Date getModifiedDate()
          Returns the modified date of this layout.
 String getName()
          Returns the name of this layout.
 String getName(Locale locale)
          Returns the localized name of this layout in the language.
 String getName(Locale locale, boolean useDefault)
          Returns the localized name of this layout in the language, optionally using the default language if no localization exists for the requested language.
 String getName(String languageId)
          Returns the localized name of this layout in the language.
 String getName(String languageId, boolean useDefault)
          Returns the localized name of this layout in the language, optionally using the default language if no localization exists for the requested language.
 String getNameCurrentLanguageId()
           
 String getNameCurrentValue()
           
 Map<Locale,String> getNameMap()
          Returns a map of the locales and localized names of this layout.
 long getParentLayoutId()
          Returns the parent layout ID of this layout.
 long getParentPlid()
           
 long getPlid()
          Returns the plid of this layout.
 long getPrimaryKey()
          Returns the primary key of this layout.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 int getPriority()
          Returns the priority of this layout.
 boolean getPrivateLayout()
          Returns the private layout of this layout.
 String getRegularURL(javax.servlet.http.HttpServletRequest request)
           
 String getResetLayoutURL(javax.servlet.http.HttpServletRequest request)
           
 String getResetMaxStateURL(javax.servlet.http.HttpServletRequest request)
           
 String getRobots()
          Returns the robots of this layout.
 String getRobots(Locale locale)
          Returns the localized robots of this layout in the language.
 String getRobots(Locale locale, boolean useDefault)
          Returns the localized robots of this layout in the language, optionally using the default language if no localization exists for the requested language.
 String getRobots(String languageId)
          Returns the localized robots of this layout in the language.
 String getRobots(String languageId, boolean useDefault)
          Returns the localized robots of this layout in the language, optionally using the default language if no localization exists for the requested language.
 String getRobotsCurrentLanguageId()
           
 String getRobotsCurrentValue()
           
 Map<Locale,String> getRobotsMap()
          Returns a map of the locales and localized robotses of this layout.
 Group getScopeGroup()
           
 String getSourcePrototypeLayoutUuid()
          Returns the source prototype layout uuid of this layout.
 StagedModelType getStagedModelType()
           
 String getTarget()
           
 Theme getTheme()
           
 String getThemeId()
          Returns the theme ID of this layout.
 String getThemeSetting(String key, String device)
           
 String getTitle()
          Returns the title of this layout.
 String getTitle(Locale locale)
          Returns the localized title of this layout in the language.
 String getTitle(Locale locale, boolean useDefault)
          Returns the localized title of this layout in the language, optionally using the default language if no localization exists for the requested language.
 String getTitle(String languageId)
          Returns the localized title of this layout in the language.
 String getTitle(String languageId, boolean useDefault)
          Returns the localized title of this layout in the language, optionally using the default language if no localization exists for the requested language.
 String getTitleCurrentLanguageId()
           
 String getTitleCurrentValue()
           
 Map<Locale,String> getTitleMap()
          Returns a map of the locales and localized titles of this layout.
 String getType()
          Returns the type of this layout.
 String getTypeSettings()
          Returns the type settings of this layout.
 UnicodeProperties getTypeSettingsProperties()
           
 String getTypeSettingsProperty(String key)
           
 String getTypeSettingsProperty(String key, String defaultValue)
           
 long getUserId()
          Returns the user ID of this layout.
 String getUserName()
          Returns the user name of this layout.
 String getUserUuid()
          Returns the user uuid of this layout.
 String getUuid()
          Returns the uuid of this layout.
 ColorScheme getWapColorScheme()
           
 String getWapColorSchemeId()
          Returns the wap color scheme ID of this layout.
 Theme getWapTheme()
           
 String getWapThemeId()
          Returns the wap theme ID of this layout.
 Layout getWrappedLayout()
          Deprecated. As of 6.1.0, replaced by getWrappedModel()
 Layout getWrappedModel()
           
 boolean hasAncestor(long layoutId)
           
 boolean hasChildren()
           
 int hashCode()
           
 boolean hasScopeGroup()
           
 boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
 boolean isChildSelected(boolean selectable, Layout layout)
           
 boolean isContentDisplayPage()
           
 boolean isEscapedModel()
          Returns true if this model instance is escaped.
 boolean isFirstChild()
           
 boolean isFirstParent()
           
 boolean isHidden()
          Returns true if this layout is hidden.
 boolean isIconImage()
          Returns true if this layout is icon image.
 boolean isInheritLookAndFeel()
           
 boolean isInheritWapLookAndFeel()
           
 boolean isLayoutPrototypeLinkActive()
           
 boolean isLayoutPrototypeLinkEnabled()
          Returns true if this layout is layout prototype link enabled.
 boolean isNew()
          Returns true if this model instance does not yet exist in the database.
 boolean isPrivateLayout()
          Returns true if this layout is private layout.
 boolean isPublicLayout()
           
 boolean isRootLayout()
           
 boolean isSelected(boolean selectable, Layout layout, long ancestorPlid)
           
 boolean isSupportsEmbeddedPortlets()
           
 boolean isTypeArticle()
           
 boolean isTypeControlPanel()
           
 boolean isTypeEmbedded()
           
 boolean isTypeLinkToLayout()
           
 boolean isTypePanel()
           
 boolean isTypePortlet()
           
 boolean isTypeURL()
           
 void persist()
          Updates this model instance in the database or adds it if it does not yet exist.
 void prepareLocalizedFieldsForImport()
           
 void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
           
 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 setColorSchemeId(String colorSchemeId)
          Sets the color scheme ID of this layout.
 void setCompanyId(long companyId)
          Sets the company ID of this layout.
 void setCreateDate(Date createDate)
          Sets the create date of this layout.
 void setCss(String css)
          Sets the css of this layout.
 void setDescription(String description)
          Sets the description of this layout.
 void setDescription(String description, Locale locale)
          Sets the localized description of this layout in the language.
 void setDescription(String description, Locale locale, Locale defaultLocale)
          Sets the localized description of this layout in the language, and sets the default locale.
 void setDescriptionCurrentLanguageId(String languageId)
           
 void setDescriptionMap(Map<Locale,String> descriptionMap)
          Sets the localized descriptions of this layout from the map of locales and localized descriptions.
 void setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale)
          Sets the localized descriptions of this layout from the map of locales and localized descriptions, and sets the default locale.
 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 setFriendlyURL(String friendlyURL)
          Sets the friendly u r l of this layout.
 void setGroupId(long groupId)
          Sets the group ID of this layout.
 void setHidden(boolean hidden)
          Sets whether this layout is hidden.
 void setIconImage(boolean iconImage)
          Sets whether this layout is icon image.
 void setIconImageId(long iconImageId)
          Sets the icon image ID of this layout.
 void setKeywords(String keywords)
          Sets the keywords of this layout.
 void setKeywords(String keywords, Locale locale)
          Sets the localized keywords of this layout in the language.
 void setKeywords(String keywords, Locale locale, Locale defaultLocale)
          Sets the localized keywords of this layout in the language, and sets the default locale.
 void setKeywordsCurrentLanguageId(String languageId)
           
 void setKeywordsMap(Map<Locale,String> keywordsMap)
          Sets the localized keywordses of this layout from the map of locales and localized keywordses.
 void setKeywordsMap(Map<Locale,String> keywordsMap, Locale defaultLocale)
          Sets the localized keywordses of this layout from the map of locales and localized keywordses, and sets the default locale.
 void setLayoutId(long layoutId)
          Sets the layout ID of this layout.
 void setLayoutPrototypeLinkEnabled(boolean layoutPrototypeLinkEnabled)
          Sets whether this layout is layout prototype link enabled.
 void setLayoutPrototypeUuid(String layoutPrototypeUuid)
          Sets the layout prototype uuid of this layout.
 void setLayoutSet(LayoutSet layoutSet)
           
 void setModelAttributes(Map<String,Object> attributes)
           
 void setModifiedDate(Date modifiedDate)
          Sets the modified date of this layout.
 void setName(String name)
          Sets the name of this layout.
 void setName(String name, Locale locale)
          Sets the localized name of this layout in the language.
 void setName(String name, Locale locale, Locale defaultLocale)
          Sets the localized name of this layout in the language, and sets the default locale.
 void setNameCurrentLanguageId(String languageId)
           
 void setNameMap(Map<Locale,String> nameMap)
          Sets the localized names of this layout from the map of locales and localized names.
 void setNameMap(Map<Locale,String> nameMap, Locale defaultLocale)
          Sets the localized names of this layout from the map of locales and localized names, and sets the default locale.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setParentLayoutId(long parentLayoutId)
          Sets the parent layout ID of this layout.
 void setPlid(long plid)
          Sets the plid of this layout.
 void setPrimaryKey(long primaryKey)
          Sets the primary key of this layout.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setPriority(int priority)
          Sets the priority of this layout.
 void setPrivateLayout(boolean privateLayout)
          Sets whether this layout is private layout.
 void setRobots(String robots)
          Sets the robots of this layout.
 void setRobots(String robots, Locale locale)
          Sets the localized robots of this layout in the language.
 void setRobots(String robots, Locale locale, Locale defaultLocale)
          Sets the localized robots of this layout in the language, and sets the default locale.
 void setRobotsCurrentLanguageId(String languageId)
           
 void setRobotsMap(Map<Locale,String> robotsMap)
          Sets the localized robotses of this layout from the map of locales and localized robotses.
 void setRobotsMap(Map<Locale,String> robotsMap, Locale defaultLocale)
          Sets the localized robotses of this layout from the map of locales and localized robotses, and sets the default locale.
 void setSourcePrototypeLayoutUuid(String sourcePrototypeLayoutUuid)
          Sets the source prototype layout uuid of this layout.
 void setThemeId(String themeId)
          Sets the theme ID of this layout.
 void setTitle(String title)
          Sets the title of this layout.
 void setTitle(String title, Locale locale)
          Sets the localized title of this layout in the language.
 void setTitle(String title, Locale locale, Locale defaultLocale)
          Sets the localized title of this layout in the language, and sets the default locale.
 void setTitleCurrentLanguageId(String languageId)
           
 void setTitleMap(Map<Locale,String> titleMap)
          Sets the localized titles of this layout from the map of locales and localized titles.
 void setTitleMap(Map<Locale,String> titleMap, Locale defaultLocale)
          Sets the localized titles of this layout from the map of locales and localized titles, and sets the default locale.
 void setType(String type)
          Sets the type of this layout.
 void setTypeSettings(String typeSettings)
          Sets the type settings of this layout.
 void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)
           
 void setUserId(long userId)
          Sets the user ID of this layout.
 void setUserName(String userName)
          Sets the user name of this layout.
 void setUserUuid(String userUuid)
          Sets the user uuid of this layout.
 void setUuid(String uuid)
          Sets the uuid of this layout.
 void setWapColorSchemeId(String wapColorSchemeId)
          Sets the wap color scheme ID of this layout.
 void setWapThemeId(String wapThemeId)
          Sets the wap theme ID of this layout.
 CacheModel<Layout> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 Layout toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 Layout 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

LayoutWrapper

public LayoutWrapper(Layout layout)
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<Layout>

setModelAttributes

public void setModelAttributes(Map<String,Object> attributes)
Specified by:
setModelAttributes in interface BaseModel<Layout>

getPrimaryKey

public long getPrimaryKey()
Returns the primary key of this layout.

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

setPrimaryKey

public void setPrimaryKey(long primaryKey)
Sets the primary key of this layout.

Specified by:
setPrimaryKey in interface LayoutModel
Parameters:
primaryKey - the primary key of this layout

getUuid

public String getUuid()
Returns the uuid of this layout.

Specified by:
getUuid in interface LayoutModel
Specified by:
getUuid in interface StagedModel
Returns:
the uuid of this layout

setUuid

public void setUuid(String uuid)
Sets the uuid of this layout.

Specified by:
setUuid in interface LayoutModel
Specified by:
setUuid in interface StagedModel
Parameters:
uuid - the uuid of this layout

getPlid

public long getPlid()
Returns the plid of this layout.

Specified by:
getPlid in interface LayoutModel
Returns:
the plid of this layout

setPlid

public void setPlid(long plid)
Sets the plid of this layout.

Specified by:
setPlid in interface LayoutModel
Parameters:
plid - the plid of this layout

getGroupId

public long getGroupId()
Returns the group ID of this layout.

Specified by:
getGroupId in interface GroupedModel
Specified by:
getGroupId in interface LayoutModel
Returns:
the group ID of this layout

setGroupId

public void setGroupId(long groupId)
Sets the group ID of this layout.

Specified by:
setGroupId in interface GroupedModel
Specified by:
setGroupId in interface LayoutModel
Parameters:
groupId - the group ID of this layout

getCompanyId

public long getCompanyId()
Returns the company ID of this layout.

Specified by:
getCompanyId in interface AuditedModel
Specified by:
getCompanyId in interface LayoutModel
Specified by:
getCompanyId in interface StagedModel
Returns:
the company ID of this layout

setCompanyId

public void setCompanyId(long companyId)
Sets the company ID of this layout.

Specified by:
setCompanyId in interface AuditedModel
Specified by:
setCompanyId in interface LayoutModel
Specified by:
setCompanyId in interface StagedModel
Parameters:
companyId - the company ID of this layout

getUserId

public long getUserId()
Returns the user ID of this layout.

Specified by:
getUserId in interface AuditedModel
Specified by:
getUserId in interface LayoutModel
Returns:
the user ID of this layout

setUserId

public void setUserId(long userId)
Sets the user ID of this layout.

Specified by:
setUserId in interface AuditedModel
Specified by:
setUserId in interface LayoutModel
Parameters:
userId - the user ID of this layout

getUserUuid

public String getUserUuid()
                   throws SystemException
Returns the user uuid of this layout.

Specified by:
getUserUuid in interface AuditedModel
Specified by:
getUserUuid in interface LayoutModel
Returns:
the user uuid of this layout
Throws:
SystemException - if a system exception occurred

setUserUuid

public void setUserUuid(String userUuid)
Sets the user uuid of this layout.

Specified by:
setUserUuid in interface AuditedModel
Specified by:
setUserUuid in interface LayoutModel
Parameters:
userUuid - the user uuid of this layout

getUserName

public String getUserName()
Returns the user name of this layout.

Specified by:
getUserName in interface AuditedModel
Specified by:
getUserName in interface LayoutModel
Returns:
the user name of this layout

setUserName

public void setUserName(String userName)
Sets the user name of this layout.

Specified by:
setUserName in interface AuditedModel
Specified by:
setUserName in interface LayoutModel
Parameters:
userName - the user name of this layout

getCreateDate

public Date getCreateDate()
Returns the create date of this layout.

Specified by:
getCreateDate in interface AuditedModel
Specified by:
getCreateDate in interface LayoutModel
Specified by:
getCreateDate in interface StagedModel
Returns:
the create date of this layout

setCreateDate

public void setCreateDate(Date createDate)
Sets the create date of this layout.

Specified by:
setCreateDate in interface AuditedModel
Specified by:
setCreateDate in interface LayoutModel
Specified by:
setCreateDate in interface StagedModel
Parameters:
createDate - the create date of this layout

getModifiedDate

public Date getModifiedDate()
Returns the modified date of this layout.

Specified by:
getModifiedDate in interface AuditedModel
Specified by:
getModifiedDate in interface LayoutModel
Specified by:
getModifiedDate in interface StagedModel
Returns:
the modified date of this layout

setModifiedDate

public void setModifiedDate(Date modifiedDate)
Sets the modified date of this layout.

Specified by:
setModifiedDate in interface AuditedModel
Specified by:
setModifiedDate in interface LayoutModel
Specified by:
setModifiedDate in interface StagedModel
Parameters:
modifiedDate - the modified date of this layout

getPrivateLayout

public boolean getPrivateLayout()
Returns the private layout of this layout.

Specified by:
getPrivateLayout in interface LayoutModel
Returns:
the private layout of this layout

isPrivateLayout

public boolean isPrivateLayout()
Returns true if this layout is private layout.

Specified by:
isPrivateLayout in interface LayoutModel
Returns:
true if this layout is private layout; false otherwise

setPrivateLayout

public void setPrivateLayout(boolean privateLayout)
Sets whether this layout is private layout.

Specified by:
setPrivateLayout in interface LayoutModel
Parameters:
privateLayout - the private layout of this layout

getLayoutId

public long getLayoutId()
Returns the layout ID of this layout.

Specified by:
getLayoutId in interface LayoutModel
Returns:
the layout ID of this layout

setLayoutId

public void setLayoutId(long layoutId)
Sets the layout ID of this layout.

Specified by:
setLayoutId in interface LayoutModel
Parameters:
layoutId - the layout ID of this layout

getParentLayoutId

public long getParentLayoutId()
Returns the parent layout ID of this layout.

Specified by:
getParentLayoutId in interface LayoutModel
Returns:
the parent layout ID of this layout

setParentLayoutId

public void setParentLayoutId(long parentLayoutId)
Sets the parent layout ID of this layout.

Specified by:
setParentLayoutId in interface LayoutModel
Parameters:
parentLayoutId - the parent layout ID of this layout

getName

public String getName()
Returns the name of this layout.

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

getName

public String getName(Locale locale)
Returns the localized name of this layout in the language. Uses the default language if no localization exists for the requested language.

Specified by:
getName in interface LayoutModel
Parameters:
locale - the locale of the language
Returns:
the localized name of this layout

getName

public String getName(Locale locale,
                      boolean useDefault)
Returns the localized name of this layout in the language, optionally using the default language if no localization exists for the requested language.

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

getName

public String getName(String languageId)
Returns the localized name of this layout in the language. Uses the default language if no localization exists for the requested language.

Specified by:
getName in interface LayoutModel
Parameters:
languageId - the ID of the language
Returns:
the localized name of this layout

getName

public String getName(String languageId,
                      boolean useDefault)
Returns the localized name of this layout in the language, optionally using the default language if no localization exists for the requested language.

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

getNameCurrentLanguageId

public String getNameCurrentLanguageId()
Specified by:
getNameCurrentLanguageId in interface LayoutModel

getNameCurrentValue

public String getNameCurrentValue()
Specified by:
getNameCurrentValue in interface LayoutModel

getNameMap

public Map<Locale,String> getNameMap()
Returns a map of the locales and localized names of this layout.

Specified by:
getNameMap in interface LayoutModel
Returns:
the locales and localized names of this layout

setName

public void setName(String name)
Sets the name of this layout.

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

setName

public void setName(String name,
                    Locale locale)
Sets the localized name of this layout in the language.

Specified by:
setName in interface LayoutModel
Parameters:
name - the localized name of this layout
locale - the locale of the language

setName

public void setName(String name,
                    Locale locale,
                    Locale defaultLocale)
Sets the localized name of this layout in the language, and sets the default locale.

Specified by:
setName in interface LayoutModel
Parameters:
name - the localized name of this layout
locale - the locale of the language
defaultLocale - the default locale

setNameCurrentLanguageId

public void setNameCurrentLanguageId(String languageId)
Specified by:
setNameCurrentLanguageId in interface LayoutModel

setNameMap

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

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

setNameMap

public void setNameMap(Map<Locale,String> nameMap,
                       Locale defaultLocale)
Sets the localized names of this layout from the map of locales and localized names, and sets the default locale.

Specified by:
setNameMap in interface LayoutModel
Parameters:
nameMap - the locales and localized names of this layout
defaultLocale - the default locale

getTitle

public String getTitle()
Returns the title of this layout.

Specified by:
getTitle in interface LayoutModel
Returns:
the title of this layout

getTitle

public String getTitle(Locale locale)
Returns the localized title of this layout in the language. Uses the default language if no localization exists for the requested language.

Specified by:
getTitle in interface LayoutModel
Parameters:
locale - the locale of the language
Returns:
the localized title of this layout

getTitle

public String getTitle(Locale locale,
                       boolean useDefault)
Returns the localized title of this layout in the language, optionally using the default language if no localization exists for the requested language.

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

getTitle

public String getTitle(String languageId)
Returns the localized title of this layout in the language. Uses the default language if no localization exists for the requested language.

Specified by:
getTitle in interface LayoutModel
Parameters:
languageId - the ID of the language
Returns:
the localized title of this layout

getTitle

public String getTitle(String languageId,
                       boolean useDefault)
Returns the localized title of this layout in the language, optionally using the default language if no localization exists for the requested language.

Specified by:
getTitle in interface LayoutModel
Parameters:
languageId - the ID of the language
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized title of this layout

getTitleCurrentLanguageId

public String getTitleCurrentLanguageId()
Specified by:
getTitleCurrentLanguageId in interface LayoutModel

getTitleCurrentValue

public String getTitleCurrentValue()
Specified by:
getTitleCurrentValue in interface LayoutModel

getTitleMap

public Map<Locale,String> getTitleMap()
Returns a map of the locales and localized titles of this layout.

Specified by:
getTitleMap in interface LayoutModel
Returns:
the locales and localized titles of this layout

setTitle

public void setTitle(String title)
Sets the title of this layout.

Specified by:
setTitle in interface LayoutModel
Parameters:
title - the title of this layout

setTitle

public void setTitle(String title,
                     Locale locale)
Sets the localized title of this layout in the language.

Specified by:
setTitle in interface LayoutModel
Parameters:
title - the localized title of this layout
locale - the locale of the language

setTitle

public void setTitle(String title,
                     Locale locale,
                     Locale defaultLocale)
Sets the localized title of this layout in the language, and sets the default locale.

Specified by:
setTitle in interface LayoutModel
Parameters:
title - the localized title of this layout
locale - the locale of the language
defaultLocale - the default locale

setTitleCurrentLanguageId

public void setTitleCurrentLanguageId(String languageId)
Specified by:
setTitleCurrentLanguageId in interface LayoutModel

setTitleMap

public void setTitleMap(Map<Locale,String> titleMap)
Sets the localized titles of this layout from the map of locales and localized titles.

Specified by:
setTitleMap in interface LayoutModel
Parameters:
titleMap - the locales and localized titles of this layout

setTitleMap

public void setTitleMap(Map<Locale,String> titleMap,
                        Locale defaultLocale)
Sets the localized titles of this layout from the map of locales and localized titles, and sets the default locale.

Specified by:
setTitleMap in interface LayoutModel
Parameters:
titleMap - the locales and localized titles of this layout
defaultLocale - the default locale

getDescription

public String getDescription()
Returns the description of this layout.

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

getDescription

public String getDescription(Locale locale)
Returns the localized description of this layout in the language. Uses the default language if no localization exists for the requested language.

Specified by:
getDescription in interface LayoutModel
Parameters:
locale - the locale of the language
Returns:
the localized description of this layout

getDescription

public String getDescription(Locale locale,
                             boolean useDefault)
Returns the localized description of this layout in the language, optionally using the default language if no localization exists for the requested language.

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

getDescription

public String getDescription(String languageId)
Returns the localized description of this layout in the language. Uses the default language if no localization exists for the requested language.

Specified by:
getDescription in interface LayoutModel
Parameters:
languageId - the ID of the language
Returns:
the localized description of this layout

getDescription

public String getDescription(String languageId,
                             boolean useDefault)
Returns the localized description of this layout in the language, optionally using the default language if no localization exists for the requested language.

Specified by:
getDescription in interface LayoutModel
Parameters:
languageId - the ID of the language
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized description of this layout

getDescriptionCurrentLanguageId

public String getDescriptionCurrentLanguageId()
Specified by:
getDescriptionCurrentLanguageId in interface LayoutModel

getDescriptionCurrentValue

public String getDescriptionCurrentValue()
Specified by:
getDescriptionCurrentValue in interface LayoutModel

getDescriptionMap

public Map<Locale,String> getDescriptionMap()
Returns a map of the locales and localized descriptions of this layout.

Specified by:
getDescriptionMap in interface LayoutModel
Returns:
the locales and localized descriptions of this layout

setDescription

public void setDescription(String description)
Sets the description of this layout.

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

setDescription

public void setDescription(String description,
                           Locale locale)
Sets the localized description of this layout in the language.

Specified by:
setDescription in interface LayoutModel
Parameters:
description - the localized description of this layout
locale - the locale of the language

setDescription

public void setDescription(String description,
                           Locale locale,
                           Locale defaultLocale)
Sets the localized description of this layout in the language, and sets the default locale.

Specified by:
setDescription in interface LayoutModel
Parameters:
description - the localized description of this layout
locale - the locale of the language
defaultLocale - the default locale

setDescriptionCurrentLanguageId

public void setDescriptionCurrentLanguageId(String languageId)
Specified by:
setDescriptionCurrentLanguageId in interface LayoutModel

setDescriptionMap

public void setDescriptionMap(Map<Locale,String> descriptionMap)
Sets the localized descriptions of this layout from the map of locales and localized descriptions.

Specified by:
setDescriptionMap in interface LayoutModel
Parameters:
descriptionMap - the locales and localized descriptions of this layout

setDescriptionMap

public void setDescriptionMap(Map<Locale,String> descriptionMap,
                              Locale defaultLocale)
Sets the localized descriptions of this layout from the map of locales and localized descriptions, and sets the default locale.

Specified by:
setDescriptionMap in interface LayoutModel
Parameters:
descriptionMap - the locales and localized descriptions of this layout
defaultLocale - the default locale

getKeywords

public String getKeywords()
Returns the keywords of this layout.

Specified by:
getKeywords in interface LayoutModel
Returns:
the keywords of this layout

getKeywords

public String getKeywords(Locale locale)
Returns the localized keywords of this layout in the language. Uses the default language if no localization exists for the requested language.

Specified by:
getKeywords in interface LayoutModel
Parameters:
locale - the locale of the language
Returns:
the localized keywords of this layout

getKeywords

public String getKeywords(Locale locale,
                          boolean useDefault)
Returns the localized keywords of this layout in the language, optionally using the default language if no localization exists for the requested language.

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

getKeywords

public String getKeywords(String languageId)
Returns the localized keywords of this layout in the language. Uses the default language if no localization exists for the requested language.

Specified by:
getKeywords in interface LayoutModel
Parameters:
languageId - the ID of the language
Returns:
the localized keywords of this layout

getKeywords

public String getKeywords(String languageId,
                          boolean useDefault)
Returns the localized keywords of this layout in the language, optionally using the default language if no localization exists for the requested language.

Specified by:
getKeywords in interface LayoutModel
Parameters:
languageId - the ID of the language
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized keywords of this layout

getKeywordsCurrentLanguageId

public String getKeywordsCurrentLanguageId()
Specified by:
getKeywordsCurrentLanguageId in interface LayoutModel

getKeywordsCurrentValue

public String getKeywordsCurrentValue()
Specified by:
getKeywordsCurrentValue in interface LayoutModel

getKeywordsMap

public Map<Locale,String> getKeywordsMap()
Returns a map of the locales and localized keywordses of this layout.

Specified by:
getKeywordsMap in interface LayoutModel
Returns:
the locales and localized keywordses of this layout

setKeywords

public void setKeywords(String keywords)
Sets the keywords of this layout.

Specified by:
setKeywords in interface LayoutModel
Parameters:
keywords - the keywords of this layout

setKeywords

public void setKeywords(String keywords,
                        Locale locale)
Sets the localized keywords of this layout in the language.

Specified by:
setKeywords in interface LayoutModel
Parameters:
keywords - the localized keywords of this layout
locale - the locale of the language

setKeywords

public void setKeywords(String keywords,
                        Locale locale,
                        Locale defaultLocale)
Sets the localized keywords of this layout in the language, and sets the default locale.

Specified by:
setKeywords in interface LayoutModel
Parameters:
keywords - the localized keywords of this layout
locale - the locale of the language
defaultLocale - the default locale

setKeywordsCurrentLanguageId

public void setKeywordsCurrentLanguageId(String languageId)
Specified by:
setKeywordsCurrentLanguageId in interface LayoutModel

setKeywordsMap

public void setKeywordsMap(Map<Locale,String> keywordsMap)
Sets the localized keywordses of this layout from the map of locales and localized keywordses.

Specified by:
setKeywordsMap in interface LayoutModel
Parameters:
keywordsMap - the locales and localized keywordses of this layout

setKeywordsMap

public void setKeywordsMap(Map<Locale,String> keywordsMap,
                           Locale defaultLocale)
Sets the localized keywordses of this layout from the map of locales and localized keywordses, and sets the default locale.

Specified by:
setKeywordsMap in interface LayoutModel
Parameters:
keywordsMap - the locales and localized keywordses of this layout
defaultLocale - the default locale

getRobots

public String getRobots()
Returns the robots of this layout.

Specified by:
getRobots in interface LayoutModel
Returns:
the robots of this layout

getRobots

public String getRobots(Locale locale)
Returns the localized robots of this layout in the language. Uses the default language if no localization exists for the requested language.

Specified by:
getRobots in interface LayoutModel
Parameters:
locale - the locale of the language
Returns:
the localized robots of this layout

getRobots

public String getRobots(Locale locale,
                        boolean useDefault)
Returns the localized robots of this layout in the language, optionally using the default language if no localization exists for the requested language.

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

getRobots

public String getRobots(String languageId)
Returns the localized robots of this layout in the language. Uses the default language if no localization exists for the requested language.

Specified by:
getRobots in interface LayoutModel
Parameters:
languageId - the ID of the language
Returns:
the localized robots of this layout

getRobots

public String getRobots(String languageId,
                        boolean useDefault)
Returns the localized robots of this layout in the language, optionally using the default language if no localization exists for the requested language.

Specified by:
getRobots in interface LayoutModel
Parameters:
languageId - the ID of the language
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized robots of this layout

getRobotsCurrentLanguageId

public String getRobotsCurrentLanguageId()
Specified by:
getRobotsCurrentLanguageId in interface LayoutModel

getRobotsCurrentValue

public String getRobotsCurrentValue()
Specified by:
getRobotsCurrentValue in interface LayoutModel

getRobotsMap

public Map<Locale,String> getRobotsMap()
Returns a map of the locales and localized robotses of this layout.

Specified by:
getRobotsMap in interface LayoutModel
Returns:
the locales and localized robotses of this layout

setRobots

public void setRobots(String robots)
Sets the robots of this layout.

Specified by:
setRobots in interface LayoutModel
Parameters:
robots - the robots of this layout

setRobots

public void setRobots(String robots,
                      Locale locale)
Sets the localized robots of this layout in the language.

Specified by:
setRobots in interface LayoutModel
Parameters:
robots - the localized robots of this layout
locale - the locale of the language

setRobots

public void setRobots(String robots,
                      Locale locale,
                      Locale defaultLocale)
Sets the localized robots of this layout in the language, and sets the default locale.

Specified by:
setRobots in interface LayoutModel
Parameters:
robots - the localized robots of this layout
locale - the locale of the language
defaultLocale - the default locale

setRobotsCurrentLanguageId

public void setRobotsCurrentLanguageId(String languageId)
Specified by:
setRobotsCurrentLanguageId in interface LayoutModel

setRobotsMap

public void setRobotsMap(Map<Locale,String> robotsMap)
Sets the localized robotses of this layout from the map of locales and localized robotses.

Specified by:
setRobotsMap in interface LayoutModel
Parameters:
robotsMap - the locales and localized robotses of this layout

setRobotsMap

public void setRobotsMap(Map<Locale,String> robotsMap,
                         Locale defaultLocale)
Sets the localized robotses of this layout from the map of locales and localized robotses, and sets the default locale.

Specified by:
setRobotsMap in interface LayoutModel
Parameters:
robotsMap - the locales and localized robotses of this layout
defaultLocale - the default locale

getType

public String getType()
Returns the type of this layout.

Specified by:
getType in interface LayoutModel
Returns:
the type of this layout

setType

public void setType(String type)
Sets the type of this layout.

Specified by:
setType in interface LayoutModel
Parameters:
type - the type of this layout

getTypeSettings

public String getTypeSettings()
Returns the type settings of this layout.

Specified by:
getTypeSettings in interface LayoutModel
Returns:
the type settings of this layout

setTypeSettings

public void setTypeSettings(String typeSettings)
Sets the type settings of this layout.

Specified by:
setTypeSettings in interface LayoutModel
Parameters:
typeSettings - the type settings of this layout

getHidden

public boolean getHidden()
Returns the hidden of this layout.

Specified by:
getHidden in interface LayoutModel
Returns:
the hidden of this layout

isHidden

public boolean isHidden()
Returns true if this layout is hidden.

Specified by:
isHidden in interface LayoutModel
Returns:
true if this layout is hidden; false otherwise

setHidden

public void setHidden(boolean hidden)
Sets whether this layout is hidden.

Specified by:
setHidden in interface LayoutModel
Parameters:
hidden - the hidden of this layout

getFriendlyURL

public String getFriendlyURL()
Returns the friendly u r l of this layout.

Specified by:
getFriendlyURL in interface LayoutModel
Returns:
the friendly u r l of this layout

setFriendlyURL

public void setFriendlyURL(String friendlyURL)
Sets the friendly u r l of this layout.

Specified by:
setFriendlyURL in interface LayoutModel
Parameters:
friendlyURL - the friendly u r l of this layout

getIconImage

public boolean getIconImage()
Returns the icon image of this layout.

Specified by:
getIconImage in interface LayoutModel
Returns:
the icon image of this layout

isIconImage

public boolean isIconImage()
Returns true if this layout is icon image.

Specified by:
isIconImage in interface LayoutModel
Returns:
true if this layout is icon image; false otherwise

setIconImage

public void setIconImage(boolean iconImage)
Sets whether this layout is icon image.

Specified by:
setIconImage in interface LayoutModel
Parameters:
iconImage - the icon image of this layout

getIconImageId

public long getIconImageId()
Returns the icon image ID of this layout.

Specified by:
getIconImageId in interface LayoutModel
Returns:
the icon image ID of this layout

setIconImageId

public void setIconImageId(long iconImageId)
Sets the icon image ID of this layout.

Specified by:
setIconImageId in interface LayoutModel
Parameters:
iconImageId - the icon image ID of this layout

getThemeId

public String getThemeId()
Returns the theme ID of this layout.

Specified by:
getThemeId in interface LayoutModel
Returns:
the theme ID of this layout

setThemeId

public void setThemeId(String themeId)
Sets the theme ID of this layout.

Specified by:
setThemeId in interface LayoutModel
Parameters:
themeId - the theme ID of this layout

getColorSchemeId

public String getColorSchemeId()
Returns the color scheme ID of this layout.

Specified by:
getColorSchemeId in interface LayoutModel
Returns:
the color scheme ID of this layout

setColorSchemeId

public void setColorSchemeId(String colorSchemeId)
Sets the color scheme ID of this layout.

Specified by:
setColorSchemeId in interface LayoutModel
Parameters:
colorSchemeId - the color scheme ID of this layout

getWapThemeId

public String getWapThemeId()
Returns the wap theme ID of this layout.

Specified by:
getWapThemeId in interface LayoutModel
Returns:
the wap theme ID of this layout

setWapThemeId

public void setWapThemeId(String wapThemeId)
Sets the wap theme ID of this layout.

Specified by:
setWapThemeId in interface LayoutModel
Parameters:
wapThemeId - the wap theme ID of this layout

getWapColorSchemeId

public String getWapColorSchemeId()
Returns the wap color scheme ID of this layout.

Specified by:
getWapColorSchemeId in interface LayoutModel
Returns:
the wap color scheme ID of this layout

setWapColorSchemeId

public void setWapColorSchemeId(String wapColorSchemeId)
Sets the wap color scheme ID of this layout.

Specified by:
setWapColorSchemeId in interface LayoutModel
Parameters:
wapColorSchemeId - the wap color scheme ID of this layout

getCss

public String getCss()
Returns the css of this layout.

Specified by:
getCss in interface LayoutModel
Returns:
the css of this layout

setCss

public void setCss(String css)
Sets the css of this layout.

Specified by:
setCss in interface LayoutModel
Parameters:
css - the css of this layout

getPriority

public int getPriority()
Returns the priority of this layout.

Specified by:
getPriority in interface LayoutModel
Returns:
the priority of this layout

setPriority

public void setPriority(int priority)
Sets the priority of this layout.

Specified by:
setPriority in interface LayoutModel
Parameters:
priority - the priority of this layout

getLayoutPrototypeUuid

public String getLayoutPrototypeUuid()
Returns the layout prototype uuid of this layout.

Specified by:
getLayoutPrototypeUuid in interface LayoutModel
Returns:
the layout prototype uuid of this layout

setLayoutPrototypeUuid

public void setLayoutPrototypeUuid(String layoutPrototypeUuid)
Sets the layout prototype uuid of this layout.

Specified by:
setLayoutPrototypeUuid in interface LayoutModel
Parameters:
layoutPrototypeUuid - the layout prototype uuid of this layout

getLayoutPrototypeLinkEnabled

public boolean getLayoutPrototypeLinkEnabled()
Returns the layout prototype link enabled of this layout.

Specified by:
getLayoutPrototypeLinkEnabled in interface LayoutModel
Returns:
the layout prototype link enabled of this layout

isLayoutPrototypeLinkEnabled

public boolean isLayoutPrototypeLinkEnabled()
Returns true if this layout is layout prototype link enabled.

Specified by:
isLayoutPrototypeLinkEnabled in interface LayoutModel
Returns:
true if this layout is layout prototype link enabled; false otherwise

setLayoutPrototypeLinkEnabled

public void setLayoutPrototypeLinkEnabled(boolean layoutPrototypeLinkEnabled)
Sets whether this layout is layout prototype link enabled.

Specified by:
setLayoutPrototypeLinkEnabled in interface LayoutModel
Parameters:
layoutPrototypeLinkEnabled - the layout prototype link enabled of this layout

getSourcePrototypeLayoutUuid

public String getSourcePrototypeLayoutUuid()
Returns the source prototype layout uuid of this layout.

Specified by:
getSourcePrototypeLayoutUuid in interface LayoutModel
Returns:
the source prototype layout uuid of this layout

setSourcePrototypeLayoutUuid

public void setSourcePrototypeLayoutUuid(String sourcePrototypeLayoutUuid)
Sets the source prototype layout uuid of this layout.

Specified by:
setSourcePrototypeLayoutUuid in interface LayoutModel
Parameters:
sourcePrototypeLayoutUuid - the source prototype layout uuid of this layout

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<Layout>
Specified by:
isNew in interface LayoutModel
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<Layout>
Specified by:
setNew in interface LayoutModel
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<Layout>
Specified by:
isCachedModel in interface LayoutModel
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<Layout>
Specified by:
setCachedModel in interface LayoutModel
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<Layout>
Specified by:
isEscapedModel in interface LayoutModel
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<Layout>
Specified by:
getPrimaryKeyObj in interface ClassedModel
Specified by:
getPrimaryKeyObj in interface LayoutModel
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<Layout>
Specified by:
setPrimaryKeyObj in interface ClassedModel
Specified by:
setPrimaryKeyObj in interface LayoutModel
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<Layout>
Specified by:
getExpandoBridge in interface ClassedModel
Specified by:
getExpandoBridge in interface LayoutModel
Returns:
the expando bridge for this model instance

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(BaseModel<?> baseModel)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<Layout>
Specified by:
setExpandoBridgeAttributes in interface LayoutModel

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<Layout>
Specified by:
setExpandoBridgeAttributes in interface LayoutModel

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<Layout>
Specified by:
setExpandoBridgeAttributes in interface LayoutModel
Parameters:
serviceContext - the service context to be applied
See Also:
ServiceContext.getExpandoBridgeAttributes( )

getAvailableLanguageIds

public String[] getAvailableLanguageIds()
Specified by:
getAvailableLanguageIds in interface LayoutModel

getDefaultLanguageId

public String getDefaultLanguageId()
Specified by:
getDefaultLanguageId in interface LayoutModel

prepareLocalizedFieldsForImport

public void prepareLocalizedFieldsForImport()
                                     throws LocaleException
Specified by:
prepareLocalizedFieldsForImport in interface LayoutModel
Throws:
LocaleException

prepareLocalizedFieldsForImport

public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
                                     throws LocaleException
Specified by:
prepareLocalizedFieldsForImport in interface LayoutModel
Throws:
LocaleException

clone

public Object clone()
Description copied from interface: BaseModel
Creates a shallow clone of this model instance.

Specified by:
clone in interface BaseModel<Layout>
Specified by:
clone in interface LayoutModel
Specified by:
clone in interface StagedModel
Overrides:
clone in class Object
Returns:
the shallow clone of this model instance

compareTo

public int compareTo(Layout layout)
Specified by:
compareTo in interface LayoutModel
Specified by:
compareTo in interface Comparable<Layout>

hashCode

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

toCacheModel

public CacheModel<Layout> toCacheModel()
Description copied from interface: BaseModel
Returns a cache model object for this entity used by entity cache.

Specified by:
toCacheModel in interface BaseModel<Layout>
Specified by:
toCacheModel in interface LayoutModel
Returns:
the cache model object

toEscapedModel

public Layout 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<Layout>
Specified by:
toEscapedModel in interface LayoutModel
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

public Layout toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<Layout>
Specified by:
toUnescapedModel in interface LayoutModel

toString

public String toString()
Specified by:
toString in interface LayoutModel
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<Layout>
Specified by:
toXmlString in interface LayoutModel
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

getAllChildren

public List<Layout> getAllChildren()
                            throws SystemException
Specified by:
getAllChildren in interface Layout
Throws:
SystemException

getAncestorLayoutId

public long getAncestorLayoutId()
                         throws PortalException,
                                SystemException
Specified by:
getAncestorLayoutId in interface Layout
Throws:
PortalException
SystemException

getAncestorPlid

public long getAncestorPlid()
                     throws PortalException,
                            SystemException
Specified by:
getAncestorPlid in interface Layout
Throws:
PortalException
SystemException

getAncestors

public List<Layout> getAncestors()
                          throws PortalException,
                                 SystemException
Specified by:
getAncestors in interface Layout
Throws:
PortalException
SystemException

getChildren

public List<Layout> getChildren()
                         throws SystemException
Specified by:
getChildren in interface Layout
Throws:
SystemException

getChildren

public List<Layout> getChildren(PermissionChecker permissionChecker)
                         throws PortalException,
                                SystemException
Specified by:
getChildren in interface Layout
Throws:
PortalException
SystemException

getColorScheme

public ColorScheme getColorScheme()
                           throws PortalException,
                                  SystemException
Specified by:
getColorScheme in interface Layout
Throws:
PortalException
SystemException

getCssText

public String getCssText()
                  throws PortalException,
                         SystemException
Specified by:
getCssText in interface Layout
Throws:
PortalException
SystemException

getFriendlyURL

public String getFriendlyURL(Locale locale)
Specified by:
getFriendlyURL in interface Layout

getFriendlyURLMap

public Map<Locale,String> getFriendlyURLMap()
                                     throws SystemException
Specified by:
getFriendlyURLMap in interface Layout
Throws:
SystemException

getFriendlyURLsXML

public String getFriendlyURLsXML()
                          throws SystemException
Specified by:
getFriendlyURLsXML in interface Layout
Throws:
SystemException

getGroup

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

getHTMLTitle

public String getHTMLTitle(Locale locale)
Specified by:
getHTMLTitle in interface Layout

getHTMLTitle

public String getHTMLTitle(String localeLanguageId)
Specified by:
getHTMLTitle in interface Layout

getLayoutSet

public LayoutSet getLayoutSet()
                       throws PortalException,
                              SystemException
Specified by:
getLayoutSet in interface Layout
Throws:
PortalException
SystemException

getLayoutType

public LayoutType getLayoutType()
Specified by:
getLayoutType in interface Layout

getParentPlid

public long getParentPlid()
                   throws PortalException,
                          SystemException
Specified by:
getParentPlid in interface Layout
Throws:
PortalException
SystemException

getRegularURL

public String getRegularURL(javax.servlet.http.HttpServletRequest request)
                     throws PortalException,
                            SystemException
Specified by:
getRegularURL in interface Layout
Throws:
PortalException
SystemException

getResetLayoutURL

public String getResetLayoutURL(javax.servlet.http.HttpServletRequest request)
                         throws PortalException,
                                SystemException
Specified by:
getResetLayoutURL in interface Layout
Throws:
PortalException
SystemException

getResetMaxStateURL

public String getResetMaxStateURL(javax.servlet.http.HttpServletRequest request)
                           throws PortalException,
                                  SystemException
Specified by:
getResetMaxStateURL in interface Layout
Throws:
PortalException
SystemException

getScopeGroup

public Group getScopeGroup()
                    throws PortalException,
                           SystemException
Specified by:
getScopeGroup in interface Layout
Throws:
PortalException
SystemException

getTarget

public String getTarget()
Specified by:
getTarget in interface Layout

getTheme

public Theme getTheme()
               throws PortalException,
                      SystemException
Specified by:
getTheme in interface Layout
Throws:
PortalException
SystemException

getThemeSetting

public String getThemeSetting(String key,
                              String device)
Specified by:
getThemeSetting in interface Layout

getTypeSettingsProperties

public UnicodeProperties getTypeSettingsProperties()
Specified by:
getTypeSettingsProperties in interface Layout

getTypeSettingsProperty

public String getTypeSettingsProperty(String key)
Specified by:
getTypeSettingsProperty in interface Layout

getTypeSettingsProperty

public String getTypeSettingsProperty(String key,
                                      String defaultValue)
Specified by:
getTypeSettingsProperty in interface Layout

getWapColorScheme

public ColorScheme getWapColorScheme()
                              throws PortalException,
                                     SystemException
Specified by:
getWapColorScheme in interface Layout
Throws:
PortalException
SystemException

getWapTheme

public Theme getWapTheme()
                  throws PortalException,
                         SystemException
Specified by:
getWapTheme in interface Layout
Throws:
PortalException
SystemException

hasAncestor

public boolean hasAncestor(long layoutId)
                    throws PortalException,
                           SystemException
Specified by:
hasAncestor in interface Layout
Throws:
PortalException
SystemException

hasChildren

public boolean hasChildren()
                    throws SystemException
Specified by:
hasChildren in interface Layout
Throws:
SystemException

hasScopeGroup

public boolean hasScopeGroup()
                      throws PortalException,
                             SystemException
Specified by:
hasScopeGroup in interface Layout
Throws:
PortalException
SystemException

isChildSelected

public boolean isChildSelected(boolean selectable,
                               Layout layout)
                        throws PortalException,
                               SystemException
Specified by:
isChildSelected in interface Layout
Throws:
PortalException
SystemException

isContentDisplayPage

public boolean isContentDisplayPage()
Specified by:
isContentDisplayPage in interface Layout

isFirstChild

public boolean isFirstChild()
Specified by:
isFirstChild in interface Layout

isFirstParent

public boolean isFirstParent()
Specified by:
isFirstParent in interface Layout

isInheritLookAndFeel

public boolean isInheritLookAndFeel()
Specified by:
isInheritLookAndFeel in interface Layout

isInheritWapLookAndFeel

public boolean isInheritWapLookAndFeel()
Specified by:
isInheritWapLookAndFeel in interface Layout

isLayoutPrototypeLinkActive

public boolean isLayoutPrototypeLinkActive()
Specified by:
isLayoutPrototypeLinkActive in interface Layout

isPublicLayout

public boolean isPublicLayout()
Specified by:
isPublicLayout in interface Layout

isRootLayout

public boolean isRootLayout()
Specified by:
isRootLayout in interface Layout

isSelected

public boolean isSelected(boolean selectable,
                          Layout layout,
                          long ancestorPlid)
Specified by:
isSelected in interface Layout

isSupportsEmbeddedPortlets

public boolean isSupportsEmbeddedPortlets()
Specified by:
isSupportsEmbeddedPortlets in interface Layout

isTypeArticle

public boolean isTypeArticle()
Specified by:
isTypeArticle in interface Layout

isTypeControlPanel

public boolean isTypeControlPanel()
Specified by:
isTypeControlPanel in interface Layout

isTypeEmbedded

public boolean isTypeEmbedded()
Specified by:
isTypeEmbedded in interface Layout

isTypeLinkToLayout

public boolean isTypeLinkToLayout()
Specified by:
isTypeLinkToLayout in interface Layout

isTypePanel

public boolean isTypePanel()
Specified by:
isTypePanel in interface Layout

isTypePortlet

public boolean isTypePortlet()
Specified by:
isTypePortlet in interface Layout

isTypeURL

public boolean isTypeURL()
Specified by:
isTypeURL in interface Layout

setLayoutSet

public void setLayoutSet(LayoutSet layoutSet)
Specified by:
setLayoutSet in interface Layout

setTypeSettingsProperties

public void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)
Specified by:
setTypeSettingsProperties in interface Layout

equals

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

getStagedModelType

public StagedModelType getStagedModelType()
Specified by:
getStagedModelType in interface StagedModel

getWrappedLayout

public Layout getWrappedLayout()
Deprecated. As of 6.1.0, replaced by getWrappedModel()


getWrappedModel

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

resetOriginalValues

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

Specified by:
resetOriginalValues in interface BaseModel<Layout>

Liferay 6.2-ce-ga5