Package com.ptc.windchill.associativity.reconciliation

Class AbstractReconciliationContext

java.lang.Object
com.ptc.windchill.associativity.reconciliation.AbstractReconciliationContext
Direct Known Subclasses:
ReconciliationContext
public abstract class AbstractReconciliationContext extends Object
The base report class to gather all the information.

Supported API: true

Extendable: false

  • Method Details

    • getAllAdditionalParams

      public Map<String,Object> getAllAdditionalParams()


      Supported API: true
      Returns:

    • setAllAdditionalParams

      public void setAllAdditionalParams(Map<String,Object> additionalParams)


      Supported API: true
      Parameters:
      additionalParams -

    • addAdditionalParam

      public void addAdditionalParam(String key, Object value)
      Provides ability to add additional/custom information as part of the reconciliation flow. This object is available in almost all the custom methods. Other use case is to put data for an expensive query/computation so that it can be reused across the whole flow.

      Supported API: true
      Parameters:
      key -
      value -

    • getAdditionalParam

      public Object getAdditionalParam(String key)
      Gets the value for a key set via addAdditionalParam(String, Object)

      Supported API: true
      Returns:
      - can return null if no value was put for the given key before this call.

    • isAutoCheckInEnabled

      public boolean isAutoCheckInEnabled()
      Tells if OOTB service should do auto-checkin of all the parts checked out as part of resolution of discrepancies. Default is false. Usually makes sense for the automatic services to set this to true like Workflow etc which may do the checkout via a more-privileged user.

      Supported API: true
      Returns:

    • setAutoCheckInEnabled

      public void setAutoCheckInEnabled(boolean doAutoCheckin)
      Refer isAutoCheckInEnabled()

      Supported API: true
      Parameters:
      doAutoCheckin -

    • isUpdateEquivalentEnabled

      public boolean isUpdateEquivalentEnabled()
      Tells if OOTB service should do update equivalent for the given
      invalid reference 
      #getEquivalentContexts()
      after all discrepancies are resolved. OOTB logic will update the equivalent only if all found discrepancies are resolved.

      Supported API: true
      Returns:

    • setUpdateEquivalentEnabled

      public void setUpdateEquivalentEnabled(boolean doUpdateEquivalent)
      Refer isUpdateEquivalentEnabled()

      Supported API: true
      Parameters:
      doUpdateEquivalent -