Package com.ptc.windchill.designasmsrv

Class CARBuilderHelper

java.lang.Object
com.ptc.windchill.designasmsrv.CARBuilderHelper
public class CARBuilderHelper extends Object
Creates:
- default CAD alternate representation(CAR) - CAR container, as ESR EPMDocument, based on specified parameters
- reference to top-level assembly, specified by name

* Note: Parameter esrTemplateName, with extension, can be set in ESRDocumentInfo
If not specified as parameter, must be configured in wt.properties for authored application types:
for Creo - com.ptc.windchill.designasmsrv.AssemblyDocumentFactory.nameOfCADESRTemplatelProE
for Catia - com.ptc.windchill.designasmsrv.AssemblyDocumentFactory.nameOfCADESRTemplatelCat
for Windchill - com.ptc.windchill.designasmsrv.AssemblyDocumentFactory.nameOfCADESRTemplatelWNC


Supported API: true

Extendable: false

  • Constructor Summary

    Constructors
    Constructor
    Description
    CARBuilderHelper()


    Supported API: true

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    buildDefaultCAR(WTPrincipal user, EPMAuthoringAppType authAppType, ESRDocumentInfo esrDocInfo, String topLevelAssemblyCADName, String epmWorkspaceName)
    Build default CAD alternate representation(CAR):
    - create ESR CAD assembly document, as CAR container, and reference to top level assembly, based on provided parameters
    - create CAD alternate representation(CAR) with default definition and result rules
    Note: configuration of esrTemplateName in the wt.properties is allowed only, if the default CAR is created programmatically.
    In this case, if esrTemplateName in ESRDocumentInfo is null, template name is used from the wt.properties, based on authAppType
    AlternateRepContainer
    getAlternateRepContainer()
    get created ESR document as AlternateRepContainer
    void
    setDesignContextPrefDefinition(String definitionName, boolean useExcludeAction)
    setDesignContextPrefDefinition() - optional Default definition name can be modified before buildDefaultCAR() call, to specify preference definition representation rule type to be used for creation default definition rules By default: prefDefinitionName - predefined actionDefaultRule - INCLUDE

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CARBuilderHelper

      public CARBuilderHelper()


      Supported API: true

  • Method Details

    • buildDefaultCAR

      public void buildDefaultCAR(WTPrincipal user, EPMAuthoringAppType authAppType, ESRDocumentInfo esrDocInfo, String topLevelAssemblyCADName, String epmWorkspaceName) throws WTException
      Build default CAD alternate representation(CAR):
      - create ESR CAD assembly document, as CAR container, and reference to top level assembly, based on provided parameters
      - create CAD alternate representation(CAR) with default definition and result rules
      Note: configuration of esrTemplateName in the wt.properties is allowed only, if the default CAR is created programmatically.
      In this case, if esrTemplateName in ESRDocumentInfo is null, template name is used from the wt.properties, based on authAppType
      Parameters:
      user - - WTPrincipal, optional, by default - user object is retrieved from session
      authAppType - - EPMAuthoringAppType, if null, default WINDCHILL AuthApplication used
      esrDocInfo - - required, ESRDocumentInfo, to set: esrCADName, esrTemplateName(with extension), wtContainer, wtOrganization, IBAs, and other parameters.
      topLevelAssemblyCADName - - required, String, top-level assembly CAD name(with extension)
      epmWorkspaceName - - String, EPMWorkspace name, required, to create ESR document in workspace
      Throws:
      WTException -

      Supported API: true

    • setDesignContextPrefDefinition

      public void setDesignContextPrefDefinition(String definitionName, boolean useExcludeAction)
      setDesignContextPrefDefinition() - optional Default definition name can be modified before buildDefaultCAR() call, to specify preference definition representation rule type to be used for creation default definition rules By default: prefDefinitionName - predefined actionDefaultRule - INCLUDE
      Parameters:
      definitionName -
      useExcludeActionDefaultRule - - boolean

      Supported API: true

    • getAlternateRepContainer

      public AlternateRepContainer getAlternateRepContainer() throws WTException
      get created ESR document as AlternateRepContainer
      Returns:
      AlternateRepContainer
      Throws:
      WTException -

      Supported API: true