Package com.ptc.windchill.esi.svc

Class ESIHelper

java.lang.Object
com.ptc.windchill.esi.svc.ESIHelper
All Implemented Interfaces:
Externalizable, Serializable
public final class ESIHelper extends Object implements Externalizable
Provides access to the ESIService implementation and provides several generally useful utility methods.

Supported API: true

Extendable: false
See Also:

  • Field Details

    • service

      public static final ESIService service


      Supported API: true

  • Method Details

    • hasESITargets

      public static boolean hasESITargets(Persistable anObject) throws WTException
      Returns true if the given object has ESI target assignments.

      Supported API: true
      Parameters:
      anObject -
      Returns:
      boolean
      Throws:
      WTException

    • isReleaseNeeded

      public static boolean isReleaseNeeded(Persistable persistable)
      Returns a true if the preference "Enforce Changes" has a value "No". If the preference has a value "Yes", and if the input object is a Change Notice, the method returns a true only if (i) the object is not released yet and (ii) there is at least one resulting object in the Change Notice that is not released yet (this check however is applicable only if the preference "Enforce Changes To Resulting Objects" has a value "Yes"); if the input Persistable is any other object, the method returns a true if the object is not released yet, and a false otherwise.

      Supported API: true
      Parameters:
      persistable - The input Persistable object
      Returns:
      boolean true, if the preference "Enforce Changes" has a value "No"; if the preference has a value "Yes", a value is returned depending on whether or not the input object is already released.

    • isTxActive

      public static boolean isTxActive(Persistable obj) throws ESIException
      Returns true if a transaction is active for the supplied object. Delegates to a method of ESIReleaseUtility, where all the useful work is done. NOTE: The supplied object does not need to be the root (primary) object in a transaction, simply one of the pending published objects in a transaction.

      Supported API: true
      Parameters:
      obj -
      Returns:
      boolean
      Throws:
      ESIException

    • getReleaseStatusURL

      public static String getReleaseStatusURL(String releaseUfid)
      Returns a URL associated with the given ESIRelease UFID for the Enterprise Systems Transaction Administration UI.

      Supported API: true
      Parameters:
      releaseUfid -
      Returns:
      String

    • validateTargetAssocsWithViewTargetMappings

      public static boolean validateTargetAssocsWithViewTargetMappings(Persistable anObject) throws WTException
      Checks if the distribution target associations of the input persistable are valid with respect to the view and target mappings specified in the preference "View To Distribution Target Mappings". Returns true if the associations are valid, false otherwise. Delegates the actual validation to an identically named ESIService API.

      Supported API: true
      Parameters:
      anObject - - Input persistable object.
      Returns:
      - true/false based on the mappings.
      Throws:
      WTException