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="theWTPrincipal",type=WTPrincipal.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+theWTPrincipalReference.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 Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ORG_INSTANCE


    Supported API: true
    static final int
    SITE_INSTANCE


    Supported API: true
    static final int
    USER_INSTANCE


    Supported API: true

    Fields inherited from class wt.preference._PreferenceInstance

    CLIENT, CLIENT_REFERENCE, COMMENTS, EXTERNALIZATION_VERSION_UID, INSTANCE_TYPE, LOCKED, PREFERENCE_DEFINITION, PREFERENCE_DEFINITION_REFERENCE, VALUE, WTCONTAINER, WTCONTAINER_REFERENCE, WTPRINCIPAL, WTPRINCIPAL_REFERENCE

    Fields inherited from class wt.fc._WTObject

    CREATE_TIMESTAMP, MODIFY_TIMESTAMP

    Fields inherited from interface wt.fc._Persistable

    PERSIST_INFO

    Fields inherited from interface wt.identity.DisplayIdentification

    DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

    Fields inherited from interface wt.fc.Persistable

    IDENTITY, TYPE

  • Method Summary

    Methods inherited from class wt.preference._PreferenceInstance

    getClassInfo, getClient, getClientReference, getComments, getConceptualClassname, getInstanceType, getLocked, getPreferenceDefinition, getPreferenceDefinitionReference, getType, getValue, getWTContainer, getWTContainerReference, getWTPrincipal, getWTPrincipalReference, readExternal, readExternal, readVersion, setClient, setClientReference, setComments, setInstanceType, setLocked, setPreferenceDefinition, setPreferenceDefinitionReference, setValue, setWTContainer, setWTContainerReference, setWTPrincipal, setWTPrincipalReference, super_readExternal_PreferenceInstance, super_readVersion_PreferenceInstance, super_writeExternal_PreferenceInstance, writeExternal, writeExternal

    Methods inherited from class wt.fc.WTObject

    checkAttributes, duplicate, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, initialize, toString

    Methods inherited from class wt.fc._WTObject

    equals, getCreateTimestamp, getModifyTimestamp, getPersistInfo, hashCode, readVersion, setPersistInfo

    Methods inherited from class java.lang.Object

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

  • 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: