Package com.ptc.windchill.esi.tgt

Class ESITarget

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.fc._Item
wt.fc.Item
com.ptc.windchill.esi.tgt._ESITarget
com.ptc.windchill.esi.tgt.ESITarget
All Implemented Interfaces:
com.ptc.windchill.esi.tgt._ESITargetTypeInterface, com.ptc.windchill.esi.tgt.ESITargetTypeInterface, Externalizable, Serializable, Comparable, wt.access._AccessControlled, wt.access._PolicyAccessControlled, wt.access._SecurityLabeled, AccessControlled, wt.access.PolicyAccessControlled, SecurityLabeled, wt.admin._DomainAdministered, DomainAdministered, wt.esi._ESITargetFacade, ESITargetFacade, wt.fc._Identified, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc._UniquelyIdentified, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, Identified, NetFactor, ObjectMappable, Persistable, UniquelyIdentified, wt.iba.value._IBAHolder, wt.iba.value.IBAHolder, DisplayIdentification, wt.inf.container._WTContained, wt.inf.container._WTContainedIdentified, WTContained, WTContainedIdentified, wt.notify._Notifiable, Notifiable, wt.recent.RecentlyVisited, wt.type._Typed, wt.type._TypeManaged, wt.type.FlexTyped, wt.type.Typed, wt.type.TypeManaged
@GenAsPersistable(superClass=Item.class,interfaces={WTContained.class,WTContainedIdentified.class,UniquelyIdentified.class,Notifiable.class,wt.type.Typed.class,com.ptc.windchill.esi.tgt.ESITargetTypeInterface.class,ESITargetFacade.class},versions={-7883169107013281113L,2191768797069811614L,-1657387733045267111L},properties={@GeneratedProperty(name="name",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="The name of this ESITarget object.",constraints=@PropertyConstraints(upperLimit=450,required=true),columnProperties=@ColumnProperties(index=true)),@GeneratedProperty(name="description",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="A user-friendly textual description of this ESITarget object.",constraints=@PropertyConstraints(upperLimit=2048)),@GeneratedProperty(name="system",type=java.lang.String.class,supportedAPI=PUBLIC,constraints=@PropertyConstraints(lowerLimit=0,upperLimit=425),columnProperties=@ColumnProperties(index=true)),@GeneratedProperty(name="defaultForContext",type=boolean.class,initialValue="false",supportedAPI=PUBLIC,javaDoc="Indicates if this ESITarget object is a default one for the context (i.e. container) in which this object is created.<BR>"),@GeneratedProperty(name="taskURI",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="URI of the Info*Engine task to be used for sending the ESI response to the distribution target represented by this ESITarget object.",constraints=@PropertyConstraints(upperLimit=425,required=true),columnProperties=@ColumnProperties(defaultValue="com/ptc/windchill/esi/export/ExportToJMSQueue.xml")),@GeneratedProperty(name="number",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="The number attribute represents the number for this target.",constraints=@PropertyConstraints(stringCase=UPPER_CASE,upperLimit=32,required=true),columnProperties=@ColumnProperties(index=true,columnName="ESITargetNumber",defaultValue="0001")),@GeneratedProperty(name="responseMetaInfoPath",type=java.lang.String.class,initialValue="\"$CODEBASE$/com/ptc/windchill/esi/ESIResponseMetaInfo.xml\"",supportedAPI=PUBLIC,javaDoc="Path to a file that contains meta information for ESI response. ESI renderers create the ESI response based on this meta information.",constraints=@PropertyConstraints(required=true),columnProperties=@ColumnProperties(defaultValue="$CODEBASE$/com/ptc/windchill/esi/ESIResponseMetaInfo.xml")),@GeneratedProperty(name="status",type=ESITargetStatusType.class,initialValue="ESITargetStatusType.ACTIVE",supportedAPI=PUBLIC,javaDoc="Indicates whether or not this target is active.")},iconProperties=@IconProperties(standardIcon="wtcore/images/disttarget.gif",openIcon="wtcore/images/disttarget.gif")) public class ESITarget extends _ESITarget
A location where ESI is to publish information.

Use the newESITarget static factory method(s), not the ESITarget 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:

  • Method Details

    • getObjectID

      public String getObjectID() throws WTException
      Return the UFID of this ESITarget object.

      Supported API: true
      Returns:
      String
      Throws:
      WTException

    • getIdentificationObject

      public IdentificationObject getIdentificationObject() throws WTException
      Returns the Identification object for ESITarget

      Supported API: true
      Returns:
      IdentificationObject
      Throws:
      WTException

    • getSoftAttribute

      public String getSoftAttribute(String attributeName)
      Returns the value of the input soft attribute of this ESITarget object from the database.

      Note: This method refreshes the attribute container with the values from database. Hence, if attribute container is having values that are modified in memory then, calling this method will replace those from database.


      Supported API: true
      Parameters:
      attributeName - The name of soft attribute.
      Returns:
      The soft attribute value.