org.jasig.portal.layout.node
Class UserLayoutChannelDescription

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

All Implemented Interfaces:

IUserLayoutChannelDescription, IUserLayoutNodeDescription

Direct Known Subclasses:

ChannelDescription

public class UserLayoutChannelDescription
extends UserLayoutNodeDescription
implements IUserLayoutChannelDescription

A class managing information contained in a user layout channel node.

Version:

1.0

Author:

Peter Kharchenko pkharchenko@interactivebusiness.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

UserLayoutChannelDescription()

UserLayoutChannelDescription(Element xmlNode)
Reconstruct channel information from an xml Element

UserLayoutChannelDescription(IChannelDefinition definition)
Construct channel information from a Channel Definition object.

UserLayoutChannelDescription(IUserLayoutChannelDescription d)

Method Summary

void	addNodeAttributes(Element node) Add all of common node attributes to the Element.
void	addParameterChildren(Element node, Document root)
boolean	canOverrideParameter(String parameterName) Determine if a given parameter can be overriden by the user.
void	clearParameters() Clears all of the channel parameters.
boolean	containsParameter(String parameterName) Determines if a certain parameter name is present.
String	getChannelPublishId() Get the value of channelPublishId for this channel.
String	getChannelSubscribeId() Get the value of channelSubscribeId.
String	getChannelTypeId() Get the value of channelTypeId.
String	getClassName() Get the value of className implementing this channel.
String	getDescription() Get the value of description.
String	getFunctionalName() Get the value of functionalName.
Map	getParameterMap() Returns an entire mapping of parameters.
Enumeration	getParameterNames() Obtain a set of channel parameter names.
boolean	getParameterOverrideValue(String parameterName) Obtain a channel parameter override value.
String	getParameterValue(String parameterName) Obtain a channel parameter value.
Collection	getParameterValues() Obtain values of all existing channel parameters.
long	getTimeout() Get the value of channel timeout in milliseconds.
String	getTitle() Get the value of title.
int	getType() Returns a type of the node, could be FOLDER or CHANNEL integer constant.
Element	getXML(Document root) Creates a org.w3c.dom.Element representation of the current channel.
boolean	hasAbout() Determine if the channel supports "about" action.
boolean	hasHelp() Determine if the channel supports "help" action.
boolean	hasParameters() Determine if the channel has any parameters.
boolean	isEditable() Determine if the channel is editable.
boolean	isPortlet() Get the channel type for portlet / not portlet
boolean	isSecure() Get the value of secure setting.
int	numberOfParameters() Determines the number of existing channel parameters.
String	remove(String parameterName) Remove a channel parameter.
void	resetParameter(String parameterName) Reset a channel parameter value.
void	setChannelPublishId(String v) Set the value of channelPublishId for this channel.
void	setChannelSubscribeId(String v) Set the value of channelSubscribeId.
void	setChannelTypeId(String v) Set the value of channelTypeId.
void	setClassName(String v) Set the value of className implementing this channel.
void	setDescription(String v) Set the value of description.
void	setEditable(boolean v) Specify whether the channel is editable.
void	setFunctionalName(String v) Set the value of functionalName.
void	setHasAbout(boolean v) Specify whether the channel supports "about" action.
void	setHasHelp(boolean v) Specify whether the channel supports "help" action.
void	setIsSecure(boolean secure) Set the value of channel secure setting.
void	setParameterOverride(String parameterName, boolean canOverride) Set parameter override flag.
String	setParameterValue(String parameterName, String parameterValue) Set a channel parameter value.
void	setTimeout(long v) Set the value of channel timeout in milliseconds.
void	setTitle(String v) Set the value of title.
String	toString()

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

createUserLayoutNodeDescription, 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

UserLayoutChannelDescription

public UserLayoutChannelDescription()

UserLayoutChannelDescription

public UserLayoutChannelDescription(IUserLayoutChannelDescription d)

UserLayoutChannelDescription

public UserLayoutChannelDescription(IChannelDefinition definition)

Construct channel information from a Channel Definition object.

Parameters:

definition -

UserLayoutChannelDescription

public UserLayoutChannelDescription(Element xmlNode)
                             throws PortalException

Reconstruct channel information from an xml Element

Parameters:

xmlNode - a user layout channel Element value

Throws:

PortalException - if xml is malformed

Method Detail

hasAbout

public boolean hasAbout()

Determine if the channel supports "about" action.

