OutlineCodeDefinition

Inheritance: java.lang.Object

public class OutlineCodeDefinition

Represents an outline code definition.

Constructors

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

Methods

Method	Description
getAlias()	Gets the alias of a custom outline code.
getAllLevelsRequired()	Gets a value indicating whether the new codes must have all levels.
getEnterprise()	Gets a value indicating whether a custom outline code is an enterprise custom outline code.
getEnterpriseOutlineCodeAlias()	Gets a reference to another custom field for which this outline code definition is an alias.
getFieldId()	Gets the field number of an outline code.
getFieldName()	Gets the name of a custom outline code.
getGuid()	Gets the Guid of an outline code.
getLeafOnly()	Gets a value indicating whether the values specified in this outline code field must be leaf values.
getMasks()	Gets the OutlineMaskCollection object.
getOnlyTableValuesAllowed()	Gets a value indicating whether the values specified must come from values table.
getPhoneticAlias()	Gets the phonetic pronunciation of the alias of the custom outline code.
getResourceSubstitutionEnabled()	Gets a value indicating whether the custom outline code can be used by the Resource Substitution Wizard in Microsoft Project.
getShowIndent()	Gets a value indicating whether the indents of this outline code must be shown.
getValues()	Gets OutlineValueCollection object.
setAlias(String value)	Sets the alias of a custom outline code.
setAllLevelsRequired(boolean value)	Sets a value indicating whether the new codes must have all levels.
setEnterprise(boolean value)	Sets a value indicating whether a custom outline code is an enterprise custom outline code.
setEnterpriseOutlineCodeAlias(int value)	Sets a reference to another custom field for which this outline code definition is an alias.
setFieldId(String value)	Sets the field number of an outline code.
setFieldName(String value)	Sets the name of a custom outline code.
setGuid(String value)	Sets the Guid of an outline code.
setLeafOnly(boolean value)	Sets a value indicating whether the values specified in this outline code field must be leaf values.
setOnlyTableValuesAllowed(boolean value)	Sets a value indicating whether the values specified must come from values table.
setPhoneticAlias(String value)	Sets the phonetic pronunciation of the alias of the custom outline code.
setResourceSubstitutionEnabled(boolean value)	Sets a value indicating whether the custom outline code can be used by the Resource Substitution Wizard in Microsoft Project.
setShowIndent(boolean value)	Sets a value indicating whether the indents of this outline code must be shown.

OutlineCodeDefinition()

public OutlineCodeDefinition()

Initializes a new instance of the OutlineCodeDefinition class.

getAlias()

public final String getAlias()

Gets the alias of a custom outline code.

Returns: java.lang.String - the alias of a custom outline code.

getAllLevelsRequired()

public final boolean getAllLevelsRequired()

Gets a value indicating whether the new codes must have all levels. Not available for Enterprise Codes.

Returns: boolean - a value indicating whether the new codes must have all levels.

getEnterprise()

public final boolean getEnterprise()

Gets a value indicating whether a custom outline code is an enterprise custom outline code.

Returns: boolean - a value indicating whether a custom outline code is an enterprise custom outline code.

getEnterpriseOutlineCodeAlias()

public final int getEnterpriseOutlineCodeAlias()

Gets a reference to another custom field for which this outline code definition is an alias.

Returns: int - a reference to another custom field for which this outline code definition is an alias.

getFieldId()

public final String getFieldId()

Gets the field number of an outline code.

Returns: java.lang.String - the field number of an outline code.

getFieldName()

public final String getFieldName()

Gets the name of a custom outline code.

Returns: java.lang.String - the name of a custom outline code.

getGuid()

public final String getGuid()

Gets the Guid of an outline code.

Returns: java.lang.String - the Guid of an outline code.

getLeafOnly()

public final boolean getLeafOnly()

Gets a value indicating whether the values specified in this outline code field must be leaf values.

Returns: boolean - a value indicating whether the values specified in this outline code field must be leaf values.

getMasks()

public final OutlineMaskCollection getMasks()

Gets the OutlineMaskCollection object. The table of entries that define the outline code mask. Read-only OutlineMaskCollection instance.

Returns: OutlineMaskCollection - the OutlineMaskCollection object.

