Package com.ptc.windchill.mpml.processplan.sequence

Class LoadSequence

java.lang.Object

com.ptc.windchill.mpml.processplan.sequence.LoadSequence

public class LoadSequence
extends Object

Creates and persists MPMSequence objects based on input from a XML file Method names and parameters are defined in csvmapfile.txt.

Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
static boolean	beginSequence(Hashtable nv, Hashtable cmd_line, Vector return_objects)	Processes the "csvBeginSequence" directive in the XML load file.
static boolean	beginSequenceUsageLink(Hashtable nv, Hashtable cmd_line, Vector return_objects)	Processes the "csvBeginSequenceUsageLink" directive in the XML load file.
static boolean	createSequence(Hashtable nv, Hashtable cmd_line, Vector return_objects)	Processes the "csvCreateSequence" directive in the XML load file.
static boolean	createSequenceRepresentation(Hashtable nv, Hashtable cmd_line, Vector return_objects)	Processes the "createSequenceRepresentation" directive in the csv load file.
static boolean	createSequenceUsageLink(Hashtable nv, Hashtable cmd_line, Vector return_objects)	Processes the "csvCreateSequenceUsageLink" directive in the XML load file.
static boolean	endSequence(Hashtable nv, Hashtable cmd_line, Vector return_objects)	Processes the "csvEndSequence" directive in the csv load file.
static boolean	endSequenceUsageLink(Hashtable nv, Hashtable cmd_line, Vector return_objects)	Processes the "csvEndSequenceUsageLink" directive in the csv load file.

Methods inherited from class java.lang.Object

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

Method Details

beginSequence

public static boolean beginSequence(Hashtable nv,
 Hashtable cmd_line,
 Vector return_objects)

Processes the "csvBeginSequence" directive in the XML load file. This format CAN add Soft Attributes(IBA). For more info on the csvformat and other information see createSequence.

XML Format

<csvBeginSequence handler="com.ptc.windchill.mpml.processplan.sequence.LoadSequence.beginSequence" >
</csvBeginSequence >
<csvIBAValue handler="wt.iba.value.service.LoadValue.createIBAValue" >
	...
</csvIBAValue >
<csvEndSequence handler="com.ptc.windchill.mpml.processplan.sequence.LoadSequence.endSequence" >
	...
</csvEndSequence >

Supported API: true

endSequence

public static boolean endSequence(Hashtable nv,
 Hashtable cmd_line,
 Vector return_objects)

Processes the "csvEndSequence" directive in the csv load file. Causes the cached Sequence to be checked-out, associates soft attribues from preceding IBAValue load file lines with the Sequence, applies the default attribute values associated with the specified type definition, persists the object, checks it back in, and caches it in the loader's memory.

XML Format

<csvEndSequence handler="com.ptc.windchill.mpml.processplan.sequence.LoadSequence.endSequence" >

</csvEndSequence >

Tag Definitions

Supported API: true

See Also:

• beginSequence(java.util.Hashtable, java.util.Hashtable, java.util.Vector)

createSequence

public static boolean createSequence(Hashtable nv,
 Hashtable cmd_line,
 Vector return_objects)

Processes the "csvCreateSequence" directive in the XML load file. Creates a Sequence object, persists it in the database, checks it out, applies the default attribute values associated with the specified type definition, persists the Sequence, checks it back in, and caches it in the loader's memory.

If a Sequence with this number already exists, the Sequence is looked up and a new iteration of the latest revision is created, unless the revision/iteration are specified using attributes in the the load file.

This format cannot add Soft Attributes(IBA). For that see beginSequence.

When using wt.load.LoadFromFile to load Sequence, use the following XML format:

XML Format (only Sequence specific ones are described, rest are same as for part)

<csvCreateSequence handler="com.ptc.windchill.mpml.processplan.sequence.LoadSequence.createSequence" >
	<csvuser>	created by user	</csvuser>
	<csvname>	name of processplan	</csvname>
	<csvnumber>	unique number	</csvnumber>
	<csvdefaultUnit>	default Unit	</csvdefaultUnit>
	<csvfolder>	folder	</csvfolder>
	<csvlifecycle>	lifecycle	</csvlifecycle>
	<csvview>	view	</csvview>
	<csvteamTemplate>	team template	</csvteamTemplate>
	<csvlifecyclestate>	lifecycle state	</csvlifecyclestate>
	<csvtypedef>	typedef	</csvtypedef>
	<csvversion>	revision	</csvversion>
	<csviteration>	iteration	</csviteration>
	<csvorganizationName>	organization name	</csvorganizationName>
	<csvorganizationID>	organization id	</csvorganizationID>
	<csvcreateTimestamp>	creation time stamp	</csvcreateTimestamp>
	<csvmodifyTimestamp>	modification time stamp	</csvmodifyTimestamp>
</csvCreateSequence>

Tag Definitions

Revisions and Iterations

This method follows the standard used by LoadPart for the revisions and iterations

Supported API: true

Parameters:

nv - Name/Value pairs of Sequence attributes.

cmd_line - command line argument that can contain supplemental load data

return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.

Returns:

true	success
false	failure

beginSequenceUsageLink

public static boolean beginSequenceUsageLink(Hashtable nv,
 Hashtable cmd_line,
 Vector return_objects)

