PageConfig

java.lang.Object
- lumis.portal.structure.StructureElement
- - lumis.portal.page.PageConfig

All Implemented Interfaces:

Cloneable, ICacheEntry, ICloneableCacheEntry, ICloneableConfig<PageConfig>

Direct Known Subclasses:

PageDataType.Data
```
@StableMinor(version="12.5",
             sinceVersion="5.0")
public class PageConfig
extends StructureElement
implements ICloneableCacheEntry, ICloneableConfig<PageConfig>
```
Represents a Page object

Since:

4.0.6

Version:

$Revision: 24140 $ $Date: 2020-09-14 21:50:42 +0000 (Mon, 14 Sep 2020) $

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`IS_PAGE_BLOCK_PROPERTY_NAME` Property name for identifying as page block.
`static String`	`LAYOUT_FILE_PATH_PROPERTY_NAME` Property name for layout file property.
`static int`	`PAGE_CACHE_TYPE_ALL_USERS` Deprecated. since 10.3.0 replaced by `PAGE_CACHE_TYPE_ENABLED`.
`static int`	`PAGE_CACHE_TYPE_DISABLED`
`static int`	`PAGE_CACHE_TYPE_ENABLED`
`static int`	`PAGE_CACHE_TYPE_INHERIT`
`static int`	`PAGE_CACHE_TYPE_ONLY_GUEST` Deprecated. since 10.3.0 replaced by `PAGE_CACHE_TYPE_ENABLED`.
`static int`	`PAGE_CENTER_INHERIT`
`static int`	`PAGE_CENTER_NO`
`static int`	`PAGE_CENTER_YES`
`static String`	`PAGE_ID_ADMIN_ACCESS`
`static String`	`PAGE_ID_ADMIN_BLANK`
`static String`	`PAGE_ID_ADMIN_CHANNEL_HOME`
`static String`	`PAGE_ID_ADMIN_CHANNEL_TEMPLATES`
`static String`	`PAGE_ID_ADMIN_GROUPS`
`static String`	`PAGE_ID_ADMIN_LOCALGROUPS`
`static String`	`PAGE_ID_ADMIN_LOCALUSERS`
`static String`	`PAGE_ID_ADMIN_PAGE_TEMPLATES`
`static String`	`PAGE_ID_ADMIN_PAGES`
`static String`	`PAGE_ID_ADMIN_SERVICES`
`static String`	`PAGE_ID_ADMIN_SUBCHANNELS`
`static String`	`PAGE_ID_ADMIN_USERS`
`static int`	`PAGE_LAYOUT_TYPE_INHERIT` Page layout type for inherit type.
`static int`	`PAGE_LAYOUT_TYPE_LAYOUT_FILE` Page layout type for layout using layout file.
`static int`	`PAGE_LAYOUT_TYPE_TABLELESS` Page layout type for layout not using tables.
`static int`	`PAGE_LAYOUT_TYPE_WITH_TABLES` Page layout type for layout using tables.
`static String`	`PAGE_MAIN`
`static int`	`PAGE_PROTOCOL_ALL`
`static int`	`PAGE_PROTOCOL_HTTP`
`static String`	`PAGE_PROTOCOL_HTTP_NAME`
`static int`	`PAGE_PROTOCOL_HTTPS`
`static String`	`PAGE_PROTOCOL_HTTPS_NAME`
`static int`	`PAGE_PROTOCOL_INHERIT`
`static int`	`PAGE_RUNTIME_DATA_PROVIDER_TYPE_CONTENT` Deprecated. Since 5.0.0 replaced by `#PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CONTENT()`.
`static int`	`PAGE_RUNTIME_DATA_PROVIDER_TYPE_CUSTOM` Deprecated. Since 5.0.0 replaced by `#PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CUSTOM()`.
`static int`	`PAGE_RUNTIME_DATA_PROVIDER_TYPE_DEFAULT` Deprecated. Since 5.0.0 replaced by `#PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_DEFAULT()`.
`static int`	`PAGE_RUNTIME_DATA_PROVIDER_TYPE_INHERIT` Deprecated. Since 5.0.0 replaced by `#PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_INHERIT()`.
`static int`	`PAGE_SERVER_SIDE_INCLUDE_NO` Constant that indicates to not process server side include directives.
`static int`	`PAGE_SERVER_SIDE_INCLUDE_YES` Constant that indicates to process server side include directives.
`static int`	`PAGE_TYPE_ADMIN`
`static int`	`PAGE_TYPE_USER`
`static int`	`PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CONTENT`
`static int`	`PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CUSTOM`
`static int`	`PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_DEFAULT`
`static int`	`PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_INHERIT`

Constructor Summary

Constructors
Constructor and Description

PageConfig()

