Package com.ptc.windchill.uwgm.proesrv.c11n

Class DocIdentifier

java.lang.Object
com.ptc.windchill.uwgm.proesrv.c11n.DocIdentifier
public class DocIdentifier extends Object

An instance of this class holds the name, number and model name to be set on an EPMDocument to be created during upload from an authoring application and are validated by an instance of EPMDocumentNamingDelegate. It may also optionally hold parameters which may be validated by the same instance of EPMDocumentNamingDelegate but are not used anywhere else. Note that the instance of EPMDocumentNamingDelegate which is used to validate the contents of an instance of this class can also optionally set new name and number for the EPMDocument. These will be assigned to the new EPMDocument. While it is possible that the EPMDocumentNamingDelegate instance may also validate the optional parameters held by the instance of this class and delete/update them or create new ones, they are currently not being used anywhere during EPMDocument creation.



Supported API: true

Extendable: false

  • Constructor Details

    • DocIdentifier

      public DocIdentifier(String modelName, String docName, String docNumber, HashMap params)
      Initializes an instance of this class from the input arguments.

      Supported API: true
      Parameters:
      modelName - Model name of the EPMDocument to be created
      docName - Name of the EPMDocument to be created
      docNumber - Number of the EPMDocument to be created
      params - A HashMap holding parameters (currently not used during EPMDocument creation)

  • Method Details

    • getModelName

      public String getModelName()
      Returns the model name of the EPMDocument to be created.

      Supported API: true
      Returns:
      Model name of the EPMDocument to be created

    • getDocName

      public String getDocName()
      Returns the name of the EPMDocument to be created.

      Supported API: true
      Returns:
      Name of the EPMDocument to be created

    • setDocName

      public void setDocName(String docname)
      Sets the name of the EPMDocument to be created. A custom implementation of EPMDocumentNamingDelegate may use this method to create a new name (different from the one passed to the constructor of this class) for the EPMDocument.

      Supported API: true
      Parameters:
      docName - Name of the EPMDocument to be created

    • setDocNumber

      public void setDocNumber(String docnumber)
      Sets the number of the EPMDocument to be created. A custom implementation of EPMDocumentNamingDelegate may use this method to create a new number (different from the one passed to the constructor of this class) for the EPMDocument.

      Supported API: true
      Parameters:
      docNumber - Number of the EPMDocument to be created

    • getDocNumber

      public String getDocNumber()
      Returns the number of the EPMDocument to be created.

      Supported API: true
      Returns:
      Number of the EPMDocument to be created

    • getParameters

      public HashMap getParameters()
      Returns the parameters to be used during the creation of an EPMDocument. Note that currently these are not used anywhere during new EPMDocument creation.

      Supported API: true
      Returns:
      A HashMap holding the parameters to be used during the creation of an EPMDocument

    • setParameters

      public void setParameters(HashMap params)
      Stores the parameters to be used during the creation of an EPMDocument. A custom implementation of EPMDocumentNamingDelegate may use this method to update/delete/create parameters with values or even names different from the ones in the HashMap passed to the constructor of this class. However, currently these are not used anywhere during new EPMDocument creation.

      Supported API: true
      Parameters:
      params - A HashMap holding the parameters to be used during the creation of an EPMDocument