|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An interface managing information contained in a user layout channel node.
Field Summary |
Fields inherited from interface org.jasig.portal.layout.IUserLayoutNodeDescription |
CHANNEL, FOLDER |
Method Summary | |
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. |
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. |
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 v)
Set the value of secure. |
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 interface org.jasig.portal.layout.IUserLayoutNodeDescription |
addNodeAttributes, getId, getName, getType, isHidden, isImmutable, isUnremovable, setHidden, setId, setImmutable, setName, setUnremovable |
Method Detail |
public boolean hasAbout()
public void setHasAbout(boolean v)
v
- Value to assign to hasAbout.public boolean hasHelp()
public void setHasHelp(boolean v)
v
- Value to assign to hasHelp.public boolean isEditable()
public void setEditable(boolean v)
v
- Value to assign to editable.public long getTimeout()
public void setTimeout(long v)
v
- Value to assign to timeout.public java.lang.String getFunctionalName()
public void setFunctionalName(java.lang.String v)
v
- Value to assign to functionalName.public java.lang.String getChannelSubscribeId()
public void setChannelSubscribeId(java.lang.String v)
v
- Value to assign to channelSubscribeId.public java.lang.String getChannelTypeId()
public void setChannelTypeId(java.lang.String v)
v
- Value to assign to channelTypeId.public java.lang.String getChannelPublishId()
public void setChannelPublishId(java.lang.String v)
v
- Value to assign to channelPublishId.public java.lang.String getClassName()
public void setClassName(java.lang.String v)
v
- Value to assign to className.public java.lang.String getTitle()
public void setTitle(java.lang.String v)
v
- Value to assign to title.public java.lang.String getDescription()
public void setDescription(java.lang.String v)
v
- Value to assign to description.public boolean isSecure()
public void setIsSecure(boolean v)
v
- Value to assign to secure.public java.lang.String setParameterValue(java.lang.String parameterName, java.lang.String parameterValue)
parameterValue
- a String
valueparameterName
- a String
value
String
value that was set.public java.lang.String getParameterValue(java.lang.String parameterName)
parameterName
- a String
value
String
valuepublic boolean getParameterOverrideValue(java.lang.String parameterName)
parameterName
- a String
value
boolean
valuepublic java.util.Collection getParameterValues()
Collection
of String
parameter values.public int numberOfParameters()
int
valuepublic void clearParameters()
public boolean canOverrideParameter(java.lang.String parameterName)
parameterName
- a String
value
boolean
valuepublic void setParameterOverride(java.lang.String parameterName, boolean canOverride)
parameterName
- a String
valuecanOverride
- a boolean
flag.public java.lang.String remove(java.lang.String parameterName)
parameterName
- a String
parameter name.
public java.util.Enumeration getParameterNames()
Set
of String
parameter names.public java.util.Map getParameterMap()
Map
of parameter names on parameter values.public boolean hasParameters()
boolean
valuepublic boolean containsParameter(java.lang.String parameterName)
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 IUserLayoutNodeDescription
root
- a Document
for which the Element
should be created.
Node
value
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |