uPortal 2.4.1
API Documentation

org.jasig.portal.layout
Class UserLayoutChannelDescription

java.lang.Object
  extended byorg.jasig.portal.layout.UserLayoutNodeDescription
      extended byorg.jasig.portal.layout.UserLayoutChannelDescription
All Implemented Interfaces:
IUserLayoutChannelDescription, IUserLayoutNodeDescription
Direct Known Subclasses:
ALChannelDescription

public class UserLayoutChannelDescription
extends UserLayoutNodeDescription
implements IUserLayoutChannelDescription

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

Version:
1.0
Author:
Peter Kharchenko

Field Summary
 
Fields inherited from interface org.jasig.portal.layout.IUserLayoutNodeDescription
CHANNEL, FOLDER
 
Constructor Summary
UserLayoutChannelDescription()
           
UserLayoutChannelDescription(org.w3c.dom.Element xmlNode)
          Reconstruct channel information from an xml Element
UserLayoutChannelDescription(IUserLayoutChannelDescription d)
           
 
Method Summary
 void addNodeAttributes(org.w3c.dom.Element node)
          Add all of common node attributes to the Element.
 boolean canOverrideParameter(java.lang.String parameterName)
          Determine if a given parameter can be overriden by the user.
 void clearParameters()
          Clears all of the channel parameters.
 boolean containsParameter(java.lang.String parameterName)
          Determines if a certain parameter name is present.
 java.lang.String getChannelPublishId()
          Get the value of channelPublishId for this channel.
 java.lang.String getChannelSubscribeId()
          Get the value of channelSubscribeId.
 java.lang.String getChannelTypeId()
          Get the value of channelTypeId.
 java.lang.String getClassName()
          Get the value of className implementing this channel.
 java.lang.String getDescription()
          Get the value of description.
 java.lang.String getFunctionalName()
          Get the value of functionalName.
 java.util.Map getParameterMap()
          Returns an entire mapping of parameters.
 java.util.Enumeration getParameterNames()
          Obtain a set of channel parameter names.
 boolean getParameterOverrideValue(java.lang.String parameterName)
          Obtain a channel parameter override value.
 java.lang.String getParameterValue(java.lang.String parameterName)
          Obtain a channel parameter value.
 java.util.Collection getParameterValues()
          Obtain values of all existing channel parameters.
 long getTimeout()
          Get the value of channel timeout in milliseconds.
 java.lang.String getTitle()
          Get the value of title.
 int getType()
          Returns a type of the node, could be FOLDER or CHANNEL integer constant.
 org.w3c.dom.Element getXML(org.w3c.dom.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 isSecure()
          Get the value of secure setting.
 int numberOfParameters()
          Determines the number of existing channel parameters.
 java.lang.String remove(java.lang.String parameterName)
          Remove a channel parameter.
 void setChannelPublishId(java.lang.String v)
          Set the value of channelPublishId for this channel.
 void setChannelSubscribeId(java.lang.String v)
          Set the value of channelSubscribeId.
 void setChannelTypeId(java.lang.String v)
          Set the value of channelTypeId.
 void setClassName(java.lang.String v)
          Set the value of className implementing this channel.
 void setDescription(java.lang.String v)
          Set the value of description.
 void setEditable(boolean v)
          Specify whether the channel is editable.
 void setFunctionalName(java.lang.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(java.lang.String parameterName, boolean canOverride)
          Set parameter override flag.
 java.lang.String setParameterValue(java.lang.String parameterName, java.lang.String parameterValue)
          Set a channel parameter value.
 void setTimeout(long v)
          Set the value of channel timeout in milliseconds.
 void setTitle(java.lang.String v)
          Set the value of title.
 
Methods inherited from class org.jasig.portal.layout.UserLayoutNodeDescription
createUserLayoutNodeDescription, getId, getName, isHidden, isImmutable, isUnremovable, setHidden, setId, setImmutable, setName, setUnremovable
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jasig.portal.layout.IUserLayoutNodeDescription
getId, getName, isHidden, isImmutable, isUnremovable, setHidden, setId, setImmutable, setName, setUnremovable
 

Constructor Detail

UserLayoutChannelDescription

public UserLayoutChannelDescription()

UserLayoutChannelDescription

public UserLayoutChannelDescription(IUserLayoutChannelDescription d)

UserLayoutChannelDescription

public UserLayoutChannelDescription(org.w3c.dom.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

getFunctionalName

public java.lang.String getFunctionalName()
Get the value of functionalName.

Specified by:
getFunctionalName in interface IUserLayoutChannelDescription
Returns:
value of functionalName.

setFunctionalName

public void setFunctionalName(java.lang.String v)
Set the value of functionalName.

Specified by:
setFunctionalName in interface IUserLayoutChannelDescription
Parameters:
v - Value to assign to functionalName.

getChannelSubscribeId

public java.lang.String getChannelSubscribeId()
Get the value of channelSubscribeId.

Specified by:
getChannelSubscribeId in interface IUserLayoutChannelDescription
Returns:
value of channelSubscribeId.

setChannelSubscribeId

public void setChannelSubscribeId(java.lang.String v)
Set the value of channelSubscribeId.

Specified by:
setChannelSubscribeId in interface IUserLayoutChannelDescription
Parameters:
v - Value to assign to channelSubscribeId.

getChannelTypeId

public java.lang.String getChannelTypeId()
Get the value of channelTypeId.

Specified by:
getChannelTypeId in interface IUserLayoutChannelDescription
Returns:
value of channelTypeId.

setChannelTypeId

public void setChannelTypeId(java.lang.String v)
Set the value of channelTypeId.

Specified by:
setChannelTypeId in interface IUserLayoutChannelDescription
Parameters:
v - Value to assign to channelTypeId.

getChannelPublishId

public java.lang.String getChannelPublishId()
Get the value of channelPublishId for this channel.

Specified by:
getChannelPublishId in interface IUserLayoutChannelDescription
Returns:
value of channelPublishId.

setChannelPublishId

public void setChannelPublishId(java.lang.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 java.lang.String getClassName()
Get the value of className implementing this channel.

Specified by:
getClassName in interface IUserLayoutChannelDescription
Returns:
value of className.

setClassName

public void setClassName(java.lang.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 java.lang.String getTitle()
Get the value of title.

Specified by:
getTitle in interface IUserLayoutChannelDescription
Returns:
value of title.

setTitle

public void setTitle(java.lang.String v)
Set the value of title.

Specified by:
setTitle in interface IUserLayoutChannelDescription
Parameters:
v - Value to assign to title.

getDescription

public java.lang.String getDescription()
Get the value of description.

Specified by:
getDescription in interface IUserLayoutChannelDescription
Returns:
value of description.

setDescription

public void setDescription(java.lang.String v)
Set the value of description.

Specified by:
setDescription in interface IUserLayoutChannelDescription
Parameters:
v - Value to assign to description.

setParameterValue

public java.lang.String setParameterValue(java.lang.String parameterName,
                                          java.lang.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.

getParameterValue

public java.lang.String getParameterValue(java.lang.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(java.lang.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 java.util.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(java.lang.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(java.lang.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 java.lang.String remove(java.lang.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 java.util.Enumeration getParameterNames()
Obtain a set of channel parameter names.

Specified by:
getParameterNames in interface IUserLayoutChannelDescription
Returns:
a Set of String parameter names.

getParameterMap

public java.util.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(java.lang.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 org.w3c.dom.Element getXML(org.w3c.dom.Document root)
Creates a org.w3c.dom.Element representation of the current channel.

Specified by:
getXML in interface IUserLayoutChannelDescription
Specified by:
getXML in class UserLayoutNodeDescription
Parameters:
root - a Document for which the Element should be created.
Returns:
a Node value

addNodeAttributes

public void addNodeAttributes(org.w3c.dom.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

uPortal 2.4.1
API Documentation