com.ptc.windchill.esi.tgt
Class ESITarget

java.lang.Object
  wt.fc.WTObject
      wt.fc.Item
          com.ptc.windchill.esi.tgt.ESITarget

All Implemented Interfaces:

Externalizable, Serializable, AccessControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, Identified, NetFactor, ObjectMappable, Persistable, UniquelyIdentified, DisplayIdentification, WTContained, WTContainedIdentified, wt.recent.RecentlyVisited

public class ESITarget
extends Item
implements WTContained, WTContainedIdentified, UniquelyIdentified, Externalizable

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:

Serialized Form

Field Summary

static String	DESCRIPTION Label for the attribute; A user-friendly textual description of the target Supported API: true
static String	NAME Label for the attribute; Name of the organization Supported API: true
static String	SYSTEM Label for the attribute.

Method Summary

String	getDescription() Gets the value of the attribute: DESCRIPTION.
IdentificationObject	getIdentificationObject() Supported API: true
String	getName() Gets the value of the attribute: NAME.
String	getObjectID() Return the UFID of this ESITarget object.
String	getSystem() Gets the value of the attribute: SYSTEM.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setSystem(String a_System) Sets the value of the attribute: SYSTEM.

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

Label for the attribute; Name of the organization

Supported API: true

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute; A user-friendly textual description of the target

Supported API: true

See Also:

Constant Field Values

SYSTEM

public static final String SYSTEM

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getName

public String getName()

Gets the value of the attribute: NAME. Name of the organization

Supported API: true

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME. Name of the organization

Supported API: true

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION. A user-friendly textual description of the target

Supported API: true

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION. A user-friendly textual description of the target

Supported API: true

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getSystem

public String getSystem()

Gets the value of the attribute: SYSTEM.

Supported API: true

Returns:

String

setSystem

public void setSystem(String a_System)
               throws WTPropertyVetoException

Sets the value of the attribute: SYSTEM.

Supported API: true

Parameters:

a_System -

Throws:

WTPropertyVetoException

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

Supported API: true

Specified by:

getIdentificationObject in interface Identified

Returns:

IdentificationObject

Throws:

WTException