ExtendedAttribute
Inheritance: java.lang.Object
public class ExtendedAttribute
Represents extended attributes.
Currently supported all types of Extended attributes reading from MSP Xml 2003/2007 and mpp 2003. For MSP mpp 2007 all Extended attributes reading supported except durations and flags.
Methods
Method | Description |
---|---|
getAttributeDefinition() | Gets the attribute definition. |
getDateValue() | Gets a value for attributes with date types (Date, Start, Finish). |
getDurationValue() | Gets value for attributes with ‘Duration’ type. |
getFieldId() | Gets the id of a field. |
getFlagValue() | Gets a value indicating whether a flag is set for an attribute with ‘Flag’ type. |
getNumericValue() | Gets a value for attributes with numeric types (Cost, Number). |
getTextValue() | Gets a value for attributes with ‘Text’ type. |
getValueGuid() | Gets the guid of a lookup value. |
getValueReadOnly() | Gets a value indicating whether a value of this ExtendedAttribute instance is read-only. |
isErrorValue() | Gets whether calculation of extended attribute’s value resulted in an error. |
setDateValue(Date value) | Sets a value for attributes with date types (Date, Start, Finish). |
setDurationValue(Duration value) | Sets value for attributes with ‘Duration’ type. |
setFlagValue(boolean value) | Sets a value indicating whether a flag is set for an attribute with ‘Flag’ type. |
setNumericValue(BigDecimal value) | Sets a value for attributes with numeric types (Cost, Number). |
setTextValue(String value) | Sets a value for attributes with ‘Text’ type. |
toString() | Returns short string representation of an extended attribute. |
getAttributeDefinition()
public final ExtendedAttributeDefinition getAttributeDefinition()
Gets the attribute definition.
Returns: ExtendedAttributeDefinition - the attribute definition.
getDateValue()
public final Date getDateValue()
Gets a value for attributes with date types (Date, Start, Finish).
Returns: java.util.Date - a value for attributes with date types (Date, Start, Finish).
getDurationValue()
public final Duration getDurationValue()
Gets value for attributes with ‘Duration’ type.
Returns: Duration - value for attributes with ‘Duration’ type.
getFieldId()
public final String getFieldId()
Gets the id of a field.
Returns: java.lang.String - the id of a field.
getFlagValue()
public final boolean getFlagValue()
Gets a value indicating whether a flag is set for an attribute with ‘Flag’ type.
Returns: boolean - a value indicating whether a flag is set for an attribute with ‘Flag’ type.
getNumericValue()
public final BigDecimal getNumericValue()
Gets a value for attributes with numeric types (Cost, Number).
Returns: java.math.BigDecimal - a value for attributes with numeric types (Cost, Number).
getTextValue()
public final String getTextValue()
Gets a value for attributes with ‘Text’ type.
Returns: java.lang.String - a value for attributes with ‘Text’ type.
getValueGuid()
public final String getValueGuid()
Gets the guid of a lookup value.
Should not be set directly, instead use ExtendedAttributeDefinition.CreateExtendedAttribute(Value lookupValue) to create an extended attribute with a lookup value.
Returns: java.lang.String - the guid of a lookup value.
getValueReadOnly()
public final boolean getValueReadOnly()
Gets a value indicating whether a value of this ExtendedAttribute instance is read-only.
Value: returns true if a formula or rollup is defined in the ExtendedAttributeDefinition for this object.
Returns: boolean - a value indicating whether a value of this ExtendedAttribute instance is read-only.
isErrorValue()
public final boolean isErrorValue()
Gets whether calculation of extended attribute’s value resulted in an error.
Returns: boolean - whether calculation of extended attribute’s value resulted in an error.
setDateValue(Date value)
public final void setDateValue(Date value)
Sets a value for attributes with date types (Date, Start, Finish).
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.util.Date | a value for attributes with date types (Date, Start, Finish). |
setDurationValue(Duration value)
public final void setDurationValue(Duration value)
Sets value for attributes with ‘Duration’ type.
Parameters:
Parameter | Type | Description |
---|---|---|
value | Duration | value for attributes with ‘Duration’ type. |
setFlagValue(boolean value)
public final void setFlagValue(boolean value)
Sets a value indicating whether a flag is set for an attribute with ‘Flag’ type.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | a value indicating whether a flag is set for an attribute with ‘Flag’ type. |
setNumericValue(BigDecimal value)
public final void setNumericValue(BigDecimal value)
Sets a value for attributes with numeric types (Cost, Number).
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.math.BigDecimal | a value for attributes with numeric types (Cost, Number). |
setTextValue(String value)
public final void setTextValue(String value)
Sets a value for attributes with ‘Text’ type.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String | a value for attributes with ‘Text’ type. |
toString()
public String toString()
Returns short string representation of an extended attribute.
Returns: java.lang.String - The string representation of the extended attribute.