|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.layout.UserLayoutNodeDescription
org.jasig.portal.layout.UserLayoutChannelDescription
A class managing information contained in a user layout channel node.
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 |
public UserLayoutChannelDescription()
public UserLayoutChannelDescription(IUserLayoutChannelDescription d)
public UserLayoutChannelDescription(org.w3c.dom.Element xmlNode) throws PortalException
Element
xmlNode
- a user layout channel Element
value
PortalException
- if xml is malformedMethod Detail |
public boolean hasAbout()
hasAbout
in interface IUserLayoutChannelDescription
public void setHasAbout(boolean v)
setHasAbout
in interface IUserLayoutChannelDescription
v
- Value to assign to hasAbout.public boolean hasHelp()
hasHelp
in interface IUserLayoutChannelDescription
public void setHasHelp(boolean v)
setHasHelp
in interface IUserLayoutChannelDescription
v
- Value to assign to hasHelp.public boolean isEditable()
isEditable
in interface IUserLayoutChannelDescription
public void setEditable(boolean v)
setEditable
in interface IUserLayoutChannelDescription
v
- Value to assign to editable.public long getTimeout()
getTimeout
in interface IUserLayoutChannelDescription
public void setTimeout(long v)
setTimeout
in interface IUserLayoutChannelDescription
v
- Value to assign to timeout.public boolean isSecure()
isSecure
in interface IUserLayoutChannelDescription
public void setIsSecure(boolean secure)
setIsSecure
in interface IUserLayoutChannelDescription
secure
- Value to assign to securepublic java.lang.String getFunctionalName()
getFunctionalName
in interface IUserLayoutChannelDescription
public void setFunctionalName(java.lang.String v)
setFunctionalName
in interface IUserLayoutChannelDescription
v
- Value to assign to functionalName.public java.lang.String getChannelSubscribeId()
getChannelSubscribeId
in interface IUserLayoutChannelDescription
public void setChannelSubscribeId(java.lang.String v)
setChannelSubscribeId
in interface IUserLayoutChannelDescription
v
- Value to assign to channelSubscribeId.public java.lang.String getChannelTypeId()
getChannelTypeId
in interface IUserLayoutChannelDescription
public void setChannelTypeId(java.lang.String v)
setChannelTypeId
in interface IUserLayoutChannelDescription
v
- Value to assign to channelTypeId.public java.lang.String getChannelPublishId()
getChannelPublishId
in interface IUserLayoutChannelDescription
public void setChannelPublishId(java.lang.String v)
setChannelPublishId
in interface IUserLayoutChannelDescription
v
- Value to assign to channelPublishId.public java.lang.String getClassName()
getClassName
in interface IUserLayoutChannelDescription
public void setClassName(java.lang.String v)
setClassName
in interface IUserLayoutChannelDescription
v
- Value to assign to className.public java.lang.String getTitle()
getTitle
in interface IUserLayoutChannelDescription
public void setTitle(java.lang.String v)
setTitle
in interface IUserLayoutChannelDescription
v
- Value to assign to title.public java.lang.String getDescription()
getDescription
in interface IUserLayoutChannelDescription
public void setDescription(java.lang.String v)
setDescription
in interface IUserLayoutChannelDescription
v
- Value to assign to description.public java.lang.String setParameterValue(java.lang.String parameterName, java.lang.String parameterValue)
setParameterValue
in interface IUserLayoutChannelDescription
parameterValue
- a String
valueparameterName
- a String
value
String
value that was set.public java.lang.String getParameterValue(java.lang.String parameterName)
getParameterValue
in interface IUserLayoutChannelDescription
parameterName
- a String
value
String
valuepublic boolean getParameterOverrideValue(java.lang.String parameterName)
getParameterOverrideValue
in interface IUserLayoutChannelDescription
parameterName
- a String
value
boolean
valuepublic java.util.Collection getParameterValues()
getParameterValues
in interface IUserLayoutChannelDescription
Collection
of String
parameter values.public int numberOfParameters()
numberOfParameters
in interface IUserLayoutChannelDescription
int
valuepublic void clearParameters()
clearParameters
in interface IUserLayoutChannelDescription
public boolean canOverrideParameter(java.lang.String parameterName)
canOverrideParameter
in interface IUserLayoutChannelDescription
parameterName
- a String
value
boolean
valuepublic void setParameterOverride(java.lang.String parameterName, boolean canOverride)
setParameterOverride
in interface IUserLayoutChannelDescription
parameterName
- a String
valuecanOverride
- a boolean
flag.public java.lang.String remove(java.lang.String parameterName)
remove
in interface IUserLayoutChannelDescription
parameterName
- a String
parameter name.
public java.util.Enumeration getParameterNames()
getParameterNames
in interface IUserLayoutChannelDescription
Set
of String
parameter names.public java.util.Map getParameterMap()
getParameterMap
in interface IUserLayoutChannelDescription
Map
of parameter names on parameter values.public boolean hasParameters()
hasParameters
in interface IUserLayoutChannelDescription
boolean
valuepublic boolean containsParameter(java.lang.String parameterName)
containsParameter
in interface IUserLayoutChannelDescription
parameterName
- a String
parameter name.
boolean
valuepublic org.w3c.dom.Element getXML(org.w3c.dom.Document root)
org.w3c.dom.Element
representation of the current channel.
getXML
in interface IUserLayoutChannelDescription
getXML
in class UserLayoutNodeDescription
root
- a Document
for which the Element
should be created.
Node
valuepublic void addNodeAttributes(org.w3c.dom.Element node)
UserLayoutNodeDescription
Element
.
addNodeAttributes
in interface IUserLayoutNodeDescription
addNodeAttributes
in class UserLayoutNodeDescription
node
- an Element
valuepublic int getType()
getType
in interface IUserLayoutNodeDescription
getType
in class UserLayoutNodeDescription
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |