com.appiancorp.suiteapi.process.forms

Class DynamicForm

java.lang.Object

com.appiancorp.suiteapi.process.forms.DynamicForm

All Implemented Interfaces:

DeepCloneable, JSONable, JSONCacheable, XMLable, java.io.Serializable, java.lang.Cloneable

public class DynamicForm
extends java.lang.Object
implements XMLable, JSONCacheable, DeepCloneable, java.io.Serializable

Bean representing dynamic forms

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOG

Fields inherited from interface com.appiancorp.suiteapi.common.XMLable

DEFAULT_BUFFER_SIZE

Fields inherited from interface com.appiancorp.suiteapi.common.JSONable

hiddenAttributes$TRANSIENT

Constructor Summary

Constructors

Constructor and Description
DynamicForm()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clone this object.
static DynamicForm	fromXML(org.w3c.dom.Node dNode) Creates a form from xml
static DynamicForm	fromXML(org.w3c.dom.Node node, FormElement.InferFormElementCallback callback)
boolean	getContainsLocalFile() Gets whether the form contains a local file
FormElement[]	getElements() Gets the elements of the form
java.util.HashSet	getHiddenAttributes() Returns the set of attributes (properties) that should not be included in the JSON representation of the object.
java.lang.String	getInstructions() Gets the instructions for the form
boolean	isDisplayInstructions() Whether the form will display instructions
void	setDisplayInstructions(boolean displayInstructions_) Sets if the form will display instructions
void	setElements(FormElement[] elements_) Sets the elements of the form
void	setInstructions(java.lang.String instructions_) Sets the instructions for the form
java.lang.String	toXML() Converts the form to xml
void	toXML(java.lang.StringBuilder buffer_) Converts the from to xml

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.appiancorp.suiteapi.common.XMLable

toXML

Field Detail

LOG

protected static final Logger LOG

Constructor Detail

DynamicForm

public DynamicForm()

Method Detail

getHiddenAttributes

public java.util.HashSet getHiddenAttributes()

Description copied from interface: JSONable

Returns the set of attributes (properties) that should not be included in the JSON representation of the object.

Specified by:

getHiddenAttributes in interface JSONable

Returns:

the set of hidden attributes

clone

public java.lang.Object clone()

Clone this object.

Specified by:

clone in interface DeepCloneable

Overrides:

clone in class java.lang.Object

Returns:

getContainsLocalFile

public boolean getContainsLocalFile()

Gets whether the form contains a local file

Returns:

whether the form contains a local file

isDisplayInstructions

public boolean isDisplayInstructions()

Whether the form will display instructions

Returns:

Whether the form will display instructions

setDisplayInstructions

public void setDisplayInstructions(boolean displayInstructions_)

Sets if the form will display instructions

Parameters:

displayInstructions_ - if the form will display instructions

See Also:

isDisplayInstructions()

getInstructions

public java.lang.String getInstructions()

Gets the instructions for the form

Returns:

the instructions for the form

setInstructions

public void setInstructions(java.lang.String instructions_)

Sets the instructions for the form

Parameters:

instructions_ - the instructions to set for the form

See Also:

getInstructions()

getElements

public FormElement[] getElements()

Gets the elements of the form

Returns:

the elements of the form

setElements

public void setElements(FormElement[] elements_)

Sets the elements of the form

Parameters:

elements_ - the elements to set on the form

See Also:

getElements()

toXML

public java.lang.String toXML()

Converts the form to xml

Specified by:

toXML in interface XMLable

Returns:

the xml representation of the form

toXML

public void toXML(java.lang.StringBuilder buffer_)

Converts the from to xml

Specified by:

toXML in interface XMLable

Parameters:

buffer_ - the buffer to store the xml in

fromXML

public static DynamicForm fromXML(org.w3c.dom.Node dNode)

Creates a form from xml

Parameters:

dNode - the xml to create the form from

Returns:

a DynamicForm created from the xml

fromXML

public static DynamicForm fromXML(org.w3c.dom.Node node,
                                  FormElement.InferFormElementCallback callback)