Package com.saperion.ngc.model.document

Class DocumentVariable

java.lang.Object

com.saperion.ngc.model.document.DocumentVariable

All Implemented Interfaces:

java.io.Serializable

public class DocumentVariable
extends java.lang.Object
implements java.io.Serializable

Represents a variable of a document.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DocumentVariable(java.lang.String name, int type)	Creates a new DocumentVariable.
DocumentVariable(java.lang.String name, int type, java.lang.Object value)	Creates a new DocumentVariable.

Method Summary

Modifier and Type	Method	Description
static DocumentVariable	createNewStringVariable(java.lang.String name, java.lang.String value)	Creates a new variable of type String.
java.lang.String	getName()
java.lang.String	getStringValue()
int	getType()
java.lang.Object	getValue()
void	setValue(java.lang.Object value)	Sets the value of the variable.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentVariable

public DocumentVariable(java.lang.String name,
                        int type,
                        java.lang.Object value)

Creates a new DocumentVariable.

Parameters:

name - the name of the variable

type - the type of the variable (see FT_xxx constants in SaConstants)

value - the value of the variable

DocumentVariable

public DocumentVariable(java.lang.String name,
                        int type)

Creates a new DocumentVariable.

Parameters:

name - the name of the variable

type - the type of the variable (see FT_xxx constants in SaConstants)

Method Detail

createNewStringVariable

public static DocumentVariable createNewStringVariable(java.lang.String name,
                                                       java.lang.String value)

Creates a new variable of type String. Same as calling the constructor with type = SaConstants.FT_STRING.

Parameters:

name - the name of the new variable

value - the value of the new variable

Returns:

the new variable

getValue

public java.lang.Object getValue()

Returns:

the value of the variable

setValue

public void setValue(java.lang.Object value)

Sets the value of the variable.

Parameters:

value - the new value

getName

public java.lang.String getName()

Returns:

the name of the variable

getType

public int getType()

Returns:

the type of the variable

getStringValue

public java.lang.String getStringValue()

Returns:

the string-value of the variable