Package wt.fc

Class EnumeratedType

java.lang.Object
wt.fc.EnumeratedType
All Implemented Interfaces:
Serializable, Comparable, EnumeratedType, LocalizableMetadata, LocalizableMessage, Message
Direct Known Subclasses:
_AccessPermission, _AccessPermissionType, _AccountabilityKeyType, _AccrualType, _ActionItemCategory, _ActionItemHealthStatus, _ActionItemPriority, _ActionItemStatus, _ActionState, com.ptc.qualitymanagement.capa.plan._ActionType, com.ptc.qualitymanagement.nc._ActionType, com.ptc.qualitymanagement.masterdata.entity._AddressStatus, com.ptc.qualitymanagement.masterdata.entity._AddressType, _AdHocAccessKey, _AlternateNumber, _AttributeAccessOperations, _AttributeDefinitionDataType, _AttributeMappingContext, _AttributeStructFilterComparison, _AuditEventType, _AXLPreference, _AXLRuleStatus, com.ptc.windchill.bac._BACExportStatus, _BaseCalendarType, _BaseHealthStatusType, _BaselineModificationStatus, com.ptc.qualitymanagement.cem.activity.product.regulatoryreport.medwatch._BlankCode, _BuildStatus, _BusinessDecisionCategory, com.ptc.qualitymanagement.nc._BusinessImpactType, _CalculatedEffectivityType, _CalendarType, _Category, _CDRLAppCode, _CDRLCategory, _CDRLDD250Req, _CDRLDistStatement, _CDRLFrequency, com.ptc.qualitymanagement.cem.productDetails._CEPhase, _ChangeIntent, _ChangeNoticeComplexity, _ChangeOperation, _ChangeStatus, _ChangeTransitions, _ChangeVersionState, _ChoiceRuleType, _CINCategory, _Complexity, _ConfirmationCategory, com.ptc.qualitymanagement.capa.plan.action._ConfirmationOutcome, com.ptc.qualitymanagement.capa.plan.action._ConfirmationType, _ConflictContextType, _ConstraintType, _ContainerTeamManagedState, _ContentControlRule, wt.facade.contentcontrol._ContentControlState, _ContentRoleType, _ContextRelation, com.ptc.qualitymanagement.capa.request._ControlAuthority, _CopMemberLinkType, com.ptc.qualitymanagement.masterdata.entity._Country, _CreoIllustartionAppType, _CriteriaType, _CurrencySymbolPlacement, _DateConstraint, _DateFormatType, _DBRCADSynchronized, _DefaultTransformOption, com.ptc.qualitymanagement.qms.fdacommunication._DelayedAction, _DeliveryManifestType, _DeliveryMediumType, _DeliveryOptionType, _DeliveryStatus, _DepartmentList, _DiscrepancyType, wt.change2.disposition._DispositionReasonType, _DocumentType, _DPApplicationType, _DPImplCommunicationMode, _DPImplJobStatus, com.ptc.qualitymanagement.regmstr._DriverCategory, _DurationFormat, wt.fc._DynamicEnumType, com.ptc.qualitymanagement.capa.plan.action._EffectivenessOutcome, _EffectivityCalculationStatus, _EffectivityType, _EffType, _EffTypeModifier, com.ptc.qualitymanagement.masterdata.entity._EmailType, com.ptc.qualitymanagement.masterdata.entity._EmployeeDepartment, com.ptc.qualitymanagement.masterdata.entity._EntityGender, com.ptc.qualitymanagement.masterdata.entity._EntityStatus, _EPMApplicationType, _EPMAuthoringAppType, _EPMConfigurationType, _EPMContainedObjectType, _EPMDefinitionRuleType, _EPMDocSubType, _EPMDocumentType, _EPMPopulateRule, _EPMReferenceType, _EPMRepRuleType, _EPMRuleActionType, _EPMStructureAnnotationType, _EquivalenceLinkAnnotation, _ESITargetStatusType, _ESITransactionStatusType, _ExclusionState, _ExecutionMode, _ExecutionStatus, _ExportFileType, _ExportFormatType, wt.ixb.clientAccess._ExportImportFormatType, _ExportStatus, wt.ixb.publicforapps.contextData._FederationContextType, _FilteredStatus, _FilterExclusionType, _FormulaType, _FvMountStatus, wt.generic._GenericType, _GPSEquivalencyActual, _GPSParameterGroupAlignment, _GPSParameterGroupType, _HttpOperationStatus, _HttpOperationType, wt.impact._ImpactIntentType, _ImportableFormatTypes, _ImportAction, _ImportElementAction, _ImportJobStatus, _ImportSessionStatus, _ImportSheetType, _ImportSourceFormat, _InputEnabled, _InteropState, _InventoryDisposition, _IOPState, _IssuePriority, wt.change2.disposition._ItemStateType, wt.change2.disposition._ItemType, _IterationState, wt.ixb.publicforapps.contextData._IXFidelity, wt.ixb.clientAccess._IXFormatImplementationMethodType, wt.ixb.clientAccess._IXFormatProtocolType, _MeetingStatus, _MeetingType, _MesgCategory, _MessageType, _MfgHistoryEventType, _MfgHistoryLinkType, _ModelItemBomDesignation, wt.epm.modelitems.link._ModelItemPartLinkType, _ModelItemRelationshipType, _ModelItemStatus, _ModelItemSubType, _ModelItemType, _MPMBranchingConstraintType, _MPMCompatibilityLinkType, _MPMConfigurationRecipeCategory, _MPMERPValidationCode, _MPMERPValidationCode, _MPMLinkReportType, _MPMMfgProcessCategory, _MPMOperationCategory, _MPMOperationToOperatedPartLinkType, _MPMOperationToPartLinkType, _MPMPlantType, _MPMPrecedenceConstraintType, _MPMProcessMaterialType, _MPMProcessPlanCategory, _MPMQualitySeverity, _MPMResourceGroupType, _MPMResourceType, _MPMResourceUsage, _MPMReturnConstraintType, _MPMSequenceLinkCategory, _MPMSkillType, _MPMStandardCCCategory, _MPMToolingType, _MPMWorkCenterType, _NavigationFilterType, _NetworkRelation, com.ptc.qualitymanagement.nc._NonconformanceType, _OperationAllocationType, _OptionDataType, _PartCreationState, _PartRequestPriority, _PartType, com.ptc.qualitymanagement.masterdata.entity._PhoneType, _PlannableState, _PrecedenceType, _PreferenceCategoryRoleType, com.ptc.qualitymanagement.masterdata.entity._PrimaryResponsibility, _PrincipalStatus, com.ptc.qualitymanagement.nc._ProcessType, _ProjectCategory, _ProjectEventType, _ProjectHealthStatus, _ProjectLinkType, _ProjectPhase, _ProjectRiskValue, _ProjectUpdateOption, _QuantityUnit, _QueryOperation, com.ptc.qualitymanagement.capa.request._ReferenceRecordType, com.ptc.qualitymanagement.regmstr._RegulatoryContentCategory, com.ptc.qualitymanagement.capa.review._RejectionReason, com.ptc.qualitymanagement.masterdata.entity._RelationshipType, _ReleaseActivityAction, _ReleaseStatusType, _ReplacementType, _ReplicationStatus, _RepositoryType, _RequestPriority, _RequirementPriority, _RequirementStatus, wt.reservation._ReservationType, _ResolutionType, _ResourceAssignmentState, _ResourceAssignmentType, _ResourceCategory, _ResourceType, _ResourceUserType, com.ptc.qualitymanagement.qms.activity._ResponseAccepted, com.ptc.qualitymanagement.capa.review._ReviewOutcome, com.ptc.qualitymanagement.nc.review._ReviewOutcome, _ReviseImpact, _RiskType, _RuleType, _SandboxStatus, _ScheduleOpStatus, _SecurityLabel1, _SecurityLabel10, _SecurityLabel2, _SecurityLabel3, _SecurityLabel4, _SecurityLabel5, _SecurityLabel6, _SecurityLabel7, _SecurityLabel8, _SecurityLabel9, _SemiFinishedLinkType, _SeriesRangeSelector, _ServerStatus, com.ptc.qualitymanagement.nc._ShiftType, _Source, com.ptc.qualitymanagement.capa.request._SourceType, wt.change2.disposition._SourceType, _SpatialFilterDelegateType, wt.spatial._SpatialFilterMethod, _SpatialFilterType, _SpecifiedBy, _State, _StructFilterAction, com.ptc.qualitymanagement.capa.request._SubjectType, com.ptc.qualitymanagement.qms.fdacommunication._SubmissionStatus, com.ptc.qualitymanagement.qms.fdacommunication._SubmissionType, _SyncedWithCADStatus, _SyncStatus, _TaskEventMessageType, _TaskStatus, _TaskType, _TeamCategory, _TraceCode, _TrackingIntentType, _Transition, com.ptc.qualitymanagement.qms.enumTypes._UnitType, wt.change2.disposition._UnitType, _UpstreamTraceabilityStatus, _UsageInfo, _UsagePathLinkAnnotation, _UserPrefixAndSuffix, _VarianceCategory, _VersionStatus, com.ptc.wbr.core._WBRExportFormatType, com.ptc.wbr.core._WBRReportingSystem, wt.workflow.work._WfAssignmentState, _WfCompletionType, _WfDistributionType, _WfEmailAttachmentType, wt.workflow.engine._WfEventAuditType, wt.workflow.engine._WfState, _WfSynchType, _WfTallyType, wt.workflow.engine._WfTransition, _WorkInProgressState, _WTProcessStepStatus, com.ptc.qualitymanagement.masterdata.entity._XrefType, com.ptc.qualitymanagement.qms.enumTypes._YNOptionType, wt.change2.disposition._YNOptionType, ContentCategory, ContextItemType, ContextType, DependencyOption, IncludedAs, MspImportMode, ProjectOverdueValue, ProjectProgramItemType, ProjectProgramType, RelatedItemsOption, RuleFeedbackType, RuleValidationStatus, UIValidationStatus
@GenAsPrimitiveType(java.lang.String.class) public abstract class EnumeratedType extends Object implements EnumeratedType, Comparable, Serializable
A type that has a defined list of valid values, which may change over time. May optionally have a constant associated to one or more of the valid values (instances) of a sub-type.

