Package wt.preference

Class PreferenceInstance

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.preference._PreferenceInstance
wt.preference.PreferenceInstance
All Implemented Interfaces:
com.ptc.windchill.bac._BACManaged, com.ptc.windchill.bac.BACManaged, Externalizable, Serializable, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, NetFactor, ObjectMappable, Persistable, DisplayIdentification
@GenAsPersistable(superClass=WTObject.class,interfaces=com.ptc.windchill.bac.BACManaged.class,serializable=EXTERNALIZABLE_BASIC,properties={@GeneratedProperty(name="value",type=java.lang.String.class,constraints=@PropertyConstraints(upperLimit=4000)),@GeneratedProperty(name="locked",type=java.lang.Boolean.class,constraints=@PropertyConstraints(required=true)),@GeneratedProperty(name="instanceType",type=java.lang.Integer.class,constraints=@PropertyConstraints(required=true)),@GeneratedProperty(name="comments",type=java.lang.String.class,constraints=@PropertyConstraints(upperLimit=500))},foreignKeys={@GeneratedForeignKey(myRoleIsRoleA=false,foreignKeyRole=@ForeignKeyRole(name="thePreferenceDefinition",type=PreferenceDefinition.class,constraints=@PropertyConstraints(required=true),columnProperties=@ColumnProperties(index=true)),myRole=@MyRole(name="thePreferenceInstance")),@GeneratedForeignKey(myRoleIsRoleA=false,foreignKeyRole=@ForeignKeyRole(name="theWTUser",type=WTUser.class,constraints=@PropertyConstraints(required=true)),myRole=@MyRole(name="thePreferenceInstance")),@GeneratedForeignKey(myRoleIsRoleA=false,foreignKeyRole=@ForeignKeyRole(name="theWTContainer",type=WTContainer.class,constraints=@PropertyConstraints(required=true)),myRole=@MyRole(name="thePreferenceInstance")),@GeneratedForeignKey(name="PreferenceClientInstance",myRoleIsRoleA=false,foreignKeyRole=@ForeignKeyRole(name="client",type=PreferenceClient.class,constraints=@PropertyConstraints(required=true)),myRole=@MyRole(name="preferenceInstance"))},tableProperties=@TableProperties(compositeIndex1="+thePreferenceDefinitionReference.key.id+clientReference.key.id",compositeUnique1="+thePreferenceDefinitionReference.key.id+theWTContainerReference.key.id+theWTUserReference.key.id+clientReference.key.id",oracleTableSize=MEDIUM)) public final class PreferenceInstance extends wt.preference._PreferenceInstance
The PreferenceInstance object is the "instantiation" of a PreferenceDefinition, its main task is to store a user defined value of the preference. An instance is created when a value for a preference is set. Setting a value of a preference definition is creating (or modifying) an instance. An instance contains a value of the preference for a specific client/context pair.

Use the newPreferenceInstance static factory method(s), not the PreferenceInstance constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: true

Extendable: false

See Also:

  • Field Details

    • SITE_INSTANCE

      public static final int SITE_INSTANCE


      Supported API: true
      See Also:

    • ORG_INSTANCE

      public static final int ORG_INSTANCE


      Supported API: true
      See Also:

    • USER_INSTANCE

      public static final int USER_INSTANCE


      Supported API: true
      See Also: