wt.meta
Interface EnumeratedType

All Superinterfaces:

LocalizableMessage, LocalizableMetadata, Message

All Known Implementing Classes:

AccessPermission, AccrualType, ActionItemCategory, ActionItemHealthStatus, ActionItemPriority, ActionItemStatus, AdHocAccessKey, AttributeAccessOperations, AttributeDefinitionDataType, AttributeMappingContext, AuditEventType, AXLPreference, AXLRuleStatus, BaselineConflictType, BaselineResolutionType, BusinessDecisionCategory, CalendarType, Category, ChangeNoticeComplexity, ChangeOperation, ChangeStatus, Complexity, ConfirmationCategory, ConflictType, ConstraintType, ContainerTeamManagedState, ContentCategory, ContentConflictResolution, ContentConflictType, ContentRoleType, ContextRelation, DefaultAttributeAccessOperations, DeliveryStatus, DepartmentList, DependencyOption, DocumentType, DynamicEnumType, EffectivityType, EffTypeModifier, EnumeratedType, EPMApplicationType, EPMAttributeAccessOperations, EPMAttributeMappingContext, EPMAuthoringAppType, EPMConfigurationType, EPMConflictType, EPMContainedObjectType, EPMDocSubType, EPMDocumentType, EPMErrorType, EPMPopulateRule, EPMReferenceType, EPMResolutionType, EPMStructureAnnotationType, EPMUploadConflictType, EPMUploadResolutionType, ESITransactionStatusType, FvMountStatus, GPSEquivalencyActual, GPSParameterGroupAlignment, GPSParameterGroupType, HttpOperationStatus, HttpOperationType, ImportAction, ImportElementAction, ImportJobStatus, ImportMode, ImportSessionStatus, ImportSheetType, ImportSourceFormat, IncludedAs, InputEnabled, InventoryDisposition, IssuePriority, IterationState, IXReferenceConflict, IXReferenceConflictResolution, MeetingStatus, MeetingType, MesgCategory, MessageType, MPMBranchingConstraintType, MPMCompatibilityLinkType, MPMERPValidationCode, MPMERPValidationCode, MPMMfgProcessCategory, MPMOperationCategory, MPMOperationToPartLinkType, MPMPlantType, MPMPrecedenceConstraintType, MPMProcessMaterialType, MPMProcessPlanCategory, MPMResourceGroupType, MPMResourceType, MPMResourceUsage, MPMReturnConstraintType, MPMSequenceLinkCategory, MPMSkillType, MPMToolingType, MPMWorkCenterType, NetworkRelation, NmCustomRole, OperationAllocationType, PartCreationState, PartRequestPriority, PartType, ProjectCategory, ProjectEventType, ProjectHealthStatus, ProjectLinkType, ProjectPhase, ProjectRiskValue, QuantityUnit, QueryOperation, RelatedItemsOption, ReleaseActivityAction, ReleaseStatusType, ReplacementType, ReplicationStatus, RequestPriority, ResolutionType, ResourceCategory, ResourceType, ReviseImpact, Role, RuleType, SandboxConflictType, SandboxResolutionType, SandboxStatus, ScheduleOpStatus, SeriesRangeSelector, ServerStatus, Source, SpecifiedBy, State, TaskEventMessageType, TaskScope, TaskStatus, TeamCategory, TraceCode, Transition, UIValidationStatus, UsageInfo, VarianceCategory, VersionControlConflictType, VersionControlResolutionType, WfCompletionType, WfDistributionType, WfEmailAttachmentType, WfSynchType, WfTallyType, WorkInProgressConflictType, WorkInProgressResolutionType, WorkInProgressState

public interface EnumeratedType
extends LocalizableMetadata, LocalizableMessage

Supported API: true

Extendable: false

Field Summary

static String	DEFAULT_VALUE Label for the attribute; Specifies which one of all the valid instances, would be the default value.
static String	ORDER Label for the attribute; The order of a particular instance, when placed in a collection of all valid instances.
static String	SELECTABLE Label for the attribute; Indicates that the instance is available for selection.

Method Summary

String	getDisplay(Locale locale) Returns the display text for the specified Locale.
int	getOrder() Gets the value of the attribute: ORDER.
String	getShortDescription(Locale locale) Returns the display text for the specified Locale.
boolean	isDefaultValue() Gets the value of the attribute: DEFAULT_VALUE.
boolean	isDefaultValue(Locale locale) Returns true if instance is the default vlaue for the specified Locale.
boolean	isSelectable() Gets the value of the attribute: SELECTABLE.

Methods inherited from interface wt.meta.LocalizableMetadata

getAbbreviatedDisplay, getDisplay, getFullDisplay, getLongDescription, getShortDescription

Methods inherited from interface wt.util.LocalizableMessage

getLocalizedMessage

Field Detail

ORDER

static final String ORDER

Label for the attribute; The order of a particular instance, when placed in a collection of all valid instances.

Supported API: true

See Also:

Constant Field Values

DEFAULT_VALUE

static final String DEFAULT_VALUE

Label for the attribute; Specifies which one of all the valid instances, would be the default value. One instance may be true, the rest must be false.

Supported API: true

See Also:

Constant Field Values

SELECTABLE

static final String SELECTABLE

Label for the attribute; Indicates that the instance is available for selection. Provides a means of disallowing the selection of a value in a pick list, while still allowing it as a valid value.

As an example, it may have been valid to select in the past, but is no longer valid to select, even though is it still a valid value to have because of historical selections.

Supported API: true

See Also:

Constant Field Values

Method Detail

getOrder

int getOrder()

Gets the value of the attribute: ORDER. The order of a particular instance, when placed in a collection of all valid instances.

Supported API: true

Returns:

int

isDefaultValue

boolean isDefaultValue()

Gets the value of the attribute: DEFAULT_VALUE. Specifies which one of all the valid instances, would be the default value. One instance may be true, the rest must be false.

Supported API: true

Returns:

boolean

isSelectable

boolean isSelectable()

Gets the value of the attribute: SELECTABLE. Indicates that the instance is available for selection. Provides a means of disallowing the selection of a value in a pick list, while still allowing it as a valid value.

As an example, it may have been valid to select in the past, but is no longer valid to select, even though is it still a valid value to have because of historical selections.

Supported API: true

Returns:

boolean

getDisplay

String getDisplay(Locale locale)

Returns the display text for the specified Locale.

Supported API: true

Parameters:

locale -

Returns:

String

getShortDescription

String getShortDescription(Locale locale)

Returns the display text for the specified Locale.

Supported API: true

Parameters:

locale -

Returns:

String

isDefaultValue

boolean isDefaultValue(Locale locale)

Returns true if instance is the default vlaue for the specified Locale.

Supported API: true

Parameters:

locale -

Returns:

boolean