Constructors
Constructor and Description
`PageConfig()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`applyPropertyBagChanges()` Apply the changes made to the properties managed by this element to the property bag persistence entities.
`PageConfig`	`clone()`
`void`	`deserialize(Node pageNode)`
`protected void`	`deserializePropertyBag(Node propertyBagNode)` Updates this element's property bag according to the given serialized property bag node.
`String`	`getAccessControlListId()`
`int`	`getCacheType()`
`int`	`getCenterPage()`
`String`	`getChannelId()`
`String`	`getDescription()`
`String`	`getFriendlyId()` Returns the page's friendly identifier.
`String`	`getId()`
`boolean`	`getInheritsMetaTags()`
`boolean`	`getInheritsStylesheets()`
`String`	`getKeywords()`
`String`	`getLayout()`
`String`	`getLayoutFilePath()` Returns the path for the layout file for use by this page.
`int`	`getLayoutType()`
`protected Pattern`	`getManagedPropertiesPattern()` Returns the property name spaces.
`String`	`getName()`
`String`	`getPageWebResourceDataProviderClassName()` Returns the class name for the page web resource data provider.
`int`	`getPageWebResourceDataProviderType()` Returns the page web resource data provider type.
`String`	`getParentTemplateId()`
`int`	`getPosition()`
`String`	`getPropertyBagId()` Returns the property bag identifier.
`int`	`getProtocol()`
`String`	`getRuntimeDataProviderClassName()` Deprecated. Since 5.0.0 replaced by `getPageWebResourceDataProviderClassName()`.
`int`	`getRuntimeDataProviderType()` Deprecated. Since 5.0.0 replaced by `getPageWebResourceDataProviderType()`.
`int`	`getServerSideIncludeType()` Returns whether the server side include directives are processed for this page.
`String`	`getTitle()`
`int`	`getType()`
`boolean`	`isAutomaticFriendlyId()` Returns whether the page is going to use automatic generated friendly identifier or not.
`boolean`	`isHidden()`
`boolean`	`isIdentical(PageConfig pageConfig)` Returns true if all properties of this object are equals to the properties of the given object.
`boolean`	`isOverrideServerSideInclude()` Indicates whether the server side include type should be calculated automatically by the framework.
`boolean`	`isPageBlock()` Determines if the current page is a page block.
`boolean`	`isTemplate()`
`protected void`	`loadPropertyBagValues()` Loads the values of the property bag of this element.
`protected boolean`	`mayUseFriendlyId(String friendlyId)` Indicates if the element may use the given friendly identifier.
`void`	`serialize(PageConfig pageConfig, OutputStream outputStream)`
`void`	`setAccessControlListId(String accessControlListId)`
`void`	`setAutoGeneratedFriendlyId()` Generates a new friendly identifier and sets it as the friendly identifier of this page.
`void`	`setAutomaticFriendlyId(boolean automaticFriendlyId)` Indicates whether the page is going to use automatic generated friendly identifier or not.
`void`	`setCacheType(int cacheType)`
`void`	`setCenterPage(int centerPage)`
`void`	`setChannelId(String channelId)`
`void`	`setDescription(String description)`
`void`	`setFriendlyId(String friendlyId)` Sets the page's friendly identifier.
`void`	`setHidden(boolean hidden)`
`void`	`setId(String id)`
`void`	`setInheritsMetaTags(boolean inheritsMetaTags)`
`void`	`setInheritsStylesheets(boolean inheritsStylesheets)`
`void`	`setKeywords(String keywords)`
`void`	`setLayout(String layout)`
`void`	`setLayoutFile(String layoutFile)` Sets the path for the layout file.
`void`	`setLayoutType(int layoutType)` Sets the layout type.
`void`	`setName(String name)`
`void`	`setOverrideServerSideInclude(boolean overrideServerSideInclude)` Sets whether the server side include type should be calculated automatically by the framework.
`void`	`setPageBlock(boolean isPageBlock)` Sets whether the page is a page block.
`void`	`setPageWebResourceDataProviderClassName(String dataProviderClassName)` Sets the page web resource data provider class name.
`void`	`setPageWebResourceDataProviderType(int dataProviderType)` Sets the page web resource data provider type.
`void`	`setParentTemplateId(String parentTemplateId)`
`void`	`setPosition(int position)`
`protected void`	`setPropertyBagId(String propertyBagId)` Sets the property bag identifier.
`void`	`setProtocol(int protocol)`
`void`	`setRuntimeDataProviderClassName(String runtimeDataProviderClassName)` Deprecated. Since 5.0.0 replaced by `setPageWebResourceDataProviderClassName(String)`.
`void`	`setRuntimeDataProviderType(int runtimeDataProviderType)` Deprecated. Since 5.0.0 replaced by `setPageWebResourceDataProviderType(int)`.
`void`	`setServerSideIncludeType(int serverSideIncludeType)` Sets whether the server side include directives should be processed for this page.
`void`	`setTemplate(boolean isTemplate)`
`void`	`setTitle(String title)`
`void`	`setType(int type)`

Methods inherited from class lumis.portal.structure.StructureElement
getAutomaticFriendlyId, getFriendlyIdBaseValue, getFriendlyIdMaxLength, getFriendlyIdValueForCounter, getLocalPropertyValue, getLocalPropertyValues, getPropertyValue, getPropertyValues, isManagedProperty, normalizeFriendlyId, removeProperty, serializePropertyBag, setPropertyValue, setPropertyValues, stripAccents

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PAGE_TYPE_USER
```
public static final int PAGE_TYPE_USER
```
    See Also:
    
    Constant Field Values
  - PAGE_TYPE_ADMIN
```
public static final int PAGE_TYPE_ADMIN
```
    See Also:
    
    Constant Field Values
  - PAGE_MAIN
```
public static final String PAGE_MAIN
```
    See Also:
    
    Constant Field Values
  - PAGE_ID_ADMIN_SERVICES
```
public static final String PAGE_ID_ADMIN_SERVICES
```
    See Also:
    
    Constant Field Values
  - PAGE_ID_ADMIN_CHANNEL_HOME
```
public static final String PAGE_ID_ADMIN_CHANNEL_HOME
```
    See Also:
    
    Constant Field Values
  - PAGE_ID_ADMIN_PAGES
```
public static final String PAGE_ID_ADMIN_PAGES
```
    See Also:
    
    Constant Field Values
  - PAGE_ID_ADMIN_ACCESS
```
public static final String PAGE_ID_ADMIN_ACCESS
```
    See Also:
    
    Constant Field Values
  - PAGE_ID_ADMIN_SUBCHANNELS
```
public static final String PAGE_ID_ADMIN_SUBCHANNELS
```
    See Also:
    
    Constant Field Values
  - PAGE_ID_ADMIN_PAGE_TEMPLATES
```
public static final String PAGE_ID_ADMIN_PAGE_TEMPLATES
```
    See Also:
    
    Constant Field Values
  - PAGE_ID_ADMIN_CHANNEL_TEMPLATES
```
public static final String PAGE_ID_ADMIN_CHANNEL_TEMPLATES
```
    See Also:
    
    Constant Field Values
  - PAGE_ID_ADMIN_GROUPS
```
public static final String PAGE_ID_ADMIN_GROUPS
```
    See Also:
    
    Constant Field Values
  - PAGE_ID_ADMIN_USERS
```
public static final String PAGE_ID_ADMIN_USERS
```
    See Also:
    
    Constant Field Values
  - PAGE_ID_ADMIN_LOCALGROUPS
```
public static final String PAGE_ID_ADMIN_LOCALGROUPS
```
    See Also:
    
    Constant Field Values
  - PAGE_ID_ADMIN_LOCALUSERS
```
public static final String PAGE_ID_ADMIN_LOCALUSERS
```
    See Also:
    
    Constant Field Values
  - PAGE_ID_ADMIN_BLANK
```
public static final String PAGE_ID_ADMIN_BLANK
```
    See Also:
    
    Constant Field Values
  - PAGE_CACHE_TYPE_DISABLED
```
public static final int PAGE_CACHE_TYPE_DISABLED
```
    See Also:
    
    Constant Field Values
  - PAGE_CACHE_TYPE_ENABLED
```
public static final int PAGE_CACHE_TYPE_ENABLED
```
    See Also:
    
    Constant Field Values
  - PAGE_CACHE_TYPE_ALL_USERS
```
@Deprecated
public static final int PAGE_CACHE_TYPE_ALL_USERS
```
    Deprecated. since 10.3.0 replaced by PAGE_CACHE_TYPE_ENABLED.
    
    See Also:
    
    Constant Field Values
  - PAGE_CACHE_TYPE_ONLY_GUEST
```
@Deprecated
public static final int PAGE_CACHE_TYPE_ONLY_GUEST
```
    Deprecated. since 10.3.0 replaced by PAGE_CACHE_TYPE_ENABLED.
    
    See Also:
    
    Constant Field Values
  - PAGE_CACHE_TYPE_INHERIT
```
public static final int PAGE_CACHE_TYPE_INHERIT
```
    See Also:
    
    Constant Field Values
  - PAGE_CENTER_NO
```
public static final int PAGE_CENTER_NO
```
    See Also:
    
    Constant Field Values
  - PAGE_CENTER_YES
```
public static final int PAGE_CENTER_YES
```
    See Also:
    
    Constant Field Values
  - PAGE_CENTER_INHERIT
```
public static final int PAGE_CENTER_INHERIT
```
    See Also:
    
    Constant Field Values
  - PAGE_LAYOUT_TYPE_INHERIT
```
public static final int PAGE_LAYOUT_TYPE_INHERIT
```
    Page layout type for inherit type.
    
    Since:
    
    4.2.0
    
    See Also:
    
    Constant Field Values
  - PAGE_LAYOUT_TYPE_WITH_TABLES
```
public static final int PAGE_LAYOUT_TYPE_WITH_TABLES
```
    Page layout type for layout using tables.
    
    Since:
    
    4.2.0
    
    See Also:
    
    Constant Field Values
  - PAGE_LAYOUT_TYPE_TABLELESS
```
public static final int PAGE_LAYOUT_TYPE_TABLELESS
```
    Page layout type for layout not using tables.
    
    Since:
    
    4.2.0
    
    See Also:
    
    Constant Field Values
  - PAGE_LAYOUT_TYPE_LAYOUT_FILE
```
public static final int PAGE_LAYOUT_TYPE_LAYOUT_FILE
```
    Page layout type for layout using layout file.
    
    Since:
    
    5.6.0
    
    See Also:
    
    Constant Field Values
  - LAYOUT_FILE_PATH_PROPERTY_NAME
```
public static final String LAYOUT_FILE_PATH_PROPERTY_NAME
```
    Property name for layout file property.
    
    Since:
    
    5.6.0
    
    See Also:
    
    Constant Field Values
  - IS_PAGE_BLOCK_PROPERTY_NAME
```
public static final String IS_PAGE_BLOCK_PROPERTY_NAME
```
    Property name for identifying as page block.
    
    Since:
    
    10.0.0
    
    See Also:
    
    Constant Field Values
  - PAGE_SERVER_SIDE_INCLUDE_NO
```
public static final int PAGE_SERVER_SIDE_INCLUDE_NO
```
    Constant that indicates to not process server side include directives.
    
    Since:
    
    4.0.11
    
    See Also:
    
    Constant Field Values
  - PAGE_SERVER_SIDE_INCLUDE_YES
```
public static final int PAGE_SERVER_SIDE_INCLUDE_YES
```
    Constant that indicates to process server side include directives.
    
    Since:
    
    4.0.11
    
    See Also:
    
    Constant Field Values
  - PAGE_PROTOCOL_INHERIT
```
public static final int PAGE_PROTOCOL_INHERIT
```
    See Also:
    
    Constant Field Values
  - PAGE_PROTOCOL_HTTP
```
public static final int PAGE_PROTOCOL_HTTP
```
    See Also:
    
    Constant Field Values
  - PAGE_PROTOCOL_HTTPS
```
public static final int PAGE_PROTOCOL_HTTPS
```
    See Also:
    
    Constant Field Values
  - PAGE_PROTOCOL_ALL
```
public static final int PAGE_PROTOCOL_ALL
```
    See Also:
    
    Constant Field Values
  - PAGE_PROTOCOL_HTTP_NAME
```
public static final String PAGE_PROTOCOL_HTTP_NAME
```
    See Also:
    
    Constant Field Values
  - PAGE_PROTOCOL_HTTPS_NAME
```
public static final String PAGE_PROTOCOL_HTTPS_NAME
```
    See Also:
    
    Constant Field Values
  - PAGE_RUNTIME_DATA_PROVIDER_TYPE_INHERIT
```
@Deprecated
public static final int PAGE_RUNTIME_DATA_PROVIDER_TYPE_INHERIT
```
    Deprecated. Since 5.0.0 replaced by #PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_INHERIT().
    
    Since:
    
    4.2.0
    
    See Also:
    
    Constant Field Values
  - PAGE_RUNTIME_DATA_PROVIDER_TYPE_DEFAULT
```
@Deprecated
public static final int PAGE_RUNTIME_DATA_PROVIDER_TYPE_DEFAULT
```
    Deprecated. Since 5.0.0 replaced by #PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_DEFAULT().
    
    Since:
    
    4.2.0
    
    See Also:
    
    Constant Field Values
  - PAGE_RUNTIME_DATA_PROVIDER_TYPE_CONTENT
```
@Deprecated
public static final int PAGE_RUNTIME_DATA_PROVIDER_TYPE_CONTENT
```
    Deprecated. Since 5.0.0 replaced by #PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CONTENT().
    
    Since:
    
    4.2.0
    
    See Also:
    
    Constant Field Values
  - PAGE_RUNTIME_DATA_PROVIDER_TYPE_CUSTOM
```
@Deprecated
public static final int PAGE_RUNTIME_DATA_PROVIDER_TYPE_CUSTOM
```
    Deprecated. Since 5.0.0 replaced by #PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CUSTOM().
    
    Since:
    
    4.2.0
    
    See Also:
    
    Constant Field Values
  - PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_INHERIT
```
public static final int PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_INHERIT
```
    See Also:
    
    Constant Field Values
  - PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_DEFAULT
```
public static final int PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_DEFAULT
```
    See Also:
    
    Constant Field Values
  - PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CONTENT
```
public static final int PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CONTENT
```
    See Also:
    
    Constant Field Values
  - PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CUSTOM
```
public static final int PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CUSTOM
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PageConfig
```
public PageConfig()
```
- Method Detail
  - getManagedPropertiesPattern