getOnlyTableValuesAllowed()

public final boolean getOnlyTableValuesAllowed()

Gets a value indicating whether the values specified must come from values table.

Returns: boolean - a value indicating whether the values specified must come from values table.

getPhoneticAlias()

public final String getPhoneticAlias()

Gets the phonetic pronunciation of the alias of the custom outline code.

Returns: java.lang.String - the phonetic pronunciation of the alias of the custom outline code.

getResourceSubstitutionEnabled()

public final boolean getResourceSubstitutionEnabled()

Gets a value indicating whether the custom outline code can be used by the Resource Substitution Wizard in Microsoft Project.

Returns: boolean - a value indicating whether the custom outline code can be used by the Resource Substitution Wizard in Microsoft Project.

getShowIndent()

public final boolean getShowIndent()

Gets a value indicating whether the indents of this outline code must be shown.

---

This is new for MS Project 2010 property.

Returns: boolean - a value indicating whether the indents of this outline code must be shown.

getValues()

public final OutlineValueCollection getValues()

Gets OutlineValueCollection object. The values of the table associated with this outline code.

Returns: OutlineValueCollection - OutlineValueCollection object.

setAlias(String value)

public final void setAlias(String value)

Sets the alias of a custom outline code.

Parameters:

Parameter	Type	Description
value	java.lang.String	the alias of a custom outline code.

setAllLevelsRequired(boolean value)

public final void setAllLevelsRequired(boolean value)

Sets a value indicating whether the new codes must have all levels. Not available for Enterprise Codes.

Parameters:

Parameter	Type	Description
value	boolean	a value indicating whether the new codes must have all levels.

setEnterprise(boolean value)

public final void setEnterprise(boolean value)

Sets a value indicating whether a custom outline code is an enterprise custom outline code.

Parameters:

Parameter	Type	Description
value	boolean	a value indicating whether a custom outline code is an enterprise custom outline code.

setEnterpriseOutlineCodeAlias(int value)

public final void setEnterpriseOutlineCodeAlias(int value)

Sets a reference to another custom field for which this outline code definition is an alias.

Parameters:

Parameter	Type	Description
value	int	a reference to another custom field for which this outline code definition is an alias.

setFieldId(String value)

public final void setFieldId(String value)

Sets the field number of an outline code.

Parameters:

Parameter	Type	Description
value	java.lang.String	the field number of an outline code.

setFieldName(String value)

public final void setFieldName(String value)

Sets the name of a custom outline code.

Parameters:

Parameter	Type	Description
value	java.lang.String	the name of a custom outline code.

setGuid(String value)

public final void setGuid(String value)

Sets the Guid of an outline code.

Parameters:

Parameter	Type	Description
value	java.lang.String	the Guid of an outline code.

setLeafOnly(boolean value)

public final void setLeafOnly(boolean value)

Sets a value indicating whether the values specified in this outline code field must be leaf values.

Parameters:

Parameter	Type	Description
value	boolean	a value indicating whether the values specified in this outline code field must be leaf values.

setOnlyTableValuesAllowed(boolean value)

public final void setOnlyTableValuesAllowed(boolean value)

Sets a value indicating whether the values specified must come from values table.

Parameters:

Parameter	Type	Description
value	boolean	a value indicating whether the values specified must come from values table.

setPhoneticAlias(String value)

public final void setPhoneticAlias(String value)

Sets the phonetic pronunciation of the alias of the custom outline code.

Parameters:

Parameter	Type	Description
value	java.lang.String	the phonetic pronunciation of the alias of the custom outline code.

setResourceSubstitutionEnabled(boolean value)

public final void setResourceSubstitutionEnabled(boolean value)

Sets a value indicating whether the custom outline code can be used by the Resource Substitution Wizard in Microsoft Project.

Parameters:

Parameter	Type	Description
value	boolean	a value indicating whether the custom outline code can be used by the Resource Substitution Wizard in Microsoft Project.

setShowIndent(boolean value)

public final void setShowIndent(boolean value)

Sets a value indicating whether the indents of this outline code must be shown.

---

This is new for MS Project 2010 property.

Parameters:

Parameter	Type	Description
value	boolean	a value indicating whether the indents of this outline code must be shown.