TemplateInput (Template Rendering service API 6.1.1 API)

java.lang.Object
- org.nuxeo.template.api.TemplateInput

All Implemented Interfaces:

Serializable
```
public class TemplateInput
extends Object
implements Serializable
```
Represents input parameters of a Template. Inputs parameters have an InputType, a name an a value. Value can be a xpath pointing to a DocumentModel property.

Author:

Tiry (tdelprat@nuxeo.com)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`autoLoop`
`protected Boolean`	`booleanValue`
`protected Date`	`dateValue`
`protected String`	`desciption`
`protected String`	`name`
`protected boolean`	`readOnly`
`protected String`	`source`
`protected String`	`stringValue`
`protected InputType`	`type`

Constructor Summary

Constructors
Constructor and Description

TemplateInput(String name)

TemplateInput(String name, Object value)

Constructors
Constructor and Description
`TemplateInput(String name)`
`TemplateInput(String name, Object value)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getBooleanValue()`
`TemplateInput`	`getCopy(boolean readOnly)`
`Date`	`getDateValue()`
`String`	`getDesciption()`
`String`	`getName()`
`String`	`getSource()`
`String`	`getStringValue()`
`InputType`	`getType()`
`String`	`getTypeAsString()`
`boolean`	`isAutoLoop()`
`boolean`	`isReadOnly()`
`boolean`	`isSet()`
`boolean`	`isSimpleValue()`
`boolean`	`isSourceValue()`
`void`	`setAutoLoop(boolean autoLoop)`
`void`	`setBooleanValue(Boolean booleanValue)`
`void`	`setDateValue(Date dateValue)`
`void`	`setDesciption(String desciption)`
`void`	`setName(String name)`
`void`	`setReadOnly(boolean readOnly)`
`void`	`setSource(String source)`
`void`	`setStringValue(String stringValue)`
`void`	`setType(InputType type)`
`void`	`setTypeAsString(String strType)`
`String`	`toString()`
`TemplateInput`	`update(TemplateInput other)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name
```
protected String name
```

stringValue
```
protected String stringValue
```

booleanValue
```
protected Boolean booleanValue
```

dateValue
```
protected Date dateValue
```

type
```
protected InputType type
```

source
```
protected String source
```

desciption
```
protected String desciption
```

readOnly
```
protected boolean readOnly
```

autoLoop
```
protected boolean autoLoop
```

Constructor Detail

TemplateInput
```
public TemplateInput(String name)
```

TemplateInput

public TemplateInput(String name,
                     Object value)

Method Detail

getCopy

public TemplateInput getCopy(boolean readOnly)

update

public TemplateInput update(TemplateInput other)

getSource
```
public String getSource()
```

setSource
```
public void setSource(String source)
```

getDesciption
```
public String getDesciption()
```

setDesciption

public void setDesciption(String desciption)

toString
```
public String toString()
```
Overrides:

toString in class Object

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getStringValue
```
public String getStringValue()
```

setStringValue

public void setStringValue(String stringValue)

getBooleanValue
```
public Boolean getBooleanValue()
```

setBooleanValue

public void setBooleanValue(Boolean booleanValue)

getDateValue
```
public Date getDateValue()
```

setDateValue

public void setDateValue(Date dateValue)

getType
```
public InputType getType()
```

getTypeAsString
```
public String getTypeAsString()
```

setType
```
public void setType(InputType type)
```

setTypeAsString

public void setTypeAsString(String strType)

isSimpleValue
```
public boolean isSimpleValue()
```

isSourceValue
```
public boolean isSourceValue()
```

isReadOnly
```
public boolean isReadOnly()
```

setReadOnly

public void setReadOnly(boolean readOnly)

isSet
```
public boolean isSet()
```

isAutoLoop
```
public boolean isAutoLoop()
```

setAutoLoop

public void setAutoLoop(boolean autoLoop)

Class TemplateInput

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

stringValue

booleanValue

dateValue

type

source

desciption

readOnly

autoLoop

Constructor Detail

TemplateInput

TemplateInput

Method Detail

getCopy

update

getSource

setSource

getDesciption

setDesciption

toString

getName

setName

getStringValue

setStringValue

getBooleanValue

setBooleanValue

getDateValue

setDateValue

getType

getTypeAsString

setType

setTypeAsString

isSimpleValue

isSourceValue

isReadOnly

setReadOnly

isSet

isAutoLoop

setAutoLoop