| java.lang.Object org.jasig.portal.ChannelParameter
ChannelParameter | public class ChannelParameter (Code) | | Describes a channel definition parameter.
A channel can have zero or more parameters.
|
Field Summary | |
String | descr A description of the parameter. | String | name The name of the parameter. | boolean | override True if the default value may be overridden. | String | value A default value for the parameter. |
Constructor Summary | |
public | ChannelParameter(String name, String value, String override) Instantiate a ChannelParameter with a particular name, value, and
indication of whether it can be overridden. | public | ChannelParameter(String name, String value, boolean override) Instantiate a ChannelParameter with a particular name, default value,
and indication of whether it can be overridden. |
Method Summary | |
public String | getDescription() Get a description of this channel parameter. | public String | getName() Get the name of the channel parameter. | public boolean | getOverride() Get whether the value of this channel parameter may be overridden. | public String | getValue() Get the default value of the channel parameter. | public void | setDescription(String descr) Set the description of this channel parameter. | public void | setName(String name) Set the name of the channel parameter. | public void | setOverride(boolean override) Set whether this channel parameter may be overridden. | public void | setValue(String value) Set the default value for this channel parameter. |
override | boolean override(Code) | | True if the default value may be overridden.
|
ChannelParameter | public ChannelParameter(String name, String value, String override)(Code) | | Instantiate a ChannelParameter with a particular name, value, and
indication of whether it can be overridden.
Parameters: name - - the name of the channel parameter Parameters: value - - the value of the channel parameter Parameters: override - - "Y" if overridable, "N" otherwise. |
ChannelParameter | public ChannelParameter(String name, String value, boolean override)(Code) | | Instantiate a ChannelParameter with a particular name, default value,
and indication of whether it can be overridden.
Parameters: name - name of the channel parameter. Parameters: value - default value for the parameter. Parameters: override - true if the default value may be overridden. |
getDescription | public String getDescription()(Code) | | Get a description of this channel parameter.
a description of this channel parameter. |
getName | public String getName()(Code) | | Get the name of the channel parameter.
the name of the channel parameter. |
getOverride | public boolean getOverride()(Code) | | Get whether the value of this channel parameter may be overridden.
true if value may be overridden, false otherwise. |
getValue | public String getValue()(Code) | | Get the default value of the channel parameter.
the default value for this channel parameter. |
setDescription | public void setDescription(String descr)(Code) | | Set the description of this channel parameter.
Parameters: descr - description of this channel parameter. |
setName | public void setName(String name)(Code) | | Set the name of the channel parameter.
Parameters: name - the name of the channel parameter |
setOverride | public void setOverride(boolean override)(Code) | | Set whether this channel parameter may be overridden.
Parameters: override - true if the channel parameter may be overridden. |
setValue | public void setValue(String value)(Code) | | Set the default value for this channel parameter.
Parameters: value - the default value for this channel parameter. |
|
|