org.jasig.portal.layout.dlm
Class ChannelDescription

java.lang.Object
  org.jasig.portal.layout.node.UserLayoutNodeDescription
      org.jasig.portal.layout.node.UserLayoutChannelDescription
          org.jasig.portal.layout.dlm.ChannelDescription

All Implemented Interfaces:

IUserLayoutChannelDescription, IUserLayoutNodeDescription

public class ChannelDescription
extends UserLayoutChannelDescription

DLM specific Channel description to protect DLM artifacts of channels.

Author:

mboyd@sungardct.com

Field Summary

Fields inherited from class org.jasig.portal.layout.node.UserLayoutNodeDescription

addChildAllowed, deleteAllowed, editAllowed, hidden, id, immutable, moveAllowed, name, precedence, unremovable

Fields inherited from interface org.jasig.portal.layout.node.IUserLayoutNodeDescription

CHANNEL, FOLDER

Constructor Summary

ChannelDescription()
Overridden constructor of super class.

ChannelDescription(Element xmlNode)
Overridden constructor of super class.

ChannelDescription(IUserLayoutChannelDescription d)
Overridden constructor of super class.

Method Summary

static UserLayoutNodeDescription	createUserLayoutNodeDescription(Element xmlNode) Shadowing version of the same method in UserLayoutNodeDescription to produce DLM specific instances for channels.
org.jasig.portal.layout.dlm.FragmentChannelInfo	getFragmentChannelInfo()
String	getOrigin()
boolean	getParameterOverrideValue(String parameterName) For DLM parameters starting with the dlm namespace are reserved for use by DLM and hence can't be overridden.
String	getPlfId()
Element	getXML(Document root) Creates a org.w3c.dom.Element representation of the current channel.
void	resetParameter(String parameterName) Reset a channel parameter value.
void	setFragmentChannelInfo(org.jasig.portal.layout.dlm.FragmentChannelInfo fragmentChannelInfo)
void	setOrigin(String origin)
void	setPlfId(String plfId)

Methods inherited from class org.jasig.portal.layout.node.UserLayoutChannelDescription

addNodeAttributes, addParameterChildren, canOverrideParameter, clearParameters, containsParameter, getChannelPublishId, getChannelSubscribeId, getChannelTypeId, getClassName, getDescription, getFunctionalName, getParameterMap, getParameterNames, getParameterValue, getParameterValues, getTimeout, getTitle, getType, hasAbout, hasHelp, hasParameters, isEditable, isPortlet, isSecure, numberOfParameters, remove, setChannelPublishId, setChannelSubscribeId, setChannelTypeId, setClassName, setDescription, setEditable, setFunctionalName, setHasAbout, setHasHelp, setIsSecure, setParameterOverride, setParameterValue, setTimeout, setTitle, toString

Methods inherited from class org.jasig.portal.layout.node.UserLayoutNodeDescription

getId, getName, getPrecedence, isAddChildAllowed, isDeleteAllowed, isEditAllowed, isHidden, isImmutable, isMoveAllowed, isUnremovable, setAddChildAllowed, setDeleteAllowed, setEditAllowed, setHidden, setId, setImmutable, setMoveAllowed, setName, setPrecedence, setUnremovable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jasig.portal.layout.node.IUserLayoutNodeDescription

getId, getName, getPrecedence, isAddChildAllowed, isDeleteAllowed, isEditAllowed, isHidden, isImmutable, isMoveAllowed, isUnremovable, setAddChildAllowed, setDeleteAllowed, setEditAllowed, setHidden, setId, setImmutable, setMoveAllowed, setName, setPrecedence, setUnremovable

Constructor Detail

ChannelDescription

public ChannelDescription()

Overridden constructor of super class.

ChannelDescription

public ChannelDescription(Element xmlNode)
                   throws PortalException

Overridden constructor of super class.

Parameters:

xmlNode - the Element to be represented

Throws:

PortalException

ChannelDescription

public ChannelDescription(IUserLayoutChannelDescription d)

Overridden constructor of super class.

Parameters:

d - an IUserLayoutChannelDescription

Method Detail

getFragmentChannelInfo

public org.jasig.portal.layout.dlm.FragmentChannelInfo getFragmentChannelInfo()

resetParameter

public void resetParameter(String parameterName)
                    throws PortalException

Description copied from class: UserLayoutChannelDescription

Reset a channel parameter value. Since parameter changes by channels can be persisted if override is allowed this method enables resetting to the original value or, if the parameter is ad-hoc meaning that the channel definition does not provide a value for this parameter, then the parameter value is removed.

Specified by:

resetParameter in interface IUserLayoutChannelDescription

Overrides:

resetParameter in class UserLayoutChannelDescription

Parameters:

parameterName - a String value

Throws:

PortalException

setFragmentChannelInfo

public void setFragmentChannelInfo(org.jasig.portal.layout.dlm.FragmentChannelInfo fragmentChannelInfo)

getOrigin

public String getOrigin()

setOrigin

public void setOrigin(String origin)

getPlfId

public String getPlfId()

setPlfId

public void setPlfId(String plfId)

getParameterOverrideValue

public boolean getParameterOverrideValue(String parameterName)

For DLM parameters starting with the dlm namespace are reserved for use by DLM and hence can't be overridden. The channel published definition may restrict updating. And finally, a fragment may restrict updating.

Specified by:

getParameterOverrideValue in interface IUserLayoutChannelDescription

Overrides:

getParameterOverrideValue in class UserLayoutChannelDescription

Parameters:

parameterName - a String value

Returns:

a boolean value

createUserLayoutNodeDescription

public static UserLayoutNodeDescription createUserLayoutNodeDescription(Element xmlNode)
                                                                 throws PortalException

Shadowing version of the same method in UserLayoutNodeDescription to produce DLM specific instances for channels.

Parameters:

xmlNode - a user layout DTD folder/channel Element value

Returns:

an UserLayoutNodeDescription value

Throws:

PortalException - if the xml passed is somehow invalid.

getXML

public Element getXML(Document root)

Description copied from class: UserLayoutChannelDescription

Creates a org.w3c.dom.Element representation of the current channel.

Specified by:

getXML in interface IUserLayoutChannelDescription

Specified by:

getXML in interface IUserLayoutNodeDescription

Overrides:

getXML in class UserLayoutChannelDescription

Parameters:

root - a Document for which the Element should be created.

Returns:

a Node value