water.api

Class RequestArguments.Bool

java.lang.Object

water.Iced

water.api.RequestArguments.Argument<java.lang.Boolean>

water.api.RequestArguments.InputCheckBox

water.api.RequestArguments.Bool

All Implemented Interfaces:

java.lang.Cloneable, Request.Filter, Freezable

Direct Known Subclasses:

RequestArguments.ClassifyBool, RequestArguments.DRFCopyDataBool

Enclosing class:

RequestArguments

public class RequestArguments.Bool
extends RequestArguments.InputCheckBox

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	_description

Fields inherited from class water.api.RequestArguments.InputCheckBox

_defaultValue

Fields inherited from class water.api.RequestArguments.Argument

_displayName, _field, _gridable, _hideInQuery, _mustExist, _name, _prerequisites, _readOnly, _requestHelp, _required, _validator

Constructor Summary

Constructors

Constructor and Description
RequestArguments.Bool(java.lang.String name, boolean defaultValue, java.lang.String description)

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	queryDescription() Returns the query description.
void	setValue(boolean b)

Methods inherited from class water.api.RequestArguments.InputCheckBox

defaultValue, jsRefresh, jsValue, parse, queryElement

Methods inherited from class water.api.RequestArguments.Argument

addPrerequisite, check, disable, disable, disabled, errors, getDisplayName, getName, jsAddons, originalValue, query, queryAddons, queryComment, record, refreshOnChange, requestHelp, reset, run, setRefreshOnChange, specified, valid, value

Methods inherited from class water.Iced

clone, frozenType, init, newInstance, read, toDocField, write, writeJSON, writeJSONFields

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_description

public final java.lang.String _description

Constructor Detail

RequestArguments.Bool

public RequestArguments.Bool(java.lang.String name,
                     boolean defaultValue,
                     java.lang.String description)

Method Detail

setValue

public void setValue(boolean b)

queryDescription

protected java.lang.String queryDescription()

Description copied from class: RequestArguments.Argument

Returns the query description. This is a concise description of a correct value for the argument. generally used as a placeholder in the html query elements.

Specified by:

queryDescription in class RequestArguments.Argument<java.lang.Boolean>