lumis.portal.channel
Class ChannelConfig

Package class diagram package ChannelConfig
java.lang.Object
  extended by lumis.portal.channel.ChannelConfig
All Implemented Interfaces:
Cloneable, ICacheEntry, ICloneableCacheEntry, ICloneableConfig<ChannelConfig>

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

Channel entity class

Since:
4.0.0

Field Summary
static int CHANNEL_TYPE_BASIC
           
static int CHANNEL_TYPE_LUMISADMIN
           
static int FRIENDLY_PATH_TYPE_CHANNEL_NAME
          The friendly path is generated using the parent channel's path and appending this channel's name
static int FRIENDLY_PATH_TYPE_INHERIT
          The friendly path is the same as this channel's parent friendly path.
static int FRIENDLY_PATH_TYPE_USER_DEFINED
          The friendly path is user defined.
static String LUMIS_ADMIN_CHANNEL_ID
           
static String PORTAL_CHANNEL_ID
           
 
Constructor Summary
ChannelConfig()
           
 
Method Summary
 ChannelConfig clone()
           
 void deserialize(Node channelNode)
           
 boolean equals(Object o)
           
 String getAccessControlListId()
           
 int getCachePages()
           
 int getCenterPages()
           
 String getDescription()
           
 int getFriendlyPathType()
           
 String getFriendlyPathUserDefined()
           
 String getId()
           
 String getLocalGroupPrefix()
           
 String getName()
           
 String getPageTemplateId()
           
 String getParentId()
           
 String getParentTemplateId()
           
 int getPosition()
           
 int getProtocol()
           
 String getTemplateLocalGroupPrefix()
          Returns the template local group prefix.
 int getType()
           
 boolean hasLocalGroups()
           
 boolean isHidden()
           
 boolean isInheritMetaTags()
           
 boolean isInheritPageTemplate()
           
 boolean isInheritProtocol()
          Deprecated. since 4.0.11. This property is acquired via the getProtocol() method.
 boolean isInheritStylesheet()
           
 boolean isTemplate()
           
 void serialize(ChannelConfig channelConfig, OutputStream outputStream)
           
 void setAccessControlListId(String accessControlListId)
           
 void setCachePages(int cachePages)
           
 void setCenterPages(int centerPages)
           
 void setDescription(String description)
           
 void setFriendlyPathType(int friendlyPathType)
           
 void setFriendlyPathUserDefined(String friendlyPathUserDefined)
           
 void setHidden(boolean hidden)
           
 void setId(String id)
           
 void setInheritMetaTags(boolean inheritMetaTags)
           
 void setInheritPageTemplate(boolean inheritPageTemplate)
           
 void setInheritProtocol(boolean inheritProtocol)
          Deprecated. since 4.0.11. This property is set via the #setProtocol() method.
 void setInheritStylesheet(boolean inheritStylesheet)
           
 void setLocalGroupPrefix(String localGroupPrefix)
           
 void setLocalGroups(boolean localGroups)
           
 void setName(String name)
           
 void setPageTemplateId(String pageTemplateId)
           
 void setParentId(String parentId)
           
 void setParentTemplateId(String parentTemplateId)
           
 void setPosition(int position)
           
 void setProtocol(int protocol)
           
 void setTemplate(boolean isTemplate)
           
 void setTemplateLocalGroupPrefix(String templateLocalGroupPrefix)
          Sets the template local group prefix.
 void setType(int type)
           
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CHANNEL_TYPE_BASIC

public static final int CHANNEL_TYPE_BASIC
See Also:
Constant Field Values

CHANNEL_TYPE_LUMISADMIN

public static final int CHANNEL_TYPE_LUMISADMIN
See Also:
Constant Field Values

PORTAL_CHANNEL_ID

public static final String PORTAL_CHANNEL_ID
See Also:
Constant Field Values

LUMIS_ADMIN_CHANNEL_ID

public static final String LUMIS_ADMIN_CHANNEL_ID
See Also:
Constant Field Values

FRIENDLY_PATH_TYPE_CHANNEL_NAME

public static final int FRIENDLY_PATH_TYPE_CHANNEL_NAME
The friendly path is generated using the parent channel's path and appending this channel's name

See Also:
Constant Field Values

FRIENDLY_PATH_TYPE_USER_DEFINED

public static final int FRIENDLY_PATH_TYPE_USER_DEFINED
The friendly path is user defined.

See Also:
Constant Field Values

FRIENDLY_PATH_TYPE_INHERIT

public static final int FRIENDLY_PATH_TYPE_INHERIT
The friendly path is the same as this channel's parent friendly path.

See Also:
Constant Field Values
Constructor Detail

ChannelConfig

public ChannelConfig()
Method Detail

getId

public String getId()
Returns:
Returns the channelId.

setId

public void setId(String id)
Parameters:
id - The channelId to set.

getDescription

public String getDescription()
Returns:
Returns the description.

setDescription

public void setDescription(String description)
Parameters:
description - The description to set.

getName

public String getName()
Returns:
Returns the name.

setName

public void setName(String name)
Parameters:
name - The name to set.

isHidden

public boolean isHidden()
Returns:
Returns the hidden.

setHidden

public void setHidden(boolean hidden)
Parameters:
hidden - The hidden to set.

isInheritStylesheet

public boolean isInheritStylesheet()
Returns:
true if the Stylesheet was inherited and false otherwise.

isInheritMetaTags

public boolean isInheritMetaTags()
Returns:
true if the Meta-Tags is inherited and false otherwise.

setInheritStylesheet

public void setInheritStylesheet(boolean inheritStylesheet)
Parameters:
inheritStylesheet -

setInheritMetaTags

public void setInheritMetaTags(boolean inheritMetaTags)
Parameters:
inheritMetaTags -

isInheritProtocol

@Deprecated
public boolean isInheritProtocol()
Deprecated. since 4.0.11. This property is acquired via the getProtocol() method.

Returns:
Returns the inheritProtocol.

setInheritProtocol

@Deprecated
public void setInheritProtocol(boolean inheritProtocol)
Deprecated. since 4.0.11. This property is set via the #setProtocol() method.

Parameters:
inheritProtocol - The inheritProtocol to set.

isTemplate

public boolean isTemplate()
Returns:
Returns the isTemplate.

setTemplate

public void setTemplate(boolean isTemplate)
Parameters:
isTemplate - The isTemplate to set.

getPageTemplateId

public String getPageTemplateId()
Returns:
Returns the pageTemplateId.

setPageTemplateId

public void setPageTemplateId(String pageTemplateId)
Parameters:
pageTemplateId - The pageTemplateId to set.

getParentId

public String getParentId()
Returns:
Returns the parentId.

setParentId

public void setParentId(String parentId)
Parameters:
parentId - The parentId to set.

getPosition

public int getPosition()
Returns:
Returns the position.

setPosition

public void setPosition(int position)
Parameters:
position - The position to set.

getProtocol

public int getProtocol()
Returns:
Returns the protocol.

setProtocol

public void setProtocol(int protocol)
Parameters:
protocol - The protocol to set.

getType

public int getType()
Returns:
Returns the type.

setType

public void setType(int type)
Parameters:
type - The type to set.

equals

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

getAccessControlListId

public String getAccessControlListId()
Returns:
Returns the accessControlListId.

setAccessControlListId

public void setAccessControlListId(String accessControlListId)
Parameters:
accessControlListId - The accessControlListId to set.

getCenterPages

public int getCenterPages()
Returns:
Returns the centerPages.

setCenterPages

public void setCenterPages(int centerPages)
Parameters:
centerPages - The centerPages to set.

getCachePages

public int getCachePages()
Returns:
Returns the cachePages.

setCachePages

public void setCachePages(int cachePages)
Parameters:
cachePages - The cachePages to set.

hasLocalGroups

public boolean hasLocalGroups()
Returns:
Returns the localGroups.

setLocalGroups

public void setLocalGroups(boolean localGroups)
Parameters:
localGroups - The localGroups to set.

getLocalGroupPrefix

public String getLocalGroupPrefix()
Returns:
Returns the localGroupPrefix.

setLocalGroupPrefix

public void setLocalGroupPrefix(String localGroupPrefix)
Parameters:
localGroupPrefix - The localGroupPrefix to set.

getTemplateLocalGroupPrefix

public String getTemplateLocalGroupPrefix()
Returns the template local group prefix. This attribute specifies the pattern used when applying a channel template.

Returns:
the template local group prefix.
Since:
4.0.6

setTemplateLocalGroupPrefix

public void setTemplateLocalGroupPrefix(String templateLocalGroupPrefix)
Sets the template local group prefix.

Parameters:
templateLocalGroupPrefix - the value to set.
Since:
4.0.6
See Also:
getTemplateLocalGroupPrefix()

getFriendlyPathType

public int getFriendlyPathType()

setFriendlyPathType

public void setFriendlyPathType(int friendlyPathType)

getFriendlyPathUserDefined

public String getFriendlyPathUserDefined()

setFriendlyPathUserDefined

public void setFriendlyPathUserDefined(String friendlyPathUserDefined)

clone

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

serialize

public void serialize(ChannelConfig channelConfig,
                      OutputStream outputStream)
               throws PortalException
Throws:
PortalException

deserialize

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

getParentTemplateId

public String getParentTemplateId()

setParentTemplateId

public void setParentTemplateId(String parentTemplateId)

isInheritPageTemplate

public boolean isInheritPageTemplate()

setInheritPageTemplate

public void setInheritPageTemplate(boolean inheritPageTemplate)


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