Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jasig.portal
Class ChannelParameter

    java.lang.Object
      org.jasig.portal.ChannelParameter

    public class ChannelParameter

extends java.lang.Object

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

### name

    java.lang.String name

  The name of the parameter.

### value

    java.lang.String value

  A default value for the parameter.

### override

    boolean override

  True if the default value may be overridden.

### descr

    java.lang.String descr

  A description of the parameter.

Constructor Detail

### ChannelParameter

    public ChannelParameter(java.lang.String name,
                            java.lang.String value,
                            java.lang.String override)

  Deprecated. resolve override to a boolean and use the other constructor

  Instantiate a ChannelParameter with a particular name, value, and indication of whether it can be overridden.

  Parameters:
    `name` - - the name of the channel parameter
    `value` - - the value of the channel parameter
    `override` - - "Y" if overridable, "N" otherwise.

### ChannelParameter

    public 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.

  Parameters:
    `name` - name of the channel parameter.
    `value` - default value for the parameter.
    `override` - true if the default value may be overridden.

Method Detail

### getName

    public java.lang.String getName()

  Get the name of the channel parameter.

  Returns:
    the name of the channel parameter.

### getValue

    public java.lang.String getValue()

  Get the default value of the channel parameter.

  Returns:
    the default value for this channel parameter.

### getOverride

    public boolean getOverride()

  Get whether the value of this channel parameter may be overridden.

  Returns:
    true if value may be overridden, false otherwise.

### getDescription

    public java.lang.String getDescription()

  Get a description of this channel parameter.

  Returns:
    a description of this channel parameter.

### setName

    public void setName(java.lang.String name)

  Set the name of the channel parameter.

  Parameters:
    `name` - the name of the channel parameter

### setValue

    public void setValue(java.lang.String value)

  Set the default value for this channel parameter.

  Parameters:
    `value` - the default value for this channel parameter.

### setOverride

    public void setOverride(boolean override)

  Set whether this channel parameter may be overridden.

  Parameters:
    `override` - true if the channel parameter may be overridden.

### setDescription

    public void setDescription(java.lang.String descr)

  Set the description of this channel parameter.

  Parameters:
    `descr` - description of this channel parameter.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD