com.simplifiedlogic.nitro.jshell.json.template

Class FunctionObject

java.lang.Object

com.simplifiedlogic.nitro.jshell.json.template.FunctionObject

public class FunctionObject
extends java.lang.Object

Help-doc class which represents the definition of a shared data object.

Constructor Summary

Constructors

Constructor and Description
FunctionObject(java.lang.String name) Standard constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	add(FunctionArgument arg) Add a field to the data object
void	addFootnote(java.lang.String note) Add a line of footnote to the data object.
java.util.List<FunctionArgument>	getData() Get the list of fields for the object
java.lang.String	getDescription()
java.util.List<java.lang.String>	getNotes()
java.util.Map<java.lang.String,java.lang.Object>	getObject() Convert the data into a generic Map object
java.lang.String	getObjectName()
void	setDescription(java.lang.String description)
void	setObjectName(java.lang.String objectName)

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionObject

public FunctionObject(java.lang.String name)

Standard constructor

Parameters:

name - The name of the data object

Method Detail

getObject

public java.util.Map<java.lang.String,java.lang.Object> getObject()

Convert the data into a generic Map object

Returns:

The converted data object

add

public void add(FunctionArgument arg)

Add a field to the data object

Parameters:

arg - The field definition

addFootnote

public void addFootnote(java.lang.String note)

Add a line of footnote to the data object. These are additional notes which will appear in the header of the help doc

Parameters:

note - Footnote text, intended to be a single footnote

getObjectName

public java.lang.String getObjectName()

Returns:

The data object name

setObjectName

public void setObjectName(java.lang.String objectName)

Parameters:

objectName - The data object name

getData

public java.util.List<FunctionArgument> getData()

Get the list of fields for the object

Returns:

The list of fields

getDescription

public java.lang.String getDescription()

Returns:

The object's description

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - The object's description

getNotes

public java.util.List<java.lang.String> getNotes()