com.ptc.windchill.esi.rnd
Class ESIObjectHistoryBuilderImpl

java.lang.Object
  com.ptc.windchill.esi.rnd.ESIObjectHistoryBuilderImpl

All Implemented Interfaces:

ESIObjectHistoryBuilder, Externalizable, Serializable

public class ESIObjectHistoryBuilderImpl

extends Object

implements ESIObjectHistoryBuilder, Externalizable

The default implementation of the ESIObjectHistoryBuilder interface.

Supported API: true

Extendable: true

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private Group	groupOut
private String	groupOutName
(package private) ESIMap	map
protected static String	MAP_NAME
(package private) ESIMapper	mapper
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Constructor Summary

ESIObjectHistoryBuilderImpl()

Method Summary

void	addElement(ReleaseActivity ra) Maps the argument.
protected void	adjustElement(Element element, Persistable object) Modifies the contents of an element before adding it to the output group.
Group	getGroup() Returns the groupOut attribute.
protected Group	getGroupOut() Gets the value of the attribute: groupOut.
protected String	getGroupOutName() Gets the value of the attribute: groupOutName; The name of the I*E group to create on output.
private void	groupOutNameValidate(String a_GroupOutName)
private Element	mapElement(ReleaseActivity ra)
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(ESIObjectHistoryBuilderImpl thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setData(String groupOutName) Establishes the state of the object so that it is ready to process requests.
protected void	setGroupOut(Group a_GroupOut) Sets the value of the attribute: groupOut.
protected void	setGroupOutName(String a_GroupOutName) Sets the value of the attribute: groupOutName; The name of the I*E group to create on output.
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

groupOutName

private String groupOutName

groupOut

private Group groupOut

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

MAP_NAME

protected static final String MAP_NAME

map

ESIMap map

mapper

ESIMapper mapper

Constructor Detail

ESIObjectHistoryBuilderImpl

public ESIObjectHistoryBuilderImpl()

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(ESIObjectHistoryBuilderImpl 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

getGroupOutName

protected String getGroupOutName()

Gets the value of the attribute: groupOutName; The name of the I*E group to create on output.

Supported API: true

Returns:

String

setGroupOutName

protected void setGroupOutName(String a_GroupOutName)
                        throws WTPropertyVetoException

Sets the value of the attribute: groupOutName; The name of the I*E group to create on output.

Supported API: true

Parameters:

a_GroupOutName -

Throws:

WTPropertyVetoException

groupOutNameValidate

private void groupOutNameValidate(String a_GroupOutName)
                           throws WTPropertyVetoException

Parameters:

a_GroupOutName -

Throws:

WTPropertyVetoException

getGroupOut

protected Group getGroupOut()

Gets the value of the attribute: groupOut.

Supported API: false

Returns:

Group

setGroupOut

protected void setGroupOut(Group a_GroupOut)
                    throws WTPropertyVetoException

Sets the value of the attribute: groupOut.

Supported API: false

Parameters:

a_GroupOut -

Throws:

WTPropertyVetoException

setData

public void setData(String groupOutName)
             throws WTException

Establishes the state of the object so that it is ready to process requests.

Supported API: true

Specified by:

setData in interface ESIObjectHistoryBuilder

Parameters:

groupOutName - The name to use when creating the output Info*Engine Group object.

Throws:

WTException

addElement

public void addElement(ReleaseActivity ra)
                throws WTException

Maps the argument. Calls the mapper to create an Info*Engine element from the argument. Calls adjustElement(), then adds the result to the output collection in the groupOut attribute.

Supported API: false

Specified by:

addElement in interface ESIObjectHistoryBuilder

Parameters:

ra -

Throws:

WTException

getGroup

public Group getGroup()

Returns the groupOut attribute. The method returns the result of getGroupOut(), which is a lazy initializer.

Supported API: true

Specified by:

getGroup in interface ESIObjectHistoryBuilder

Returns:

Group

adjustElement

protected void adjustElement(Element element,
                             Persistable object)
                      throws WTException

Modifies the contents of an element before adding it to the output group. This method is provided as a convenience to subclasses. Default behaviour to do nothing.

Supported API: true

Parameters:

element -

object -

Throws:

WTException

mapElement

private Element mapElement(ReleaseActivity ra)
                    throws WTException

Throws:

WTException