com.aspose.tasks

Interfaces

Classes

Exceptions

com.aspose.tasks

Class ExtendedAttributeDefinition

    • Constructor Detail

      • ExtendedAttributeDefinition

        @Deprecated
        public ExtendedAttributeDefinition()
        Deprecated. Do not create attributes using this constructor. Instead create ExtendedAttributeDefinition using strongly typed static factory methods named like Create*Definition().
        Initializes a new instance of the ExtendedAttributeDefinition class.
    • Method Detail

      • getAlias

        public String getAlias()
        Returns the alias of a custom field. Read/write String.
        Returns:
        custom field alias.
      • setAlias

        public void setAlias(String value)
        Sets the alias of a custom field. Read/write String.
        Parameters:
        value - custom field alias.
      • getAppendNewValues

        public boolean getAppendNewValues()
        Determines whether new values added to a project are automatically added to the list. Read/write boolean. Currently supported for MSP 2003/2007 Xml and MSP 2003 mpp formats.
        Returns:
        true if new values added to a project are automatically added to the list.
      • setAppendNewValues

        public void setAppendNewValues(boolean value)
        Determines whether new values added to a project are automatically added to the list. Read/write boolean. Currently supported for MSP 2003/2007 Xml and MSP 2003 mpp formats.
        Parameters:
        value - true if new values added to a project are automatically added to the list.
      • getAutoRollDown

        public boolean getAutoRollDown()
        Determines whether an automatic rolldown to assignments is enabled. Read/write boolean. Currently supported for Xml format only.
        Returns:
        true if an automatic rolldown to assignments is enabled.
      • setAutoRollDown

        public void setAutoRollDown(boolean value)
        Determines whether an automatic rolldown to assignments is enabled. Read/write boolean. Currently supported for Xml format only.
        Parameters:
        value - true if an automatic rolldown to assignments is enabled.
      • getCalculationType

        public int getCalculationType()
        Determines whether rollups are calculated for a task and group summary rows. Read/write CalculationType. Currently supported for Xml format only.
        Returns:
        calculation type.
      • setCalculationType

        public void setCalculationType(int value)
        Determines whether rollups are calculated for a task and group summary rows. Read/write CalculationType. Currently supported for Xml format only.
        Parameters:
        value - calculation type.
      • getCfType

        public int getCfType()
        Returns the type of a custom field. Read/write CustomFieldType.
        Returns:
        custom field type.
      • setCfType

        @Deprecated
        public void setCfType(int value)
        Deprecated. Don't set the value for CfType property. Instead create ExtendedAttributeDefinition using strongly typed static factory methods named like create*Definition().
        Sets the type of a custom field. Read/write CustomFieldType.
        Parameters:
        value - custom field type.
      • getDefault

        public String getDefault()
        Returns the default value in the list. Read/write String. Currently supported for MSP 2003/2007 Xml and MSP 2003 mpp formats.
        Returns:
        the default value in the list.
      • setDefault

        public void setDefault(String value)
        Sets the default value in the list. Read/write String. Currently supported for MSP 2003/2007 Xml and MSP 2003 mpp formats.
        Parameters:
        value - the default value in the list.
      • getDefaultGuid

        public String getDefaultGuid()
        Returns the Guid of the default lookup table entry. Read/write String. Currently supported for Xml format only.
        Returns:
        default lookup table entry Guid.
      • setDefaultGuid

        public void setDefaultGuid(String value)
        Sets the Guid of the default lookup table entry. Read/write String. Currently supported for Xml format only.
        Parameters:
        value - default lookup table entry Guid.
      • getElementType

        public int getElementType()
        Returns a value which determines whether the extended attribute is associated with a task, a resource, or an assignment. Read/write ElementType. Currently supported for Xml format only.
        Returns:
        returns extended attribute element type.
      • setElementType

        public void setElementType(int value)
        Sets a value which determines whether the extended attribute is associated with a task, a resource, or an assignment.
        Parameters:
        value - a flag which determines whether the extended attribute is associated with a task, a resource, or an assignment.
      • getFieldId

        public String getFieldId()
        Corresponds to the Pid of a custom field. Use string representation of a constant from Aspose.Tasks.ExtendedAttributeTask class to specify FieldId property. Preferable way to set FieldId property is to create ExtendedAttributeDefinition using one of the dedicated factory methods like createTaskDefinition or createLookupTaskDefinition.
        Returns:
        custom field Id.
      • setFieldId

        public void setFieldId(String value)
        Corresponds to the Pid of a custom field. Use string representation of a constant from Aspose.Tasks.ExtendedAttributeTask class to specify FieldId property. Preferable way to set FieldId property is to create ExtendedAttributeDefinition using one of the dedicated factory methods like createTaskDefinition or createLookupTaskDefinition.
      • getFieldName

        public String getFieldName()
        Returns the name of a custom field. Read/write String. Currently supported for MSP 2003/2007 Xml and MSP 2003 mpp formats.
        Returns:
        the name of a custom field.
      • setFieldName

        @Deprecated
        public void setFieldName(String value)
        Deprecated. Don't set the value for FieldName property. Instead create ExtendedAttributeDefinition using strongly typed static factory methods named like create*Definition().
        Sets the name of a custom field. Read/write String. Currently supported for MSP 2003/2007 Xml and MSP 2003 mpp formats.
        Parameters:
        value - the name of a custom field.
      • getFormula

        public String getFormula()
        Returns the formula that Microsoft Project uses to populate a custom task field. Read/write string. Currently supported for Xml format only.
        Returns:
        custom field formula.
      • getGuid

        public String getGuid()
        Returns the Guid of a custom field. Currently supported for Xml format only.
        Returns:
        custom field Guid.
      • setGuid

        public void setGuid(String value)
        Sets the Guid of a custom field. Currently supported for Xml format only.
        Parameters:
        value - custom field Guid.
      • getLookupUid

        public String getLookupUid()
        Returns the Guid of the lookup table associated with a custom field.
        Returns:
        custom field lookup table Guid.
      • setLookupUid

        @Deprecated
        public void setLookupUid(String value)
        Deprecated. Do not use Setter directly, instead use one of the factory methods: ExtendedAttributeDefinition.createLookupTaskDefinition or ExtendedAttributeDefinition.createLookupResourceDefinition.
        Sets the Guid of the lookup table associated with a custom field. Read/write String. If you want to create a custom field with lookup, don't set LookupUid directly, but instead use one of the factory methods: createLookupTaskDefinition or createLookupResourceDefinition.
        Parameters:
        value - custom field lookup table Guid.
      • getMaxMultiValues

        public int getMaxMultiValues()
        Returns the maximum number of values you can setInternal in a picklist. Read/write int. Currently supported for Xml format only.
        Returns:
        the maximum number of values.
      • setMaxMultiValues

        public void setMaxMultiValues(int value)
        Sets the maximum number of values you can setInternal in a picklist. Read/write int. Currently supported for Xml format only.
        Parameters:
        value - the maximum number of values.
      • getParentProject

        public Project getParentProject()
        Returns a parent project for the ExtendedAttributeDefinition instance.
        Returns:
        returns a parent project for this object.
      • getPhoneticsAlias

        public String getPhoneticsAlias()
        Returns the phonetic pronunciation of the alias of a custom field. Read/write String. Currently supported for Xml format only.
        Returns:
        custom field phonetic pronunciation.
      • setPhoneticsAlias

        public void setPhoneticsAlias(String value)
        Sets the phonetic pronunciation of the alias of a custom field. Read/write String. Currently supported for Xml format only.
        Parameters:
        value - custom field phonetic pronunciation.
      • getRestrictValues

        public boolean getRestrictValues()
        Determines whether only values in the list are allowed in a file. Read/write boolean. Currently supported for MSP 2003/2007 Xml and MSP 2003 mpp formats.
        Returns:
        true if only values in the list are allowed in a file.
      • setRestrictValues

        public void setRestrictValues(boolean value)
        Determines whether only values in the list are allowed in a file. Read/write boolean. Currently supported for MSP 2003/2007 Xml and MSP 2003 mpp formats.
        Parameters:
        value - true if only values in the list are allowed in a file.
      • getRollupType

        public int getRollupType()
        Returns the way rollups are calculated. Read/write RollupType. Currently supported for Xml format only.
        Returns:
        rollup type.
      • setRollupType

        public void setRollupType(int value)
        Sets the way rollups are calculated. Read/write RollupType. Currently supported for Xml format only.
        Parameters:
        value - rollup type.
      • getSecondaryGuid

        public String getSecondaryGuid()
        Returns secondary guid of extended attribute. Read/write String. This is new for MS Project 2010 property.
        Returns:
        secondary guid.
      • setSecondaryGuid

        public void setSecondaryGuid(String value)
        Sets secondary guid of extended attribute. Read/write String. This is new for MS Project 2010 property.
        Parameters:
        value - secondary guid.
      • getSecondaryPid

        public String getSecondaryPid()
        Returns the secondary Pid of a custom field. Read/write String. Currently supported for Xml format only.
        Returns:
        custom field secondary Pid.
      • setSecondaryPid

        public void setSecondaryPid(String value)
        Sets the secondary Pid of a custom field. Read/write String. Currently supported for Xml format only.
        Parameters:
        value - custom field secondary Pid.
      • getUserDef

        public boolean getUserDef()
        Determines whether a custom field is user defined. Read/write boolean. Currently supported for Xml format only.
        Returns:
        true if a custom field is user defined.
      • setUserDef

        public void setUserDef(boolean value)
        Determines whether a custom field is user defined. Read/write boolean. Currently supported for Xml format only.
        Parameters:
        value - true if a custom field is user defined.
      • getValueList

        public List<Value> getValueList()
        Returns a list of values for this object. Do not change this list directly. Use ExtendedAttributeDefinition.addLookupValue/removeLookupValue methods instead. When values of extended attributes are specified as properties of elements in the schema, they may either be specified by values or by references to the values contained in this list. Applications may assume ordering of the list by ordering specified here. Currently supported for MSP 2003/2007 Xml and MSP 2003 mpp formats.
        Returns:
        custom field list of values.
      • setValueList

        public void setValueList(List<Value> value)
        Sets List<Value> ValueList. Do not change this list directly. Use ExtendedAttributeDefinition.addLookupValue/removeLookupValue methods instead. When values of extended attributes are specified as properties of elements in the schema, they may either be specified by values or by references to the values contained in this list. Applications may assume ordering of the list by ordering specified here. Currently supported for MSP 2003/2007 Xml and MSP 2003 mpp formats.
        Parameters:
        value - custom field list of values.
      • getValuelistSortOrder

        public int getValuelistSortOrder()
        Returns the way value lists are sorted. Values are: 0=Descending, 1=Ascending. Read/write int. Currently supported for MSP 2003/2007 Xml and MSP 2003 mpp formats.
        Returns:
        the way value lists are sorted.
      • setValuelistSortOrder

        public void setValuelistSortOrder(int value)
        Sets the way value lists are sorted. Values are: 0=Descending, 1=Ascending. Read/write int. Currently supported for MSP 2003/2007 Xml and MSP 2003 mpp formats.
        Parameters:
        value - the way value lists are sorted.
      • createLookupDefinition

        public static ExtendedAttributeDefinition createLookupDefinition()
        Factory method which creates an extended attribute definition with lookup. It has CalculationType equals to Tasks.CalculationType.Lookup. After creation you should manually specify the value for CfType, FieldId and Alias. Prefer using the stronger method createLookupTaskDefinition(CustomFieldType,ExtendedAttributeTask,String) or createLookupResourceDefinition(CustomFieldType,ExtendedAttributeResource,String).
        Returns:
        ExtendedAttributeDefinition
      • createLookupResourceDefinition

        public static ExtendedAttributeDefinition createLookupResourceDefinition(int customFieldType,
                                                                                 int fieldId,
                                                                                 String alias)
        Factory method which creates an extended attribute definition with lookup. It has CalculationType equals to Tasks.CalculationType.Lookup and can be used in Resources only. You are required to specify customFieldType, fieldId and alias when call this method.
      • createLookupTaskDefinition

        public static ExtendedAttributeDefinition createLookupTaskDefinition(int customFieldType,
                                                                             int fieldId,
                                                                             String alias)
        Factory method which creates an extended attribute definition with lookup. It has CalculationType equals to Tasks.CalculationType.Lookup and can be used in Tasks only. You are required to specify customFieldType, fieldId and alias when call this method.
      • createResourceDefinition

        public static ExtendedAttributeDefinition createResourceDefinition(int customFieldType,
                                                                           int fieldId,
                                                                           String alias)
        Factory method which creates a simple extended attribute definition, which Microsoft Project shows as "None". It has CalculationType equals to Tasks.CalculationType.None and can be used in Resource only. You are required to specify customFieldType, fieldId and alias when call this method.
      • createTaskDefinition

        public static ExtendedAttributeDefinition createTaskDefinition(int customFieldType,
                                                                       int fieldId,
                                                                       String alias)
        Factory method which creates a simple extended attribute definition, which Microsoft Project shows as "None". It has CalculationType equals to Tasks.CalculationType.None and can be used in Tasks only. You are required to specify customFieldType, fieldId and alias when calling this method.
      • addLookupValue

        public void addLookupValue(Value value)
        Adds a value to the internal lookup list. This is a preferable way for manipulations with the ValueList. This method works only for ExtendedAttributeDefinition instances which have CalculationType equals to Tasks.CalculationType.Lookup.
        Parameters:
        value - The specified Value item.
      • compareTo

        public int compareTo(ExtendedAttributeDefinition o)
        Compares this object with another instance of the @{code ExtendedAttributeDefinition} class.
        Specified by:
        compareTo in interface Comparable<ExtendedAttributeDefinition>
        Parameters:
        o - the object to be compared.
        Returns:
        a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
      • createExtendedAttribute

        public ExtendedAttribute createExtendedAttribute(Value lookupValue)
        Creates new extended attribute linked with specified Value item.
        Parameters:
        lookupValue - The specified Value item. lookupValue should be previously added to the ExtendedAttributeDefinition using addLookupValue method.
        Returns:
        returns created instance of the ExtendedAttribute class linked with specified Value item.
      • createExtendedAttribute

        public ExtendedAttribute createExtendedAttribute()
        Creates new extended attribute with specified fieldID
        Returns:
        created extended attribute.
      • equals

        public boolean equals(Object obj)
        Returns a flag indiciating whether this instance is equal to the specified object.
        Overrides:
        equals in class Object
        Parameters:
        obj - the specified object to compare to this instance.
        Returns:
        a flag indicating whether this instance is equal to the specified object.
      • hashCode

        public int hashCode()
        Returns a hash code for this ExtendedAttributeDefinition.
        Overrides:
        hashCode in class Object
        Returns:
        Returns a hash code value for this object.
      • removeLookupValue

        public void removeLookupValue(Value value)
        Removes a value from the internal lookup list. This is a preferable way for manipulations with the ValueList. This method works only for ExtendedAttributeDefinition instances which have CalculationType equals to Tasks.CalculationType.Lookup.
        Parameters:
        value - Value of lookup item to remove.
      • setFormula

        public void setFormula(String value)
        Sets the formula that Microsoft Project uses to populate a custom task field. Read/write string. Currently supported for Xml format only.
        Parameters:
        value - custom field formula.