Value

Inheritance: java.lang.Object

public class Value

Represents a value in a value list.

Constructors

Constructor	Description
Value()	Initializes a new instance of the Value class.

Methods

Method	Description
getDateValue()	Gets the actual value if it can be represented as DateTime.
getDescription()	Gets the description of a value.
getDuration()	Gets the actual value which is used to represent Duration.
getId()	Gets the unique identifier of a value across a project.
getNumericValue()	Gets the actual value which is used to represent number or cost value.
getPhonetic()	Gets the phonetic information about custom field name.
getStringValue()	Gets the actual value which is used to represent Text string.
getVal()	Gets the actual value in internal representation.
getValueGuid()	Gets a GUID which identifies this value among others in the entire project.
setDateValue(Date value)	Sets the actual value if it can be represented as DateTime.
setDescription(String value)	Sets the description of a value.
setDuration(Duration value)	Sets the actual value which is used to represent Duration.
setId(int value)	Sets the unique identifier of a value across a project.
setNumericValue(BigDecimal value)	Sets the actual value which is used to represent number or cost value.
setPhonetic(String value)	Sets the phonetic information about custom field name.
setStringValue(String value)	Sets the actual value which is used to represent Text string.
setVal(String value)	Sets the actual value in internal representation.

Value()

public Value()

Initializes a new instance of the Value class.

getDateValue()

public final Date getDateValue()

Gets the actual value if it can be represented as DateTime. Default value is DateTime#MinValue.MinValue.

Prefer this property over the Val(getVal()/setVal(String)), when you need to set the DateTime value.

Returns: java.util.Date - the actual value if it can be represented as DateTime.

getDescription()

public final String getDescription()

Gets the description of a value.

Returns: java.lang.String - the description of a value.

getDuration()

public final Duration getDuration()

Gets the actual value which is used to represent Duration.

Prefer this property over the Val(getVal()/setVal(String)), when you need to set the Duration value.

Returns: Duration - the actual value which is used to represent Duration.

getId()

public final int getId()

Gets the unique identifier of a value across a project.

It’s important to not have same identifiers for different Value instances.

Minimal Id(getId()/setId(int)) value is 1.

Returns: int - the unique identifier of a value across a project.

getNumericValue()

public final BigDecimal getNumericValue()

Gets the actual value which is used to represent number or cost value.

Prefer this property over the Val(getVal()/setVal(String)), when you need to set the Number or Cost value.

Returns: java.math.BigDecimal - the actual value which is used to represent number or cost value.

getPhonetic()

public final String getPhonetic()

Gets the phonetic information about custom field name.

Returns: java.lang.String - the phonetic information about custom field name.

getStringValue()

public final String getStringValue()

Gets the actual value which is used to represent Text string.

Prefer this property over the Val(getVal()/setVal(String)), when you need to set the Text value.

Returns: java.lang.String - the actual value which is used to represent Text string.

getVal()

public final String getVal()

Gets the actual value in internal representation. Prefer using strongly typed properties which are listed below.

If you want to set Text value prefer using strongly typed StringValue(getStringValue()/setStringValue(String)) property.

If you want to set Number or Cost value prefer using strongly typed NumericValue(getNumericValue()/setNumericValue(java.math.BigDecimal)) property.

If you want to set Date/Start/Finish values, prefer using strongly typed DateValue(getDateValue()/setDateValue(java.util.Date)) property.

If you want to set Duration value prefer using strongly typed Duration(getDuration()/setDuration(Duration)) property.

If your type wasn’t listed, use Val(getVal()/setVal(String)) property.

Returns: java.lang.String - the actual value in internal representation.

getValueGuid()

public final UUID getValueGuid()

Gets a GUID which identifies this value among others in the entire project.

Returns: java.util.UUID - a GUID which identifies this value among others in the entire project.

setDateValue(Date value)

public final void setDateValue(Date value)

Sets the actual value if it can be represented as DateTime. Default value is DateTime#MinValue.MinValue.

Prefer this property over the Val(getVal()/setVal(String)), when you need to set the DateTime value.

Parameters:

Parameter	Type	Description
value	java.util.Date	the actual value if it can be represented as DateTime.

setDescription(String value)

public final void setDescription(String value)

Sets the description of a value.

Parameters:

Parameter	Type	Description
value	java.lang.String	the description of a value.

setDuration(Duration value)

public final void setDuration(Duration value)

Sets the actual value which is used to represent Duration.

Prefer this property over the Val(getVal()/setVal(String)), when you need to set the Duration value.

Parameters:

Parameter	Type	Description
value	Duration	the actual value which is used to represent Duration.

setId(int value)

public final void setId(int value)

Sets the unique identifier of a value across a project.

It’s important to not have same identifiers for different Value instances.

Minimal Id(getId()/setId(int)) value is 1.

Parameters:

Parameter	Type	Description
value	int	the unique identifier of a value across a project.

setNumericValue(BigDecimal value)

public final void setNumericValue(BigDecimal value)

Sets the actual value which is used to represent number or cost value.

Prefer this property over the Val(getVal()/setVal(String)), when you need to set the Number or Cost value.

Parameters:

Parameter	Type	Description
value	java.math.BigDecimal	the actual value which is used to represent number or cost value.

setPhonetic(String value)

public final void setPhonetic(String value)

Sets the phonetic information about custom field name.

Parameters:

Parameter	Type	Description
value	java.lang.String	the phonetic information about custom field name.

setStringValue(String value)

public final void setStringValue(String value)

Sets the actual value which is used to represent Text string.

Prefer this property over the Val(getVal()/setVal(String)), when you need to set the Text value.

Parameters:

Parameter	Type	Description
value	java.lang.String	the actual value which is used to represent Text string.

setVal(String value)

public final void setVal(String value)

Sets the actual value in internal representation. Prefer using strongly typed properties which are listed below.

If you want to set Text value prefer using strongly typed StringValue(getStringValue()/setStringValue(String)) property.

If you want to set Number or Cost value prefer using strongly typed NumericValue(getNumericValue()/setNumericValue(java.math.BigDecimal)) property.

If you want to set Date/Start/Finish values, prefer using strongly typed DateTimeValue(getDateValue()/setDateValue(java.util.Date)) property.

If you want to set Duration value prefer using strongly typed Duration(getDuration()/setDuration(Duration)) property.

If your type wasn’t listed, use Val(getVal()/setVal(String)) property.

Parameters:

Parameter	Type	Description
value	java.lang.String	the actual value in internal representation.

ValidationException VbaModule