Processes the "csvBeginSequenceUsageLink" directive in the XML load file. This format CAN add Soft Attributes(IBA). For more info on the csvformat and other information see createSequenceUsageLink.

XML Format

<csvBeginSequenceUsageLink handler="com.ptc.windchill.mpml.processplan.sequence.LoadSequence.beginSequenceUsageLink" >
</csvBeginSequenceUsageLink >
<csvIBAValue handler="wt.iba.value.service.LoadValue.createIBAValue" >
	...
</csvIBAValue >
<csvEndSequenceUsageLink handler="com.ptc.windchill.mpml.processplan.sequence.LoadSequence.endSequenceUsageLink" >
	...
</csvEndSequenceUsageLink >

Supported API: true

endSequenceUsageLink

public static boolean endSequenceUsageLink(Hashtable nv,
 Hashtable cmd_line,
 Vector return_objects)

Processes the "csvEndSequenceUsageLink" directive in the csv load file. Causes the cached SequenceUsageLink to be checked-out, associates soft attribues from preceding IBAValue load file lines with the SequenceUsageLink, applies the default attribute values associated with the specified type definition, persists the object, checks it back in, and caches it in the loader's memory.

XML Format

<csvEndSequenceUsageLink handler="com.ptc.windchill.mpml.processplan.sequence.LoadSequence.endSequenceUsageLink" >

</csvEndSequenceUsageLink >

Tag Definitions

Supported API: true

See Also:

• beginSequenceUsageLink(java.util.Hashtable, java.util.Hashtable, java.util.Vector)

createSequenceUsageLink

public static boolean createSequenceUsageLink(Hashtable nv,
 Hashtable cmd_line,
 Vector return_objects)

Processes the "csvCreateSequenceUsageLink" directive in the XML load file. Creates a SequenceUsageLink object, persists it in the database, checks it out, applies the default attribute values associated with the specified type definition, persists the SequenceUsageLink, checks it back in, and caches it in the loader's memory.

This format cannot add Soft Attributes(IBA). For that see beginSequenceUsageLink.

When using wt.load.LoadFromFile to load SequenceUsageLink, use the following XML format:

XML Format (only SequenceUsageLink specific ones are described, rest are same as for part)

<csvCreateSequenceUsageLink handler="com.ptc.windchill.mpml.processplan.sequence.LoadSequence.createSequenceUsageLink" >
	<csvtypedef>	Type definition	</csvtypedef>
	<csvparentNumber>	SequenceHolder Number	</csvparentNumber>
	<csvparentType>	SequenceHolder Type	</csvparentType>
	<csvparentVersion>	SequenceHolder Version	</csvparentVersion>
	<csvparentIteration>	SequenceHolder Iteration	</csvparentIteration>
	<csvparentView>	SequenceHolder View	</csvparentView>
	<csvchildNumber>	Sequence Number	</csvchildNumber>
	<csvseqLinkNumber>	SequenceLink number	</csvseqLinkNumber>
	<csvseqBranchingOpLabel>	BranchOperationLabel	</csvseqBranchingOpLabel>
	<csvseqReturnOpLabel>	ReturnOperationLabel	</csvseqReturnOpLabel>
	<csvcategory>	category	</csvcategory>
</csvCreateSequenceUsageLink>

Tag Definitions

Sequence Number	Sequence number. This is optional attribute, if not specified its calculated internally
SequenceHolder Number (Mandatory)	The number of the parent to which the sequence will be associated. This is mandatory attribute, and must have a valid number of an existing parent
SequenceHolder Type (Mandatory)	Tells the type of parent to which sequence should be associated. This is mandatory attribute Valid values are 'processplan', 'sequence'
BranchOperationLabel	OperationLabel of the operation from which the sequence will branch out. Optional atrribute Valid values are operationLabel of any operation immediately under the parent of the sequence Note this must not be same as ReturnOperationLabel if that is also specified
ReturnOperationLabel (Mandatory)	OperationLabel of the operation to which the sequence will return. This is mandatory attribute Valid values are operationLabel of any operation immediately under the parent of the sequence Note this must not be same as BranchOperationLabel if that is also specified
category (Mandatory)	The category value for the sequence. Valid values are 'parallel', 'alternate'

Supported API: true

Parameters:

nv - Name/Value pairs of SequenceUsageLink attributes.

cmd_line - command line argument that can contain supplemental load data

return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.

Returns:

true	success
false	failure

createSequenceRepresentation

public static boolean createSequenceRepresentation(Hashtable nv,
 Hashtable cmd_line,
 Vector return_objects)

Processes the "createSequenceRepresentation" directive in the csv load file. Imports the information to create a Representation, and associate it with Sequence

Parameters:

nv - Name/Value pairs of arguments. The arguments are as follows:

• parentNumber : Number of the sequence
• parentVersion
• parentIteration
• parentView
• repName : Name of the representation.
• repDirectory: Directory of the representation. Its relative to WTHome
• repDefault
• repCreateThumbnail : Create thumbnail or not. Valid values 'true', 'false'
• repStoreEdz

Supported API: true

cmd_line - command line argument that can contain supplemental load data

return_objects - Vector of the object(s) created by this method.