@Immutable
public static class WebService.Param
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ASCENDING |
static java.lang.String |
FACETS |
static java.lang.String |
FIELDS |
static java.lang.String |
PAGE |
static java.lang.String |
PAGE_SIZE |
static java.lang.String |
SELECTED |
static java.lang.String |
SORT |
static java.lang.String |
TEXT_QUERY |
Modifier | Constructor and Description |
---|---|
protected |
Param(WebService.Action action,
WebService.NewParam newParam) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
defaultValue() |
java.lang.String |
deprecatedKey() |
java.lang.String |
deprecatedKeySince() |
java.lang.String |
deprecatedSince() |
java.lang.String |
description() |
java.lang.String |
exampleValue() |
boolean |
isInternal()
Is the parameter internal ?
|
boolean |
isRequired()
Is the parameter required or optional ?
|
java.lang.String |
key() |
java.lang.Integer |
maximumLength()
Specify the maximum length of the value used in this parameter
|
java.lang.Integer |
maximumValue()
Specify the maximum value of the numeric variable used in this parameter
|
java.lang.Integer |
maxValuesAllowed()
Specify the maximum number of values allowed when using
Request.multiParam(String) |
java.lang.Integer |
minimumLength()
Specify the minimum length of the value used in this parameter
|
java.util.Set<java.lang.String> |
possibleValues() |
java.lang.String |
since() |
java.lang.String |
toString() |
public static final java.lang.String TEXT_QUERY
public static final java.lang.String PAGE
public static final java.lang.String PAGE_SIZE
public static final java.lang.String FIELDS
public static final java.lang.String SORT
public static final java.lang.String ASCENDING
public static final java.lang.String FACETS
public static final java.lang.String SELECTED
protected Param(WebService.Action action, WebService.NewParam newParam)
public java.lang.String key()
@CheckForNull public java.lang.String since()
@CheckForNull public java.lang.String deprecatedSince()
@CheckForNull public java.lang.String deprecatedKey()
@CheckForNull public java.lang.String deprecatedKeySince()
@CheckForNull public java.lang.String description()
@CheckForNull public java.lang.String exampleValue()
public boolean isRequired()
public boolean isInternal()
WebService.NewParam.setInternal(boolean)
@CheckForNull public java.util.Set<java.lang.String> possibleValues()
@CheckForNull public java.lang.String defaultValue()
public java.lang.Integer maxValuesAllowed()
Request.multiParam(String)
@CheckForNull public java.lang.Integer maximumLength()
@CheckForNull public java.lang.Integer minimumLength()
@CheckForNull public java.lang.Integer maximumValue()
public java.lang.String toString()
toString
in class java.lang.Object