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

Field Summary

private static String	CLASSNAME
private static ApplicationContextServices	delegateFactory
private Document	document
private String	documentType
private String	documentURL
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private WTPart	part
private ObjectToObjectLink	partDocLink
private static String	RESOURCE
(package private) static long	serialVersionUID

Constructor Summary

PartDocInfo()

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.
protected Object	getKey()
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.
private void	initialize(BuildHistory partDocAssoc)
private void	initialize(IteratedDescribeLink partDocAssoc)
private void	initialize(Persistable[] partDocAssoc)
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.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(PartDocInfo thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
protected void	setDocumentType(Document doc)
protected void	setDocumentURL(Document doc)
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

document

private Document document

part

private WTPart part

partDocLink

private ObjectToObjectLink partDocLink

documentURL

private String documentURL

documentType

private String documentType

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

delegateFactory

private static final ApplicationContextServices delegateFactory

Constructor Detail

PartDocInfo

public PartDocInfo()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(PartDocInfo thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

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

getKey

protected Object getKey()

setDocumentType

protected void setDocumentType(Document doc)

setDocumentURL

protected void setDocumentURL(Document doc)

initialize

private void initialize(Persistable[] partDocAssoc)

initialize

private void initialize(IteratedDescribeLink partDocAssoc)

initialize

private void initialize(BuildHistory partDocAssoc)