```
protected Pattern getManagedPropertiesPattern()
```
    Description copied from class: StructureElement
    
    Returns the property name spaces. Used to decides if a property can be updated.
    
    Specified by:
    
    getManagedPropertiesPattern in class StructureElement
    
    Returns:
    
    property name spaces
  - loadPropertyBagValues
```
protected void loadPropertyBagValues()
                              throws PortalException
```
    Description copied from class: StructureElement
    
    Loads the values of the property bag of this element.
    Only the properties that can be changed are actually loaded.
    
    Overrides:
    
    loadPropertyBagValues in class StructureElement
    
    Throws:
    
    PortalException
    
    See Also:
    
    StructureElement.isManagedProperty(String)
  - applyPropertyBagChanges
```
protected void applyPropertyBagChanges()
                                throws PortalException
```
    Description copied from class: StructureElement
    
    Apply the changes made to the properties managed by this element to the property bag persistence entities.
    
    Overrides:
    
    applyPropertyBagChanges in class StructureElement
    
    Throws:
    
    PortalException
    
    See Also:
    
    StructureElement.isManagedProperty(String)
  - getLayoutFilePath
```
public String getLayoutFilePath()
```
    Returns the path for the layout file for use by this page.
    The layout file may be inherited to child elements.
    If getLayoutType() is not PAGE_LAYOUT_TYPE_LAYOUT_FILE (or inherited it), this method will return null since no layout file is to be used.
    
    Returns:
    
    layoutFile the path for the layout file, relative to the <lumisdata>/def directory, possibly inherited from parent channel; or null if no layout file is to be used.
    
    Since:
    
    5.6.0
    
    See Also:
    
    #getLayoutPagesType(), setLayoutFile(String)
  - setLayoutFile
```
public void setLayoutFile(String layoutFile)
```
    Sets the path for the layout file.
    The layout file may be inherited to child elements.
    When the layout file is set, getLayoutType() is automatically changed to PAGE_LAYOUT_TYPE_LAYOUT_FILE.
    
    Parameters:
    
    layoutFile - the path relative to the <lumisdata>/def directory.
    
    Since:
    
    5.6.0
    
    See Also:
    
    setLayoutType(int)
  - isPageBlock
```
public boolean isPageBlock()
```
    Determines if the current page is a page block.
    
    Returns:
    
    true if page block
    
    Since:
    
    10.0.0
  - setPageBlock
```
public void setPageBlock(boolean isPageBlock)
```
    Sets whether the page is a page block.
    
    Parameters:
    
    isPageBlock - true if page block.
    
    Since:
    
    10.0.0
  - getId
```
public String getId()
```
    Returns:
    
    Returns the pageId.
  - setId
```
public void setId(String id)
```
    Parameters:
    
    Id - The pageId to set.
  - getName
```
public String getName()
```
    Returns:
    
    Returns the name.
  - setName
```
public void setName(String name)
```
    Parameters:
    
    name - The name to set.
  - getDescription
```
public String getDescription()
```
    Returns:
    
    Returns the description.
  - setDescription
```
public void setDescription(String description)
```
    Parameters:
    
    description - The description to set.
  - getLayout
```
public String getLayout()
```
    Returns:
    
    Returns the layout.
  - setLayout
```
public void setLayout(String layout)
```
    Parameters:
    
    layout - The layout to set.
  - getChannelId
```
public String getChannelId()
```
    Returns:
    
    Returns the channelId.
  - setChannelId
```
public void setChannelId(String channelId)
```
    Parameters:
    
    channelId - The channelId to set.
  - getCacheType
```
public int getCacheType()
```
    Returns:
    
    Returns the cacheType.
  - setCacheType
```
public void setCacheType(int cacheType)
```
    Parameters:
    
    cacheType - The type of cache to set.
  - isHidden
```
public boolean isHidden()
```
    Returns:
    
    Returns the hidden.
  - setHidden
```
public void setHidden(boolean hidden)
```
    Parameters:
    
    hidden - The hidden to set.
  - getInheritsStylesheets
```
public boolean getInheritsStylesheets()
```
    Returns:
    
    Returns the inheritsStylesheets.
  - getInheritsMetaTags
```
public boolean getInheritsMetaTags()
```
    Returns:
    
    Returns the inheritsMetaTags.
  - setInheritsStylesheets
```
public void setInheritsStylesheets(boolean inheritsStylesheets)
```
    Parameters:
    
    inheritsStylesheets - The inheritsStylesheets to set.
  - setInheritsMetaTags
