|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.ChannelParameter
public class ChannelParameter
Describes a channel definition parameter. A channel can have zero or more parameters.
Field Summary | |
---|---|
(package private) java.lang.String |
descr
A description of the parameter. |
(package private) java.lang.String |
name
The name of the parameter. |
(package private) boolean |
override
True if the default value may be overridden. |
(package private) java.lang.String |
value
A default value for the parameter. |
Constructor Summary | |
---|---|
ChannelParameter(java.lang.String name,
java.lang.String value,
boolean override)
Instantiate a ChannelParameter with a particular name, default value, and indication of whether it can be overridden. |
|
ChannelParameter(java.lang.String name,
java.lang.String value,
java.lang.String override)
Deprecated. resolve override to a boolean and use the other constructor |
Method Summary | |
---|---|
java.lang.String |
getDescription()
Get a description of this channel parameter. |
java.lang.String |
getName()
Get the name of the channel parameter. |
boolean |
getOverride()
Get whether the value of this channel parameter may be overridden. |
java.lang.String |
getValue()
Get the default value of the channel parameter. |
void |
setDescription(java.lang.String descr)
Set the description of this channel parameter. |
void |
setName(java.lang.String name)
Set the name of the channel parameter. |
void |
setOverride(boolean override)
Set whether this channel parameter may be overridden. |
void |
setValue(java.lang.String value)
Set the default value for this channel parameter. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
java.lang.String name
java.lang.String value
boolean override
java.lang.String descr
Constructor Detail |
---|
public ChannelParameter(java.lang.String name, java.lang.String value, java.lang.String override)
name
- - the name of the channel parametervalue
- - the value of the channel parameteroverride
- - "Y" if overridable, "N" otherwise.public ChannelParameter(java.lang.String name, java.lang.String value, boolean override)
name
- name of the channel parameter.value
- default value for the parameter.override
- true if the default value may be overridden.Method Detail |
---|
public java.lang.String getName()
public java.lang.String getValue()
public boolean getOverride()
public java.lang.String getDescription()
public void setName(java.lang.String name)
name
- the name of the channel parameterpublic void setValue(java.lang.String value)
value
- the default value for this channel parameter.public void setOverride(boolean override)
override
- true if the channel parameter may be overridden.public void setDescription(java.lang.String descr)
descr
- description of this channel parameter.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |