Package com.ptc.windchill.option.load

Class Loader

java.lang.Object
com.ptc.windchill.option.load.Loader
public class Loader extends Object
Creates and persists ATO objects based on input from a xml load file. Loader supports load methods for following objects.

ATO Objects
  1. Group - com.ptc.windchill.option.model.Group
  2. Option - com.ptc.windchill.option.model.Option
  3. Choice - com.ptc.windchill.option.model.Choice
  4. Include Rule - com.ptc.windchill.option.model.ChoiceMapping
  5. Exclude Rule - com.ptc.windchill.option.model.ChoiceConstraint
  6. Enable Rule - com.ptc.windchill.option.model.ChoiceEnable
  7. Option Set - com.ptc.windchill.option.model.OptionSet
  8. OptionSetMemberLink - com.ptc.windchill.option.model.OptionSetMemberLink
  9. RegisteredOptionSetLink - com.ptc.windchill.option.model. RegisteredOptionSetLink
  10. ChoiceMappableChoiceLink - com.ptc.windchill.option.model.ChoiceMappableChoiceLink
  11. Navigation Criteria - wt.filter.NavigationCriteria
  12. Navigation Filter - wt.filter.NavigationFilter
  13. ExpressionMemberLink - wt.option.ExpressionMemberLink
  14. Independent Assigned Expression - IndependentAssignedExpression
  15. Expression Alias - ExpressionAlias

The load methods use a StandardLoadService cache to cache various objects to improve performance while creating objects.

Supported API: true

Extendable: false
See Also:

  • Method Details

    • createATONavigationFilterChoiceLink

      public static boolean createATONavigationFilterChoiceLink(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects)
      Processes the "csvATONavigationFilterChoiceLink" directive in the XML load file.

      Tag is used along with other choice mappable object such as csvBeginOccurrencedAssemblyAdd and csvEndOccurrencedAssemblyAdd etc.

      When using wt.load.LoadFromFile to load choice association with choice mappable object, use the following XML format:

      Create a group object.

      XML Format

      XML Format
      <csvATONavigationFilterChoiceLink handler= "com.ptc.windchill.option.load.Loader.createATONavigationFilterChoiceLink" >
        <csvchoiceName> choice name </csvchoiceName>
        <csvExclude> exclude choice Yes/No </csvExclude>
      </csvATONavigationFilterChoiceLink >


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      See Also:

    • createChoiceMappableChoiceLink

      public static boolean createChoiceMappableChoiceLink(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects)
      Processes the "csvChoiceMappableChoiceLink" directive in the XML load file.

      Tag is used along with other choice mappable object such as csvBeginOccurrencedAssemblyAdd and csvEndOccurrencedAssemblyAdd etc.

      When using wt.load.LoadFromFile to load choice association with choice mappable object, use the following XML format:

      Create a group object.

      XML Format

      XML Format
      <csvChoiceMappableChoiceLink handler= "com.ptc.windchill.option.load.Loader.createChoiceMappableChoiceLink" >
        <csvchoiceName> choice name </csvchoiceName>
        <csvExclude> exclude choice Yes/No </csvExclude>
      </csvChoiceMappableChoiceLink >


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      See Also:

    • createGroup

      public static boolean createGroup(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects)
      Processes the "csvOptionGroup" directive in the XML load file.

      Create a group object.

      When using wt.load.LoadFromFile to load group for option, use the following XML format:

      XML Format

      XML Format
      <csvOptionGroup handler="com.ptc.windchill.option.load.Loader.createGroup" >
        <csvname> group name </csvname>
        <csvoptionTypeDef> option type with which group is used </csvoptionTypeDef>
      </csvOptionGroup >


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      See Also:

    • beginOption

      public static boolean beginOption(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects)
      Processes the "csvBeginOption" directive in the XML load file.

      Create a option object.

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

      XML Format

      XML Format
      <csvBeginOption handler="com.ptc.windchill.option.load.Loader.beginOption" >
        <csvtypedef> option type to be created </csvtypedef>
        <csvname> option name </csvname>
        <csvnumber> option number </csvnumber>
        <csvdescription> option description </csvdescription>
        <csvoptionGroup> option group </csvoptionGroup>
        <csvrequiredOptionn> require selection for option true/false </csvrequiredOption>
        <csvsingleChoiceSelection> select single choice true/false </csvsingleChoiceSelection>
      </csvBeginOption >



      Supported API: true

      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      See Also:

    • endOption

      public static boolean endOption(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects)
      Processes csvEndOption directive loader xml.

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

      XML Format

      XML Format
      <csvEndOption handler= "com.ptc.windchill.option.load.Loader.endOption" />


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      See Also:

    • beginChoice

      public static boolean beginChoice(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects) throws WTException, WTPropertyVetoException
      Processes the "csvBeginChoice" directive in the XML load file.

      Create a choice object.

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

      XML Format

      XML Format
      <csvBeginChoice handler="com.ptc.windchill.option.load.Loader.beginOption" >
        <csvname> choice name </csvname>
        <csvnumber> choice number - If a value is specified then that value will be used. Otherwise the system will auto generate a number value. </csvnumber>
        <csvdescription> description of choice </csvdescription>
        <csvoption> option for choice </csvoption>
        <csvtypedef> choice type to be created </csvtypedef>
      </csvBeginChoice >


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      Throws:
      WTException
      WTPropertyVetoException
      See Also:

    • endChoice

      public static boolean endChoice(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects)
      Processes csvEndChoice directive loader xml.

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

      XML Format

      XML Format
      <csvEndChoice handler= "com.ptc.windchill.option.load.Loader.endChoice" />


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      See Also:

    • addChoice

      public static boolean addChoice(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects)
      Processes the "csvAddChoice" directive in the XML load file.

      Adds choice object to option set object.

      When using wt.load.LoadFromFile to load choices to be added to option set, use the following XML format:

      XML Format

      XML Format
      <csvAddChoice handler="com.ptc.windchill.option.load.Loader.addChoice" >
        <csvname> choice name </csvname>
        <csvoption> option name </csvoption>
        <csvcontainerPath> container of choice to search for choice to be added </csvcontainerPath>
        <csvstartDate> start date </csvstartDate>
        <csvendDate> end date </csvendDate>
      </csvAddChoice>


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      See Also:

    • beginCreateOptionSet

      public static boolean beginCreateOptionSet(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects)
      Processes the "csvBeginOptionSet" directive in the XML load file.

      Create a option set object.

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

      XML Format

      XML Format
      <csvBeginOptionSet handler="com.ptc.windchill.option.load.Loader.beginCreateOptionSet" >
        <csvname> option set name </csvname>
        <csvtypedef> option set type to be created </csvtypedef>
        <csvdescription> description of option set </csvdescription>
        <csvsupportExclusionOptionChoices> option set choice for exclusion true/false </csvsupportExclusionOptionChoices>
        <csvsupportItemOptionChoices> support choice association on items from this option set true/false </csvsupportItemOptionChoices>
        <csvreferenceOptionPoolRulesAutomatically> automatically reference rules from pool to this option set true/false </csvreferenceOptionPoolRulesAutomatically>
        <csvmanageLocalRuleChangesIndependently> allows rule changed to be managed independently from the option set true/false </csvmanageLocalRuleChangesIndependently>
      </csvBeginOptionSet>


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      See Also:

    • endCreateOptionSet

      public static boolean endCreateOptionSet(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects)
      Processes csvEndOptionSet directive loader xml.

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

      XML Format

      XML Format
      <csvEndOptionSet handler= "com.ptc.windchill.option.load.Loader.endCreateOptionSet" />


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      See Also:

    • beginCreateNavCriteria

      public static boolean beginCreateNavCriteria(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects)
      Processes the "csvBeginNavCriteria" directive in the XML load file.

      Create a navigation criteria object.

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

      XML Format

      XML Format
      <csvBeginNavCriteria handler="com.ptc.windchill.option.load.Loader.beginCreateNavCriteria" >
        <csvname> navigation criteria name </csvname>
        <csvuser> windchill user for whom navigation criteria is to be created </csvuser>
        <csvpartNumber> part number to which this criteria needs to be applied </csvpartNumber>
      </csvBeginNavCriteria>


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      See Also:

    • endNavCriteria

      public static boolean endNavCriteria(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects)
      Processes csvEndNavCriteria directive loader xml.

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

      XML Format

      XML Format
      <csvEndNavCriteria handler= "com.ptc.windchill.option.load.Loader.endNavCriteria" />


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      See Also:

    • beginCreateNavFilter

      public static boolean beginCreateNavFilter(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects)
      Processes the "csvBeginNavFilter" directive in the XML load file.

      Create a navigation filter object.

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

      XML Format

      XML Format
      <csvBeginNavFilter handler="com.ptc.windchill.option.load.Loader.beginCreateNavFilter" >
        <csvoptionSet> option set to be used for filter </csvoptionSet>   <csvfilterMode> filtermode set to 0, 1 or 2 for standard vs alternate filtering </csvfilterMode>
      </csvBeginNavFilter>


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      See Also:

    • endCreateNavFilter

      public static boolean endCreateNavFilter(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects) throws WTException
      Processes csvEndNavFilter directive loader xml.

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

      XML Format

      XML Format
      <csvEndNavFilter handler= "com.ptc.windchill.option.load.Loader.endCreateNavFilter" />


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      Throws:
      WTException - if cacheChoiceMappableObject does
      See Also:

    • beginChoiceMapping

      public static boolean beginChoiceMapping(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects) throws WTException
      Processes csvbeginChoiceMapping for choice mapping loader xml.

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

      XML Format

      XML Format
      <csvbeginChoiceMapping handler= "com.ptc.windchill.option.load.Loader.beginChoiceMapping">
        <csvsourceChoiceName> source choice name </csvsourceChoiceName>
        <csvname> name for the include rule (optional) if not given OIR will set the name </csvsourceChoiceNumber>
        <csvdescription> description for the include rule </csvdescription>
        <csvlocal> specify if local include rule </csvlocal>
        <csvoptionSet> name of option set where include rule is local </csvoptionSet>
        <csvcontainerPath> choice container path </csvcontainerPath>
      </csvbeginChoiceMapping>


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      Throws:
      WTException - if newChoiceMapping does
      See Also:

    • createChoiceMappingTargetChoice

      public static boolean createChoiceMappingTargetChoice(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects) throws WTException
      Processes csvChoiceMappingTargetChoice for choice mapping loader xml.

      When using wt.load.LoadFromFile to load target choices of include rule, use the following XML format:

      XML Format

      XML Format
      <csvChoiceMappingTargetChoice handler= "com.ptc.windchill.option.load.Loader.createChoiceMappingTargetChoice" >
        <csvtargetChoiceName> target choice name </csvtargetChoiceName>
        <csvcontainerPath> choice container path </csvcontainerPath>
      </csvChoiceMappingTargetChoice >


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      Throws:
      WTException - if createChoiceRuleTargetChoice does
      See Also:

    • endChoiceMapping

      public static boolean endChoiceMapping(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects) throws WTException
      Processes csvendChoiceMapping tag for choice mapping loader xml.

      When using wt.load.LoadFromFile to load include rule for choices, use the following XML format:

      XML Format

      XML Format
      <csvendChoiceMapping handler= "com.ptc.windchill.option.load.Loader.endChoiceMapping" />


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      Throws:
      WTException - if endChoiceRule does
      See Also:

    • beginChoiceConstraint

      public static boolean beginChoiceConstraint(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects) throws WTException
      Processes the "csvBeginChoiceConstraint" directive in the XML load file.

      Creates choice exclude rule by creating ChoiceConstraint object, and caches it in the loader's memory.

      When using wt.load.LoadFromFile to load exclude rule for choices, use the following XML format:

      XML Format

      XML Format
      <csvBeginChoiceConstraint handler= "com.ptc.windchill.option.load.Loader.beginChoiceConstraint" >
        <csvconstraintName> exclude rule name </csvconstraintName>
        <csvconstraintDescription> exclude rule description </csvconstraintDescription>
        <csvlocal> specify if local constraint </csvlocal>
        <csvoptionSet> name of option set where exclude rule is local </csvoptionSet>
      </csvBeginChoiceConstraint >
       

      Tag Definitions

      Tag Definitions
         
      constraintName The name of the choices exclude rule. A value is required for this attribute.
         
      constraintDescription The description of the choices exclude rule. A value is optional for this attribute.
         
      local This specifies if exclude rule is local for option set or global exclude rule. This attribute can be true or false. A value is optional for this attribute.
         
      optionSet The name of options set for which constraint is local. A value is required for this attribute when local attribute is set to true otherwise optional.
         


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      Throws:
      WTException - if newChoiceConstraint does
      See Also:

    • constraintChoice

      public static boolean constraintChoice(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<Choice> return_objects) throws WTException
      Processes the "csvConstraintChoice" directive in the XML load file.

      Loads exclude rule choices by searching windchill database, and caches it in the loader's memory. These objects are then used by endChoiceConstraint method to create the ChoiceConstraintChoiceLink object for creating exclude rule for choices.

      When using wt.load.LoadFromFile to load exclude rule for choices, use the following XML format:

      XML Format

      XML Format
      <csvConstraintChoice handler="com.ptc.windchill.option.load.Loader.constraintChoice" >
        <csvname> exclude rule choice name </csvname>
        <csvcontainerPath> choice container path </csvcontainerPath>
      </csvConstraintChoice >
       

      Tag Definitions

         
      csvname The name of the choice. A value is required for this attribute.
         
      containerPath The container path to search choice in specified container. A value if specified is used otherwise will use container path provided in load command to search choices.
         


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      Throws:
      WTException - if getChoice does
      See Also:

    • endChoiceConstraint

      public static boolean endChoiceConstraint(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects) throws WTException
      Processes the "csvEndChoiceConstraint" directive in the csv load file. Uses the cached choice to create the ChoiceConstraintChoiceLink between choices and exclude rule from preceding csvConstraintChoice load file lines, persists the distribution target link and clears the caches from the loader's memory.

      When using wt.load.LoadFromFile to load exclude rule for choices, use the following XML format:

      XML Format

      XML Format
      <csvEndChoiceConstraint handler= "com.ptc.windchill.option.load.Loader.endChoiceConstraint" />


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      Throws:
      WTException - if endChoiceRule does
      See Also:

    • registerOptionSet

      public static boolean registerOptionSet(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects)
      Processes the "csvRegisterOptionSet" directive in the XML load file.

      Registers a option set with a container.

      When using wt.load.LoadFromFile to load registered option set use the following XML format:

      XML Format

      XML Format
      <csvRegisterOptionSet handler="com.ptc.windchill.option.load.Loader.registerOptionSet" >
        <csvname> option set name </csvname>
        <csvstate> state </csvstate>
        <csvoptionSetContainerPath> container of the option set </csvoptionSetContainerPath>
        <csvOptionSetAssignableClass> OptionSetAssignable Class </csvOptionSetAssignableClass>
        <csvOptionSetAssignableNumber> OptionSetAssignable Number </csvOptionSetAssignableNumber>
      </csvRegisterOptionSet>


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      result
      true success
      false failure
      See Also:

    • beginChoiceEnable

      public static boolean beginChoiceEnable(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects) throws WTException
      Processes csvbeginChoiceEnable for choice enable loader xml.

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

      XML Format

      <csvbeginChoiceEnablehandler= "com.ptc.windchill.option.load.Loader.beginChoiceEnable">
        <csvsourceChoiceName> source choice name </csvsourceChoiceName>
        <csvname> name for the enable rule (optional) if not given OIR will set the name </csvsourceChoiceNumber>
        <csvdescription> description for the enable rule </csvdescription>
        <csvlocal> specify if local enable rule </csvlocal>
        <csvoptionSet> name of option set where enable rule is local </csvoptionSet>
        <csvcontainerPath> choice container path </csvcontainerPath>
      </csvbeginChoiceEnable>


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      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
      Throws:
      WTException
      See Also:

    • createChoiceEnableTargetChoice

      public static boolean createChoiceEnableTargetChoice(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects) throws WTException
      Processes csvChoiceEnableTargetChoice for choice enable loader xml.

      When using wt.load.LoadFromFile to load target choices of enable rule, use the following XML format:

      XML Format

      <csvChoiceEnableTargetChoice handler= "com.ptc.windchill.option.load.Loader.createChoiceEnableTargetChoice" >
        <csvtargetChoiceName> target choice name </csvtargetChoiceName>
        <csvcontainerPath> choice container path </csvcontainerPath>
      </csvChoiceEnableTargetChoice >


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      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
      Throws:
      WTException
      See Also:

    • endChoiceEnable

      public static boolean endChoiceEnable(Hashtable<String,String> nv, Hashtable<String,Object> cmd_line, Vector<?> return_objects) throws WTException
      Processes csvendChoiceEnable tag for choice enable loader xml.

      When using wt.load.LoadFromFile to load include rule for choices, use the following XML format:

      XML Format

      <csvendChoiceEnable handler= "com.ptc.windchill.option.load.Loader.endChoiceEnable" />


      Supported API: true
      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmd_line - command line argument that can contain supplemental load data. The cmd_line parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      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
      Throws:
      WTException
      See Also: