Package lumis.portal.page

Class PageConfig

    • Field Detail

      • 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_INHERIT

        public static final int PAGE_CACHE_TYPE_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_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

      • 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)

      • 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()

      • 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

      • 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