Package com.aspose.tasks

Class Value

java.lang.Object

com.aspose.tasks.Value

public class Value
extends Object

Represents a value in a value list.

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Value

public Value()

Initializes a new instance of the Value class.

Method Detail

getDateValue

public final Date getDateValue()

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

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

Returns:

the actual value if it can be represented as DateTime.

setDateValue

public final void setDateValue(Date value)

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

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

Parameters:

value - the actual value if it can be represented as DateTime.

getDescription

public final String getDescription()

Gets the description of a value.

Returns:

the description of a value.

setDescription

public final void setDescription(String value)

Sets the description of a value.

Parameters:

value - 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:

the actual value which is used to represent Duration.

setDuration

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:

value - 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:

the unique identifier of a value across a project.

setId

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:

value - 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:

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

setNumericValue

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:

value - 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:

the phonetic information about custom field name.

setPhonetic

public final void setPhonetic(String value)

Sets the phonetic information about custom field name.

Parameters:

value - 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:

the actual value which is used to represent Text string.

setStringValue

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:

value - 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:

the actual value in internal representation.

setVal

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:

value - 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:

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