com.ptc.windchill.esi.esidoc
Class PartDocInfo

java.lang.Object
  com.ptc.windchill.esi.esidoc.PartDocInfo

All Implemented Interfaces:

Externalizable, Serializable

public class PartDocInfo
extends Object
implements Externalizable

Represents document information identified for export by the retrievePartDocInformation and retrievePartDocDifferences methods of the WTPartService.

Supported API: true

Extendable: false

See Also:

Serialized Form

Method Summary

protected static Hashtable	buildHashtable(WTPart part) Supported API: true
Document	getDocument() Gets the value of the attribute: document; Returns an item that is used to document a part.
String	getDocumentType() Gets the value of the attribute: documentType; The string representation of the associated document types.
String	getDocumentURL() Gets the value of the attribute: documentURL; The URL to the details page of the associated document.
WTPart	getPart() Gets the value of the attribute: part; Returns the part for this PartDocInfo.
ObjectToObjectLink	getPartDocLink() Gets the value of the attribute: partDocLink; The part to document link that was used to construct this PartUsageInfo.
protected void	processForAdd() This method is intended to be overriden by a customizer who extends PartDocInfo.
protected void	processForDelete() This method is intended to be overriden by a customizer who extends PartDocInfo.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getDocument

public Document getDocument()

Gets the value of the attribute: document; Returns an item that is used to document a part. The document could be one of the following: an instance of a WTDocument or an instance of an EPMDocument. Since both of these objects are persisted in the database, they can be cast to wt.fc.Persistable.

Supported API: true

Returns:

Document

getPart

public WTPart getPart()

Gets the value of the attribute: part; Returns the part for this PartDocInfo.

Supported API: true

Returns:

WTPart

getPartDocLink

public ObjectToObjectLink getPartDocLink()

Gets the value of the attribute: partDocLink; The part to document link that was used to construct this PartUsageInfo.

Supported API: true

Returns:

ObjectToObjectLink

getDocumentURL

public String getDocumentURL()

Gets the value of the attribute: documentURL; The URL to the details page of the associated document.

Supported API: true

Returns:

String

getDocumentType

public String getDocumentType()

Gets the value of the attribute: documentType; The string representation of the associated document types.

Supported API: true

Returns:

String

buildHashtable

protected static Hashtable buildHashtable(WTPart part)
                                   throws WTException

Supported API: true

Parameters:

part -

Returns:

Hashtable

Throws:

WTException

processForAdd

protected void processForAdd()

This method is intended to be overriden by a customizer who extends PartDocInfo. The method is available should the information stored in this object need to be processed in the event that documents have been added to the part. The customizer must invoke this method for the superclass as its first statement.

Supported API: true

processForDelete

protected void processForDelete()

This method is intended to be overriden by a customizer who extends PartDocInfo. The method is available should the information stored in this object need to be processed in the event that the a document has been removed from a part. The customizer must invoke this method for the superclass as its first statement.

Supported API: true