The constructors for EnumeratedTypes are protected so that instances can only be constructed internally. The data needed for construction will be obtained from a resource and used to construct the instances, in the static initializer.

Supported API: true

Extendable: true

See Also:

  • Method Details

    • getOrder

      public 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
      Specified by:
      getOrder in interface EnumeratedType
      Returns:
      int

    • isDefaultValue

      public boolean isDefaultValue()
      Gets the value of the attribute: defaultValue; 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
      Specified by:
      isDefaultValue in interface EnumeratedType
      Returns:
      boolean

    • isSelectable

      public 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

      Specified by:
      isSelectable in interface EnumeratedType
      Returns:
      boolean

    • equals

      public boolean equals(Object obj)
      Determine if two instances are considered equal. They are considered equal if their internal values are the same, and the instances are type compatible.

      Supported API: true
      Overrides:
      equals in class Object
      Parameters:
      obj - another EnumeratedType object to compare against
      Returns:
      true if considered equal, otherwise false

    • getDisplay

      public String getDisplay(Locale locale)
      Returns the display text for the specified Locale. Follows the ResourceBundle algorithm for locating a resource for the locale.

      Supported API: true
      Specified by:
      getDisplay in interface EnumeratedType
      Parameters:
      locale - the locale for which a display value is requested
      Returns:
      The display value for the requested locale.

    • getValueSet

      public abstract EnumeratedType[] getValueSet()
      Returns the array of possible values (instances) for any specific (derived) EnumeratedType class.

      Supported API: true
      Returns:
      EnumeratedType[]

    • hashCode

      public int hashCode()
      Returns the hasCode() of the internal value.

      Supported API: true
      Overrides:
      hashCode in class Object
      Returns:
      int

    • toString

      public String toString()
      Returns the internal (persistent) value. This follows the pattern of primitive wrappers provided by Sun.

      Supported API: true
      Overrides:
      toString in class Object
      Returns:
      String

    • main

      public static void main(String[] args)
      Deprecated.
      Replaced by wt.fc.EnumeratedTypeUtil.main(String[])
      Prints the contents of the specified sub class of EnumeratedType and verifies the contents of the resource bundles. 
         Example Usage:
      // for current user's locale
      java wt.fc.EnumeratedType wt.lifecycle.State
 
      
      // for FRENCH locale
      java wt.fc.EnumeratedType wt.lifecycle.State fr
 
      
      // for CANADA_FRENCH locale
      java wt.fc.EnumeratedType wt.lifecycle.State fr CA


      Supported API: true
      Parameters:
      args - a String[] containing the following elements:

      [0] fully qualified classname of EnumeratedType sub class

      [1] two character language code (optional)

      [2] two character country code (optional)

      [3] two character variant code (optional)

      See Also:

    • valueSet

      protected abstract EnumeratedType[] valueSet()
      Returns:
      EnumeratedType[]

      Supported API: true

    • getLocaleSet

      protected abstract EnumeratedType[] getLocaleSet(Locale locale)
      Returns:
      EnumeratedType[]

      Supported API: true

    • getStringValue

      public String getStringValue()
      Gets the string representation of this object, which can later be used to get this instance again. Supported API: true
      Specified by:
      getStringValue in interface EnumeratedType
      Returns:
      The string representation of an EnumeratedType instance
      See Also:

    • getStringValue

      public static String getStringValue(String classname, String internal_value)
      Deprecated.
      Replaced by wt.fc.EnumeratedTypeUtil.getStringValue(String,String)
      Gets the string representation for an EnumeratedType class and instance value, which can later be used to get that instance.

      The format of the string representation is: classname.internal_value

      Supported API: true
      Parameters:
      String - The fully qualified name of the concrete EnumeratedType class.
      String - The internal value for a instance of that type.
      Returns:
      The string representation of an EnumeratedType instance
      See Also:

    • toEnumeratedType

      public static EnumeratedType toEnumeratedType(String classname, String internal_value) throws WTInvalidParameterException
      Deprecated.
      Replaced by wt.fc.EnumeratedTypeUtil.toEnumeratedType(String,String)
      Gets the instance of the concrete EnumeratedType given the classname and internal_value.

      Supported API: true
      Parameters:
      String - The fully qualified name of the concrete EnumeratedType class.
      String - The internal value for a instance of that type.
      Returns:
      The concrete EnumeratedType instance represented by stringValue. Returns null if passed a null.
      Throws:
      WTInvalidParameterException
      See Also:

    • toEnumeratedType

      public static EnumeratedType toEnumeratedType(String stringValue) throws WTInvalidParameterException
      Deprecated.
      Replaced by wt.fc.EnumeratedTypeUtil.toEnumeratedType(String)
      Gets the instance of the concrete EnumeratedType given the string representation of the object.

      Supported API: true
      Parameters:
      String - The string representation of an EnumeratedType instance.
      Returns:
      The concrete EnumeratedType instance represented by stringValue. Returns null if passed a null.
      Throws:
      WTInvalidParameterException
      See Also:

    • getLocalizedMessage

      public String getLocalizedMessage(Locale locale)
      Obtain a message, localized for the specified locale.

      Supported API: true
      Specified by:
      getLocalizedMessage in interface LocalizableMessage
      Parameters:
      The - locale for which a display name is desired.
      Returns:
      The localized display name as the localizable message.

    • isDefaultValue

      public boolean isDefaultValue(Locale locale)
      Determines if instance is the default value for a specific locale; Specifies which one of all the valid instances, would be the default value. One instance per locale may be true, the rest must be false.

      Supported API: true
      Specified by:
      isDefaultValue in interface EnumeratedType
      Parameters:
      locale - the locale for which a display value is requested
      Returns:
      boolean

    • getSelectableValueSet

      public EnumeratedType[] getSelectableValueSet()
      Gets the set of selectable instances for the concrete type of this instance.

      Supported API: true
      Returns:
      The array of concrete EnumeratedTypes that are selectable.