Specified by:

hasAbout in interface IUserLayoutChannelDescription

Returns:

value of hasAbout.

setHasAbout

public void setHasAbout(boolean v)

Specify whether the channel supports "about" action.

Specified by:

setHasAbout in interface IUserLayoutChannelDescription

Parameters:

v - Value to assign to hasAbout.

hasHelp

public boolean hasHelp()

Determine if the channel supports "help" action.

Specified by:

hasHelp in interface IUserLayoutChannelDescription

Returns:

value of hasHelp.

setHasHelp

public void setHasHelp(boolean v)

Specify whether the channel supports "help" action.

Specified by:

setHasHelp in interface IUserLayoutChannelDescription

Parameters:

v - Value to assign to hasHelp.

isEditable

public boolean isEditable()

Determine if the channel is editable.

Specified by:

isEditable in interface IUserLayoutChannelDescription

Returns:

value of editable.

setEditable

public void setEditable(boolean v)

Specify whether the channel is editable.

Specified by:

setEditable in interface IUserLayoutChannelDescription

Parameters:

v - Value to assign to editable.

getTimeout

public long getTimeout()

Get the value of channel timeout in milliseconds.

Specified by:

getTimeout in interface IUserLayoutChannelDescription

Returns:

value of timeout.

setTimeout

public void setTimeout(long v)

Set the value of channel timeout in milliseconds.

Specified by:

setTimeout in interface IUserLayoutChannelDescription

Parameters:

v - Value to assign to timeout.

isSecure

public boolean isSecure()

Get the value of secure setting.

Specified by:

isSecure in interface IUserLayoutChannelDescription

Returns:

value of secure.

setIsSecure

public void setIsSecure(boolean secure)

Set the value of channel secure setting.

Specified by:

setIsSecure in interface IUserLayoutChannelDescription

Parameters:

secure - Value to assign to secure

isPortlet

public boolean isPortlet()

Get the channel type for portlet / not portlet

Specified by:

isPortlet in interface IUserLayoutChannelDescription

Returns:

the channel type for portlet / not portlet

getFunctionalName

public String getFunctionalName()

Get the value of functionalName.

Specified by:

getFunctionalName in interface IUserLayoutChannelDescription

Returns:

value of functionalName.

setFunctionalName

public void setFunctionalName(String v)

Set the value of functionalName.

Specified by:

setFunctionalName in interface IUserLayoutChannelDescription

Parameters:

v - Value to assign to functionalName.

getChannelSubscribeId

public String getChannelSubscribeId()

Get the value of channelSubscribeId.

Specified by:

getChannelSubscribeId in interface IUserLayoutChannelDescription

Returns:

value of channelSubscribeId.

setChannelSubscribeId

public void setChannelSubscribeId(String v)

Set the value of channelSubscribeId.

Specified by:

setChannelSubscribeId in interface IUserLayoutChannelDescription

Parameters:

v - Value to assign to channelSubscribeId.

getChannelTypeId

public String getChannelTypeId()

Get the value of channelTypeId.

Specified by:

getChannelTypeId in interface IUserLayoutChannelDescription

Returns:

value of channelTypeId.

setChannelTypeId

public void setChannelTypeId(String v)

Set the value of channelTypeId.

Specified by:

setChannelTypeId in interface IUserLayoutChannelDescription

Parameters:

v - Value to assign to channelTypeId.

getChannelPublishId

public String getChannelPublishId()

Get the value of channelPublishId for this channel.

Specified by:

getChannelPublishId in interface IUserLayoutChannelDescription

Returns:

value of channelPublishId.

setChannelPublishId

public void setChannelPublishId(String v)

Set the value of channelPublishId for this channel.

Specified by:

setChannelPublishId in interface IUserLayoutChannelDescription

Parameters:

v - Value to assign to channelPublishId.

getClassName

public String getClassName()

Get the value of className implementing this channel.

Specified by:

getClassName in interface IUserLayoutChannelDescription

Returns:

value of className.

setClassName

public void setClassName(String v)

Set the value of className implementing this channel.

Specified by:

setClassName in interface IUserLayoutChannelDescription

Parameters:

v - Value to assign to className.

getTitle

public String getTitle()

Get the value of title.

Specified by:

getTitle in interface IUserLayoutChannelDescription

Returns:

value of title.

setTitle

public void setTitle(String v)

Set the value of title.

Specified by:

setTitle in interface IUserLayoutChannelDescription

