lumis.portal.page
Class PageConfig

Package class diagram package PageConfig
java.lang.Object
  extended by lumis.portal.page.PageConfig
All Implemented Interfaces:
Cloneable, ICacheEntry, ICloneableCacheEntry, ICloneableConfig<PageConfig>
Direct Known Subclasses:
PageDataType.Data

@StableMinor(version="4.1",
             sinceVersion="4.0")
public class PageConfig
extends Object
implements ICloneableCacheEntry, ICloneableConfig<PageConfig>

Represents a Page object

Since:
4.0.6

Field Summary
static int PAGE_CACHE_TYPE_ALL_USERS
           
static int PAGE_CACHE_TYPE_DISABLED
           
static int PAGE_CACHE_TYPE_INHERIT
           
static int PAGE_CACHE_TYPE_ONLY_GUEST
           
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_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 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_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
           
 
Constructor Summary
PageConfig()
           
 
Method Summary
 PageConfig clone()
           
 void deserialize(Node pageNode)
           
 String getAccessControlListId()
           
 int getCacheType()
           
 int getCenterPage()
           
 String getChannelId()
           
 String getDescription()
           
 String getId()
           
 boolean getInheritsMetaTags()
           
 boolean getInheritsStylesheets()
           
 String getKeywords()
           
 String getLayout()
           
 String getName()
           
 String getParentTemplateId()
           
 int getPosition()
           
 int getProtocol()
           
 String getRunTimeServiceInstanceId()
           
 String getRunTimeServiceInterfaceId()
           
 int getServerSideIncludeType()
          Returns whether the server side include directives are processed for this page.
 String getTitle()
           
 int getType()
           
 boolean hasRunTimeServiceInterfaces()
           
 boolean isHidden()
           
 boolean isOverrideServerSideInclude()
          Indicates whether the server side include type should be calculated automatically by the framework.
 boolean isPopup()
           
 boolean isTemplate()
           
 void serialize(PageConfig pageConfig, OutputStream outputStream)
           
 void setAccessControlListId(String accessControlListId)
           
 void setCacheType(int cacheType)
           
 void setCenterPage(int centerPage)
           
 void setChannelId(String channelId)
           
 void setDescription(String description)
           
 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 setName(String name)
           
 void setOverrideServerSideInclude(boolean overrideServerSideInclude)
          Sets whether the server side include type should be calculated automatically by the framework.
 void setParentTemplateId(String parentTemplateId)
           
 void setPosition(int position)
           
 void setProtocol(int protocol)
           
 void setRunTimeServiceInstanceId(String runTimeServiceInstanceId)
           
 void setRunTimeServiceInterfaceId(String runTimeServiceInterfaceId)
           
 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 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_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_ALL_USERS

public static final int PAGE_CACHE_TYPE_ALL_USERS
See Also:
Constant Field Values

PAGE_CACHE_TYPE_ONLY_GUEST

public static final int PAGE_CACHE_TYPE_ONLY_GUEST
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_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
Constructor Detail

PageConfig

public PageConfig()
Method Detail

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.

setRunTimeServiceInterfaceId

public void setRunTimeServiceInterfaceId(String runTimeServiceInterfaceId)

getRunTimeServiceInterfaceId

public String getRunTimeServiceInterfaceId()

setRunTimeServiceInstanceId

public void setRunTimeServiceInstanceId(String runTimeServiceInstanceId)

getRunTimeServiceInstanceId

public String getRunTimeServiceInstanceId()

hasRunTimeServiceInterfaces

public boolean hasRunTimeServiceInterfaces()

isPopup

public boolean isPopup()

getAccessControlListId

public String getAccessControlListId()

setAccessControlListId

public void setAccessControlListId(String accessControlListId)

getCenterPage

public int getCenterPage()

setCenterPage

public void setCenterPage(int centerPage)

serialize

public void serialize(PageConfig pageConfig,
                      OutputStream outputStream)
               throws PortalException
Throws:
PortalException

deserialize

public void deserialize(Node pageNode)
                 throws PortalException
Throws:
PortalException

clone

public PageConfig clone()
                 throws CloneNotSupportedException
Specified by:
clone in interface ICloneableCacheEntry
Specified by:
clone in interface ICloneableConfig<PageConfig>
Overrides:
clone in class Object
Throws:
CloneNotSupportedException

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


Lumisportal  4.1.0.071221 - Copyright © 2001-2007, Lumis. All Rights Reserved.