wt.projmgmt.msproject
Class TaskScope

java.lang.Object
  wt.fc.EnumeratedType
      wt.projmgmt.msproject.TaskScope

All Implemented Interfaces:

EnumeratedType, LocalizableMessage, LocalizableMetadata, Message, Serializable

public class TaskScope

extends EnumeratedType

implements Serializable

This EnumeratedType is used to specify the scope of a Microsoft Project Plan import or export operation. The scope determines what objects are imported into a PTC Project Plan or what objects are exported to a Microsoft Project Plan. For example, this type can be used to specify whether:

• All Tasks and Milestones
• Milestones & Summary Tasks Only
• Milestones Only
• Summary Tasks Only
• Top Level Milestones & Summary Tasks Only
• Top Level Milestones Only
• Top LevelSummary Tasks Only

are imported or exported. Other task scopes may also be available.

Supported API: true

Extendable: false

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class wt.fc.EnumeratedType

Field Summary

static TaskScope	ALL A scope that includes all tasks and milestones defined in the Microsoft Project Plan.
private static String	CLASS_RESOURCE
private static String	CLASSNAME
private static Hashtable	localeSets
static TaskScope	MILESTONE A scope that includes only milestones defined in the Microsoft Project Plan.
static TaskScope	MILESTONE_SUMMARY A scope that includes only summary tasks and milestones defined in the Microsoft Project Plan.
private static String	RESOURCE
static TaskScope	SUMMARY A scope that includes only summary tasks defined in the Microsoft Project Plan.
static TaskScope	TOP_MILESTONE A scope that includes only the top-level milestones defined in the Microsoft Project Plan.
static TaskScope	TOP_MILESTONE_SUMMARY A scope that includes only the top-level summary tasks and milestones defined in the Microsoft Project Plan.
static TaskScope	TOP_SUMMARY A scope that includes only the top-level summary tasks defined in the Microsoft Project Plan.
private static EnumeratedType[]	valueSet

Fields inherited from class wt.fc.EnumeratedType

secretHandshake, SEP_CHAR

Fields inherited from interface wt.meta.EnumeratedType

DEFAULT_VALUE, ORDER, SELECTABLE

Constructor Summary

protected

TaskScope() Used by sub-classes that need a default constructor.

Method Summary

protected EnumeratedType[]	getLocaleSet(Locale locale) Returns the set of values (instances) for this instance, for the specified locale.
static TaskScope	getTaskScopeDefault() Returns the default value (instance) for the TaskScope set.
static TaskScope[]	getTaskScopeSet() Returns a copy of the set of valid values (instances) for the TaskScope class.
EnumeratedType[]	getValueSet() Returns a copy of the set of valid values (instances) for this instance, for the current user locale.
private static EnumeratedType[]	initializeLocaleSet(Locale locale)
static TaskScope	newTaskScope(int secretHandshake) Used by EnumeratedType for constructing instances of TaskScope, from a resource bundle.
static TaskScope	toTaskScope(String internal_value) Returns the TaskScope instance for the internal_value argument.
protected EnumeratedType[]	valueSet() Returns a reference to the set of valid values (instances) for this instance.

Methods inherited from class wt.fc.EnumeratedType

defaultEnumeratedType, dynamicInstance, equals, getAbbreviatedDisplay, getComment, getComment, getDisplay, getDisplay, getFullDisplay, getInternalKey, getLocalizedMessage, getLocalizedValues, getLongDescription, getOrder, getSelectableValueSet, getShortDescription, getShortDescription, getStringValue, getStringValue, getValidSet, getValue, hashCode, instantiateSet, isDefaultValue, isDefaultValue, isPrimaryKey, isSelectable, main, readResolve, toEnumeratedType, toEnumeratedType, toEnumeratedType, toString, validateFriendship

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

CLASS_RESOURCE

private static final String CLASS_RESOURCE

See Also:

Constant Field Values

valueSet

private static final EnumeratedType[] valueSet

localeSets

private static Hashtable localeSets

ALL

public static final TaskScope ALL

A scope that includes all tasks and milestones defined in the Microsoft Project Plan.

Supported API: false

MILESTONE_SUMMARY

public static final TaskScope MILESTONE_SUMMARY

A scope that includes only summary tasks and milestones defined in the Microsoft Project Plan.

Supported API: false

MILESTONE

public static final TaskScope MILESTONE

A scope that includes only milestones defined in the Microsoft Project Plan.

Supported API: false

SUMMARY

public static final TaskScope SUMMARY

A scope that includes only summary tasks defined in the Microsoft Project Plan.

Supported API: false

TOP_MILESTONE_SUMMARY

public static final TaskScope TOP_MILESTONE_SUMMARY

A scope that includes only the top-level summary tasks and milestones defined in the Microsoft Project Plan.

Supported API: false

TOP_MILESTONE

public static final TaskScope TOP_MILESTONE

A scope that includes only the top-level milestones defined in the Microsoft Project Plan.

Supported API: false

TOP_SUMMARY

public static final TaskScope TOP_SUMMARY

A scope that includes only the top-level summary tasks defined in the Microsoft Project Plan.

Supported API: false

Constructor Detail

TaskScope

protected TaskScope()

Used by sub-classes that need a default constructor.

Supported API: false

Method Detail

newTaskScope

public static TaskScope newTaskScope(int secretHandshake)
                              throws IllegalAccessException

Used by EnumeratedType for constructing instances of TaskScope, from a resource bundle.

Supported API: false

Parameters:

secretHandshake -

Returns:

TaskScope

Throws:

IllegalAccessException

toTaskScope

public static TaskScope toTaskScope(String internal_value)
                             throws WTInvalidParameterException

Returns the TaskScope instance for the internal_value argument.

Supported API: true

Parameters:

internal_value - The internal (persistent) value for a valid instance of TaskScope.

Returns:

TaskScope

Throws:

WTInvalidParameterException

getTaskScopeDefault

public static TaskScope getTaskScopeDefault()

Returns the default value (instance) for the TaskScope set.

Supported API: true

Returns:

TaskScope

getTaskScopeSet

public static TaskScope[] getTaskScopeSet()

Returns a copy of the set of valid values (instances) for the TaskScope class.

Supported API: true

Returns:

TaskScope[]

getValueSet

public EnumeratedType[] getValueSet()

Returns a copy of the set of valid values (instances) for this instance, for the current user locale.

Supported API: true

Specified by:

getValueSet in class EnumeratedType

Returns:

EnumeratedType[]

valueSet

protected EnumeratedType[] valueSet()

Returns a reference to the set of valid values (instances) for this instance.

Supported API: false

Specified by:

valueSet in class EnumeratedType

Returns:

EnumeratedType[]

getLocaleSet

protected EnumeratedType[] getLocaleSet(Locale locale)

Returns the set of values (instances) for this instance, for the specified locale.

Supported API: false

Specified by:

getLocaleSet in class EnumeratedType

Parameters:

locale -

Returns:

EnumeratedType[]

initializeLocaleSet

private static EnumeratedType[] initializeLocaleSet(Locale locale)
                                             throws Throwable

Parameters:

locale -

Returns:

EnumeratedType[]

Throws:

Throwable