Parameters:

v - Value to assign to title.

getDescription

public String getDescription()

Get the value of description.

Specified by:

getDescription in interface IUserLayoutChannelDescription

Returns:

value of description.

setDescription

public void setDescription(String v)

Set the value of description.

Specified by:

setDescription in interface IUserLayoutChannelDescription

Parameters:

v - Value to assign to description.

setParameterValue

public String setParameterValue(String parameterName,
                                String parameterValue)

Set a channel parameter value.

Specified by:

setParameterValue in interface IUserLayoutChannelDescription

Parameters:

parameterValue - a String value

parameterName - a String value

Returns:

a String value that was set.

resetParameter

public void resetParameter(String parameterName)
                    throws PortalException

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

Parameters:

parameterName - a String value

Throws:

PortalException

getParameterValue

public String getParameterValue(String parameterName)

Obtain a channel parameter value.

Specified by:

getParameterValue in interface IUserLayoutChannelDescription

Parameters:

parameterName - a String value

Returns:

a String value

getParameterOverrideValue

public boolean getParameterOverrideValue(String parameterName)

Obtain a channel parameter override value.

Specified by:

getParameterOverrideValue in interface IUserLayoutChannelDescription

Parameters:

parameterName - a String value

Returns:

a boolean value

getParameterValues

public Collection getParameterValues()

Obtain values of all existing channel parameters.

Specified by:

getParameterValues in interface IUserLayoutChannelDescription

Returns:

a Collection of String parameter values.

numberOfParameters

public int numberOfParameters()

Determines the number of existing channel parameters.

Specified by:

numberOfParameters in interface IUserLayoutChannelDescription

Returns:

an int value

clearParameters

public void clearParameters()

Clears all of the channel parameters.

Specified by:

clearParameters in interface IUserLayoutChannelDescription

canOverrideParameter

public boolean canOverrideParameter(String parameterName)

Determine if a given parameter can be overriden by the user. (defaults to true)

Specified by:

canOverrideParameter in interface IUserLayoutChannelDescription

Parameters:

parameterName - a String value

Returns:

a boolean value

setParameterOverride

public void setParameterOverride(String parameterName,
                                 boolean canOverride)

Set parameter override flag.

Specified by:

setParameterOverride in interface IUserLayoutChannelDescription

Parameters:

parameterName - a String value

canOverride - a boolean flag.

remove

public String remove(String parameterName)

Remove a channel parameter.

Specified by:

remove in interface IUserLayoutChannelDescription

Parameters:

parameterName - a String parameter name.

Returns:

an old parameter value.

getParameterNames

public Enumeration getParameterNames()

Obtain a set of channel parameter names.

Specified by:

getParameterNames in interface IUserLayoutChannelDescription

Returns:

a Set of String parameter names.

getParameterMap

public Map getParameterMap()

Returns an entire mapping of parameters.

Specified by:

getParameterMap in interface IUserLayoutChannelDescription

Returns:

a Map of parameter names on parameter values.

hasParameters

public boolean hasParameters()

Determine if the channel has any parameters.

Specified by:

hasParameters in interface IUserLayoutChannelDescription

Returns:

a boolean value

containsParameter

public boolean containsParameter(String parameterName)

Determines if a certain parameter name is present.

Specified by:

containsParameter in interface IUserLayoutChannelDescription

Parameters:

parameterName - a String parameter name.

Returns:

a boolean value

getXML

public Element getXML(Document root)

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

Specified by:

getXML in interface IUserLayoutChannelDescription

Specified by:

getXML in interface IUserLayoutNodeDescription

Specified by:

getXML in class UserLayoutNodeDescription

Parameters:

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

Returns:

a Node value

addParameterChildren

public void addParameterChildren(Element node,
                                 Document root)

addNodeAttributes

public void addNodeAttributes(Element node)

Description copied from class: UserLayoutNodeDescription

Add all of common node attributes to the Element.

Specified by:

addNodeAttributes in interface IUserLayoutNodeDescription

Overrides:

addNodeAttributes in class UserLayoutNodeDescription

Parameters:

node - an Element value

getType

public int getType()

Returns a type of the node, could be FOLDER or CHANNEL integer constant.

Specified by:

getType in interface IUserLayoutNodeDescription

Specified by:

getType in class UserLayoutNodeDescription

Returns:

a type

toString

public String toString()

Overrides:

toString in class UserLayoutNodeDescription