Package com.ptc.core.businessfield.common

Interface BusinessFieldIdFactory

public interface BusinessFieldIdFactory
Public interface for constructing business field identifiers. This should be the *one* place where it's acceptable to use String's when referring to types, attributes, attribute templates, etc.
Note: This assumes the solution is Windchill.

Supported API: true

Extendable: false

  • Method Details

    • getBusinessFieldIdentifier

      BusinessFieldIdentifier getBusinessFieldIdentifier(String name, BusinessFieldNamespaceIdentifier namespace) throws WTException
      Get a business field identifier for the specified field in the given namespace.

      Supported API: true
      Parameters:
      name - The name of the business field to get the identifier for.
      namespace - The namespace the field belongs to.
      Returns:
      The requested business field identifier.
      Throws:
      WTException - If there were errors retrieving the identifier.

    • getTypeBusinessFieldIdentifier

      BusinessFieldIdentifier getTypeBusinessFieldIdentifier(String name, String typeName) throws WTException
      Get the business field identifier for the type. This is not limited to just type definitions, but supports non-typed classes also.

      Supported API: true
      Parameters:
      name - The name of the business field to get.
      typeName - The name of the type/class the field belongs to.
      Returns:
      The business field identifier.
      Throws:
      WTException - If there were errors retrieving the identifier.

    • getTypeBusinessFieldIdentifier

      BusinessFieldIdentifier getTypeBusinessFieldIdentifier(String name, TypeIdentifier typeIdentifier) throws WTException
      Get the business field identifier for the type.

      Supported API: true
      Parameters:
      name - The name of the business field to get.
      typeIdentifier - The identifier of the type/class the field belongs to.
      Returns:
      The business field identifier.
      Throws:
      WTException - If there were errors retrieving the identifier.

    • getAdHocBusinessFieldIdentifier

      BusinessFieldIdentifier getAdHocBusinessFieldIdentifier(String name) throws WTException
      Get the adhoc business field identifier.

      Supported API: true
      Parameters:
      name - The name of the iba definition.
      Returns:
      The business field identifier.
      Throws:
      WTException - If there were errors retrieving the identifier.

    • getTypeBusinessFieldNamespaceIdentifier

      BusinessFieldNamespaceIdentifier getTypeBusinessFieldNamespaceIdentifier(String typeName) throws WTException
      Get the type namespace identifier for the specified type. This is not limited to just type definitions, but supports non-typed classes also.

      Supported API: true
      Parameters:
      typeName - The name of the type/class to get the namespace identifier for.
      Returns:
      The namespace identifier.
      Throws:
      WTException - If there were errors retrieving the identifier.

    • getAdHocBusinessFieldNamespaceIdentifier

      BusinessFieldNamespaceIdentifier getAdHocBusinessFieldNamespaceIdentifier() throws WTException
      Get the adhoc namespace identifier.

      Supported API: true
      Returns:
      The adhoc namespace identifier.
      Throws:
      WTException - If there were errors retrieving the identifier.