```
public void setInheritsMetaTags(boolean inheritsMetaTags)
```
    Parameters:
    
    inheritsMetaTags - The inheritsMetaTags to set.
  - getProtocol
```
public int getProtocol()
```
    Returns:
    
    Returns the protocol.
  - setProtocol
```
public void setProtocol(int protocol)
```
    Parameters:
    
    protocol - The protocol to set.
  - getKeywords
```
public String getKeywords()
```
    Returns:
    
    Returns the keywords.
  - setKeywords
```
public void setKeywords(String keywords)
```
    Parameters:
    
    keywords - The keywords to set.
  - getTitle
```
public String getTitle()
```
    Returns:
    
    Returns the title.
  - setTitle
```
public void setTitle(String title)
```
    Parameters:
    
    title - The title to set.
  - getParentTemplateId
```
public String getParentTemplateId()
```
    Returns:
    
    Returns the parentTemplateId.
  - setParentTemplateId
```
public void setParentTemplateId(String parentTemplateId)
```
    Parameters:
    
    parentTemplateId - The parentTemplateId to set.
  - getPosition
```
public int getPosition()
```
    Returns:
    
    Returns the position.
  - setPosition
```
public void setPosition(int position)
```
    Parameters:
    
    position - The position to set.
  - getType
```
public int getType()
```
    Returns:
    
    Returns the position.
  - setType
```
public void setType(int type)
```
    Parameters:
    
    position - The position to set.
  - isTemplate
```
public boolean isTemplate()
```
    Returns:
    
    Returns the isTemplate.
  - setTemplate
```
public void setTemplate(boolean isTemplate)
```
    Parameters:
    
    isTemplate - The isTemplate to set.
  - getAccessControlListId
```
public String getAccessControlListId()
```
  - setAccessControlListId
```
public void setAccessControlListId(String accessControlListId)
```
  - getPropertyBagId
```
public String getPropertyBagId()
```
    Description copied from class: StructureElement
    
    Returns the property bag identifier.
    
    Specified by:
    
    getPropertyBagId in class StructureElement
    
    Returns:
    
    The propertyBagId.
  - setPropertyBagId
```
protected void setPropertyBagId(String propertyBagId)
```
    Sets the property bag identifier.
    This method should be used only for non-persisted page, because this property value may not be changed.
    
    Parameters:
    
    propertyBagId - The propertyBagId to set.
    
    Since:
    
    5.0.0
  - getCenterPage
```
public int getCenterPage()
```
  - setCenterPage
```
public void setCenterPage(int centerPage)
```
  - getLayoutType
```
public int getLayoutType()
```
  - setLayoutType
```
public void setLayoutType(int layoutType)
```
    Sets the layout type.
    To set PAGE_LAYOUT_TYPE_LAYOUT_FILE value use the method setLayoutFile(String), and the layout type is changed automatically. PAGE_LAYOUT_TYPE_LAYOUT_FILE cannot be set directly with this method.
    If set to a value different of PAGE_LAYOUT_TYPE_LAYOUT_FILE, the getLayoutFilePath() will be changed to null.
    
    Parameters:
    
    layoutType - the page layout type.
    
    Throws:
    
    IllegalArgumentException - If called with the argument PAGE_LAYOUT_TYPE_LAYOUT_FILE.
    
    Since:
    
    4.2.0
    
    See Also:
    
    setLayoutFile(String).
  - serialize
```
public void serialize(PageConfig pageConfig,
                      OutputStream outputStream)
               throws PortalException
```
    Throws:
    
    PortalException
  - deserialize
```
public void deserialize(Node pageNode)
                 throws PortalException
```
    Throws:
    
    PortalException
  - deserializePropertyBag
```
protected void deserializePropertyBag(Node propertyBagNode)
                               throws PortalException
```
    Description copied from class: StructureElement
    
    Updates this element's property bag according to the given serialized property bag node.
    
    Overrides:
    
    deserializePropertyBag in class StructureElement
    
    Parameters:
    
    propertyBagNode - the property bag serialized node, in the same syntax as generated by StructureElement.serializePropertyBag().
    
    Throws:
    
    PortalException - if an error occurred during deserialization.
  - clone
```
public PageConfig clone()
```
    Specified by:
    
    clone in interface ICloneableCacheEntry
    
    Specified by:
    
    clone in interface ICloneableConfig<PageConfig>
    
    Overrides:
    
    clone in class Object
  - isOverrideServerSideInclude
