Package com.ptc.windchill.option.variantspec.loader

Class VariantSpecificationLoader

java.lang.Object

com.ptc.windchill.option.variantspec.loader.VariantSpecificationLoader

All Implemented Interfaces:

Serializable

public class VariantSpecificationLoader
extends Object
implements Serializable

Processes the "csvBeginVariantSpecification,csvVariantSpecification,csvEndVariantSpecification" directives in the XML load file These directives can be used to create variant specifications associated with option Set and managed option filter variant specifications Below example shows sample snippet for create both types of variant specifications FullyDefinedOptionSetAssociatedVariantSpecification Fully Defined Option Set Associated Variant Specification Nav_Criteria_1 ManagedOptionFilter/csvvariantspecname> Managed Option Filter Nav_Criteria_2
Supported API: true
Extendable: false

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static boolean	beginVariantSpecifications(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects)	Processes the "csvBeginVariantSpecification" directive in the XML load file.
static boolean	createVariantSpec(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects)	Supported API: true Extendable: false Processes the "csvVariantSpecification" directive in the XML load file.
static boolean	endVariantSpecifications(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects)	Processes the "csEndVariantSpecification" directive in the XML load file.

Methods inherited from class java.lang.Object

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

Method Details

beginVariantSpecifications

public static boolean beginVariantSpecifications(Hashtable<String,String> nv,
 Hashtable<String,Object> cmd_line,
 Vector<?> return_objects)
                                          throws WTException

Processes the "csvBeginVariantSpecification" directive in the XML load file. This is beginning tag for a providing variant specifications. Should be followed by csvVariantSpecification or csvEndVariantSpecification tags. csvEndVariantSpecification should be present if csvBeginVariantSpecification is provided

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

XML Format

<csvBeginVariantSpecification handler="com.ptc.windchill.option.variantspec.loader.VariantSpecificationLoader.beginVariantSpecifications" >

</csvBeginVariantSpecification >

Supported API: true

Extendable: false

Throws:

WTException

endVariantSpecifications

public static boolean endVariantSpecifications(Hashtable<String,String> nv,
 Hashtable<String,Object> cmd_line,
 Vector<?> return_objects)

Processes the "csEndVariantSpecification" directive in the XML load file. This is beginning tag for a providing variant specifications. csvBeginVariantSpecification should be present if csEndVariantSpecification is provided

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

XML Format

<csEndVariantSpecification handler="com.ptc.windchill.option.variantspec.loader.VariantSpecificationLoader.endVariantSpecifications" >

</csEndVariantSpecification >

Supported API: true

Extendable: false

createVariantSpec

public static boolean createVariantSpec(Hashtable<String,String> nv,
 Hashtable<String,Object> cmd_line,
 Vector<?> return_objects)
                                 throws WTPropertyVetoException

Supported API: true

Extendable: false Processes the "csvVariantSpecification" directive in the XML load file. Creates a variant specifications associated with option set, persists it in the database, checks it out, applies the default attribute values associated with the specified type definition, persists the variant specification.

This API cannot add Soft Attributes(IBA). This API supports creation of variant specification associated with option set invalid input: '&' Managed option filter.

When using wt.load.LoadFromFile to load variant specification associated with Option set or managed option filter, use the following XML format:

XML Format

<csvPart handler="com.ptc.windchill.option.variantspec.loader.VariantSpecificationLoader.createVariantSpec" >
	<csvname>	variant specification name	</csvname>
	<csvnumber>	variant specification number	</csvnumber>
	<csvdescription>	description	</csvdescription>
	<csvfolder>	folder location	</csvfolder>
	<csvnavcriteria>	navigation criteria	</csvnavcriteria>
</csvVariantSpecification>

Tag Definitions

csvname	This tag allows to specify name by which variant specification will be generated. This value is optional. If this value is not specified, csvnumber value will be used to edit variant specification.
csvnumber	The number of the variant specification. This value is optional. If a number is provided, a search will be done to locate a variant specification with this number. If a variant specification is found, a new revision/iteration of the variant specification will be created, and if it is not found, a new variant specification will be created. If a number is not provided invalid input: '&' variant specification name is provided , a new variant specification will be created and the next system-generated number will be used.
csvdescription	The description of the variant specification. This value is optional.
csvfolder	The folder location of the variant specification. This tag is optional.
csvnavcriteria	the navigation criteria name. This tag is must. This name should be csvname of csvBeginNavCriteria tag. All the information related to naviation criteria like part configuration specifications, option filter configuration specifications, options invalid input: '&' choices will be referred from csvBeginNavCriteria tag matching with this name.

Throws:

WTPropertyVetoException