ar.com.jmfsg.documentation.model
Class Field

java.lang.Object
  ar.com.jmfsg.documentation.model.Field

public class Field
extends Object

Field Summary

List<Field>	children Sub elements of this field.
String	defaultValue Only valid for options and filters. The value that is taken by default if none sent.
String	description Description that will be shown in the method documentation page
Boolean	isList If it has children, wether the object returned is a list or a sinlge item.
String	name The name of the field
String	type The type of the method.
Boolean	vectorized Only valid for parameters.

Constructor Summary

Field()

Method Summary

List<Field>	getChildren()
String	getDefaultValue()
String	getDescription()
Boolean	getIsList()
String	getName()
String	getType()
Boolean	getVectorized()

Methods inherited from class java.lang.Object

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

Field Detail

name

public String name

The name of the field

description

public String description

Description that will be shown in the method documentation page

type

public String type

The type of the method.

vectorized

public Boolean vectorized

Only valid for parameters.
Whether it accepts a vectorized parameter.
In case it is true, a comma separated list of values can be send.

defaultValue

public String defaultValue

Only valid for options and filters.
The value that is taken by default if none sent.

isList

public Boolean isList

If it has children, wether the object returned is a list or a sinlge item.
This element is only valid for responses and post/put request parameters

children

public List<Field> children

Sub elements of this field.
This element is only valid for responses and post/put request parameters

Constructor Detail

Field

public Field()

Method Detail

getName

public String getName()

getDescription

public String getDescription()

getType

public String getType()

getDefaultValue

public String getDefaultValue()

getChildren

public List<Field> getChildren()

getVectorized

public Boolean getVectorized()

getIsList

public Boolean getIsList()