```
public boolean isOverrideServerSideInclude()
```
    Indicates whether the server side include type should be calculated automatically by the framework.
    By default this value is false.
    
    Returns:
    
    false if server-side include type is calculated by the framework. true otherwise.
    
    Since:
    
    4.1.0
    
    See Also:
    
    getServerSideIncludeType()
  - setOverrideServerSideInclude
```
public void setOverrideServerSideInclude(boolean overrideServerSideInclude)
```
    Sets whether the server side include type should be calculated automatically by the framework.
    
    Parameters:
    
    overrideServerSideInclude - false if server-side include type is calculated by the framework. true otherwise.
    
    Since:
    
    4.1.0
    
    See Also:
    
    getServerSideIncludeType()
  - getServerSideIncludeType
```
public int getServerSideIncludeType()
```
    Returns whether the server side include directives are processed for this page.
    
    Returns:
    
    either 0 or 1
    
    Since:
    
    4.1.0
  - setServerSideIncludeType
```
public void setServerSideIncludeType(int serverSideIncludeType)
```
    Sets whether the server side include directives should be processed for this page.
    
    Parameters:
    
    serverSideIncludeType - either 0 or 1
    
    Since:
    
    4.1.0
  - getRuntimeDataProviderType
```
@Deprecated
public int getRuntimeDataProviderType()
```
    Deprecated. Since 5.0.0 replaced by getPageWebResourceDataProviderType().
    
    Returns the runtime data provider type. The possible values are 0 or 1 or 2 or 3
    
    Returns:
    
    the runtime data provider type.
    
    Since:
    
    4.2.0
  - setRuntimeDataProviderType
```
@Deprecated
public void setRuntimeDataProviderType(int runtimeDataProviderType)
```
    Deprecated. Since 5.0.0 replaced by setPageWebResourceDataProviderType(int).
    
    Sets the runtime data provider type. The possible values are 0 or 1 or 2 or 3
    
    Parameters:
    
    runtimeDataProviderType - the runtime data provider type.
    
    Since:
    
    4.2.0
  - getRuntimeDataProviderClassName
```
@Deprecated
public String getRuntimeDataProviderClassName()
```
    Deprecated. Since 5.0.0 replaced by getPageWebResourceDataProviderClassName().
    
    Returns the class name for the page runtime data provider. This value should only be used if the runtime data provider type is 3
    
    Returns:
    
    the runtime data provider class name
    
    Since:
    
    4.2.0
  - setRuntimeDataProviderClassName
```
@Deprecated
public void setRuntimeDataProviderClassName(String runtimeDataProviderClassName)
```
    Deprecated. Since 5.0.0 replaced by setPageWebResourceDataProviderClassName(String).
    
    Sets the runtime data provider class name.
    
    Parameters:
    
    runtimeDataProviderClassName - the class name to be set.
    
    Since:
    
    4.2.0
  - getPageWebResourceDataProviderClassName
```
public String getPageWebResourceDataProviderClassName()
```
    Returns the class name for the page web resource data provider.
    This value should only be used if the page web resource data provider type is PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CUSTOM.
    
    Returns:
    
    the page web resource data provider class name.
    
    Since:
    
    5.0.0
  - setPageWebResourceDataProviderClassName
```
public void setPageWebResourceDataProviderClassName(String dataProviderClassName)
```
    Sets the page web resource data provider class name.
    
    Parameters:
    
    dataProviderClassName - the class name to be set.
    
    Since:
    
    5.0.0
  - getPageWebResourceDataProviderType
```
public int getPageWebResourceDataProviderType()
```
    Returns the page web resource data provider type.
    The possible values are PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_INHERIT or PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_DEFAULT or PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CONTENT or PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CUSTOM
    
    Returns:
    
    the page web resource data provider type.
    
    Since:
    
    5.0.0
  - setPageWebResourceDataProviderType
```
public void setPageWebResourceDataProviderType(int dataProviderType)
```
    Sets the page web resource data provider type.
    The possible values are PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_INHERIT or PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_DEFAULT or PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CONTENT or PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CUSTOM
    
    Parameters:
    
    dataProviderType - the page web resource data provider type.
    
    Since:
    
    5.0.0
  - setFriendlyId
```
public void setFriendlyId(String friendlyId)
```
    Sets the page's friendly identifier. This value must be unique among the pages contained in the same channel this page is contained.
    
    Parameters:
    
    friendlyId - the page's friendly identifier.
    
    Since:
    
    6.0.0
  - setAutoGeneratedFriendlyId
```
public void setAutoGeneratedFriendlyId()
```
    Generates a new friendly identifier and sets it as the friendly identifier of this page. The friendly identifier is generated based on this page's current name.
    This method requires an active transaction.
    
    Since:
    
    6.0.0
    
    See Also:
    
    setFriendlyId(String)
  - getFriendlyId
```
public String getFriendlyId()
```
    Returns the page's friendly identifier.
    
    Returns:
    
    the page's friendly identifier.
    
    Since:
    
    6.0.0
  - setAutomaticFriendlyId
```
public void setAutomaticFriendlyId(boolean automaticFriendlyId)
```
    Indicates whether the page is going to use automatic generated friendly identifier or not.
    
    Parameters:
    
    automaticFriendlyId - indicates whether the page is going to use automatic generated friendly identifier or not.
    
    Since:
    
    6.0.0
  - isAutomaticFriendlyId
```
public boolean isAutomaticFriendlyId()
```
    Returns whether the page is going to use automatic generated friendly identifier or not.
    
    Returns:
    
    whether the page is going to use automatic generated friendly identifier or not.
    
    Since:
    
    6.0.0
  - isIdentical
```
public boolean isIdentical(PageConfig pageConfig)
```
    Returns true if all properties of this object are equals to the properties of the given object.
    
    Parameters:
    
    pageConfig - the object to compare the properties with.
    
    Returns:
    
    true if the properties are equal, false otherwise.
    
    Since:
    
    5.6.0
  - mayUseFriendlyId
```
protected boolean mayUseFriendlyId(String friendlyId)
                            throws PortalException
```
    Description copied from class: StructureElement
    
    Indicates if the element may use the given friendly identifier.
    
    Specified by:
    
    mayUseFriendlyId in class StructureElement
    
    Parameters:
    
    friendlyId - the friendly identifier.
    
    Returns:
    
    true if the element may use the given friendly identifier, false otherwise.
    
    Throws:
    
    PortalException

Class PageConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class lumis.portal.structure.StructureElement

Methods inherited from class java.lang.Object

Field Detail

PAGE_TYPE_USER

PAGE_TYPE_ADMIN

PAGE_MAIN

PAGE_ID_ADMIN_SERVICES

PAGE_ID_ADMIN_CHANNEL_HOME

PAGE_ID_ADMIN_PAGES

PAGE_ID_ADMIN_ACCESS

PAGE_ID_ADMIN_SUBCHANNELS

PAGE_ID_ADMIN_PAGE_TEMPLATES

PAGE_ID_ADMIN_CHANNEL_TEMPLATES

PAGE_ID_ADMIN_GROUPS

PAGE_ID_ADMIN_USERS

PAGE_ID_ADMIN_LOCALGROUPS

PAGE_ID_ADMIN_LOCALUSERS

PAGE_ID_ADMIN_BLANK

PAGE_CACHE_TYPE_DISABLED

PAGE_CACHE_TYPE_ENABLED

PAGE_CACHE_TYPE_ALL_USERS

PAGE_CACHE_TYPE_ONLY_GUEST

PAGE_CACHE_TYPE_INHERIT

PAGE_CENTER_NO

PAGE_CENTER_YES

PAGE_CENTER_INHERIT

PAGE_LAYOUT_TYPE_INHERIT

PAGE_LAYOUT_TYPE_WITH_TABLES

PAGE_LAYOUT_TYPE_TABLELESS

PAGE_LAYOUT_TYPE_LAYOUT_FILE

LAYOUT_FILE_PATH_PROPERTY_NAME

IS_PAGE_BLOCK_PROPERTY_NAME

PAGE_SERVER_SIDE_INCLUDE_NO

PAGE_SERVER_SIDE_INCLUDE_YES

PAGE_PROTOCOL_INHERIT

PAGE_PROTOCOL_HTTP

PAGE_PROTOCOL_HTTPS

PAGE_PROTOCOL_ALL

PAGE_PROTOCOL_HTTP_NAME

PAGE_PROTOCOL_HTTPS_NAME

PAGE_RUNTIME_DATA_PROVIDER_TYPE_INHERIT

PAGE_RUNTIME_DATA_PROVIDER_TYPE_DEFAULT

PAGE_RUNTIME_DATA_PROVIDER_TYPE_CONTENT

PAGE_RUNTIME_DATA_PROVIDER_TYPE_CUSTOM

PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_INHERIT

PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_DEFAULT

PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CONTENT

PAGE_WEB_RESOURCE_DATA_PROVIDER_TYPE_CUSTOM

Constructor Detail

PageConfig

Method Detail

getManagedPropertiesPattern

loadPropertyBagValues

applyPropertyBagChanges

getLayoutFilePath

setLayoutFile

isPageBlock

setPageBlock

getId

setId

getName

setName

getDescription

setDescription

getLayout

setLayout

getChannelId

setChannelId

getCacheType

setCacheType

isHidden

setHidden

getInheritsStylesheets

getInheritsMetaTags

setInheritsStylesheets

setInheritsMetaTags