Package wt.impact

Interface ImpactService

@RemoteInterface public interface ImpactService
The interface describing the services available for impact associations.

Supported API: true

Extendable: false

  • Method Details

    • getImpacteds

      WTSet getImpacteds(Impactor impactor) throws WTException
      Get associated Impacted objects.

      Supported API: true
      Parameters:
      impactor - Impactor object.
      Returns:
      Set of associated Impacted objects (guaranteed non-null, may be empty).
      Throws:
      WTException

    • getImpacteds

      WTKeyedMap getImpacteds(WTCollection impactors) throws WTException
      Get associated Impacted objects.

      Supported API: true
      Parameters:
      impactors - Collection of Impactor objects (other types ignored). Collection may only contain object references (no version references).
      Returns:
      Map of Impactor objects to WTSets of their associated Impacted objects (guaranteed non-null, may be empty). All Impactor objects will have a map entry.
      Throws:
      WTException

    • getImpacteds

      WTSet getImpacteds(Impactor impactor, List<ConfigSpec> configSpecs) throws WTException
      Get associated Impacted objects.

      Supported API: true
      Parameters:
      impactor - Impactor object.
      configSpecs - ConfigSpecs used to select a single version of any associated IteratedImpacted objects. If null then a latest ConfigSpec is used. If non-null but empty then all versions are returned.
      Returns:
      Set of associated Impacted objects (guaranteed non-null, may be empty).
      Throws:
      WTException

    • getImpacteds

      WTKeyedMap getImpacteds(WTCollection impactors, List<ConfigSpec> configSpecs) throws WTException
      Get associated Impacted objects.

      Supported API: true
      Parameters:
      impactors - Collection of Impactor objects (other types ignored). Collection may only contain object references (no version references).
      configSpecs - ConfigSpecs used to select a single version of any associated IteratedImpacted objects. If null then a latest ConfigSpec is used. If non-null but empty then all versions are returned.
      Returns:
      Map of Impactor objects to WTSets of their associated Impacted objects (guaranteed non-null, may be empty). All Impactor objects will have a map entry.
      Throws:
      WTException

    • getImpactors

      WTSet getImpactors(Impacted impacted) throws WTException
      Get associated Impactor objects.

      Supported API: true
      Parameters:
      impacted - Impacted object.
      Returns:
      Set of associated Impactor objects (guaranteed non-null, may be empty).
      Throws:
      WTException

    • getImpactors

      WTKeyedMap getImpactors(WTCollection impacteds) throws WTException
      Get associated Impactor objects.

      Supported API: true
      Parameters:
      impacteds - Collection of Impacted objects (other types ignored). Collection may only contain object references (no version references).
      Returns:
      Map of Impacted objects to WTSets of their associated Impactor objects (guaranteed non-null, may be empty). All Impacted objects will have a map entry.
      Throws:
      WTException

    • getImpactors

      WTSet getImpactors(Impacted impacted, List<ConfigSpec> configSpecs) throws WTException
      Get associated Impactor objects.

      Supported API: true
      Parameters:
      impacted - Impacted object.
      configSpecs - ConfigSpecs used to select a single version of any associated IteratedImpactor objects. If null then a latest ConfigSpec is used. If non-null but empty then all versions are returned.
      Returns:
      Set of associated Impactor objects (guaranteed non-null, may be empty).
      Throws:
      WTException

    • getImpactors

      WTKeyedMap getImpactors(WTCollection impacteds, List<ConfigSpec> configSpecs) throws WTException
      Get associated Impactor objects.

      Supported API: true
      Parameters:
      impacteds - Collection of Impacted objects (other types ignored). Collection may only contain object references (no version references).
      configSpecs - ConfigSpecs used to select a single version of any associated IteratedImpactor objects. If null then a latest ConfigSpec is used. If non-null but empty then all versions are returned.
      Returns:
      Map of Impacted objects to WTSets of their associated Impactor objects (guaranteed non-null, may be empty). All Impacted objects will have a map entry.
      Throws:
      WTException

    • removeImpact

      void removeImpact(Impactor impactor, Impacted impacted, Object container) throws WTException
      Remove an impact association between the Impactor and Impacted objects. Does nothing if an association does not exist.

      Supported API: true
      Parameters:
      impactor - Impactor object.
      impacted - Impacted object.
      container - WTContained or WTContainerRef object used to derive the association rule organization or site context. If null then context is derived from then Impactor object.
      Throws:
      WTException

    • removeImpacts

      void removeImpacts(Impactor impactor, WTCollection impacteds, Object container) throws WTException
      Remove impact associations between the Impactor object and Impacted objects. Does nothing if an association does not exist.

      Supported API: true
      Parameters:
      impactor - Impactor object.
      impacteds - Collection of Impacted objects (other types ignored, will be inflated). Collection may only contain object references (no version references).
      container - WTContained or WTContainerRef object used to derive the association rule organization or site context. If null then context is derived from then Impactor object.
      Throws:
      WTException

    • removeImpacts

      void removeImpacts(Impacted impacted, WTCollection impactors, Object container) throws WTException
      Remove impact associations between the Impacted object and Impactor objects. Does nothing if an association does not exist.

      Supported API: true
      Parameters:
      impacted - Impacted object.
      impactors - Collection of Impactor objects (other types ignored, will be inflated). Collection may only contain object references (no version references).
      container - WTContained or WTContainerRef object used to derive the association rule organization or site context. If null then context is derived from then Impacted object.
      Throws:
      WTException

    • getImpactorDelegate

      ImpactorDelegate getImpactorDelegate(Impactor impactor) throws WTException
      Given a reference to an Impactor object, look up the registered ImpactorDelegate for this particular type of object and return it.

      Supported API: true
      Parameters:
      impactor - Impactor object.
      Returns:
      ImpactorDelegate The impactor delegate registered for this type, or null if none is found.
      Throws:
      WTException

    • getImpactedDelegate

      ImpactedDelegate getImpactedDelegate(Impacted impacted) throws WTException
      Given a reference to an Impacted object, look up the registered ImpactedDelegate for this particular type of object and return it.

      Supported API: true
      Parameters:
      impacted - Impacted object.
      Returns:
      ImpactedDelegate The impacted delegate registered for this type, or null if none is found.
      Throws:
      WTException

    • getImpactorDelegate

      ImpactorDelegate getImpactorDelegate(Class<? extends Impactor> impactorClass) throws WTException
      Given a class of type Impactor, look up the registered ImpactorDelegate for this particular type of object and return it.

      Supported API: true
      Parameters:
      impactorClass - Impactor class object.
      Returns:
      ImpactorDelegate The impactor delegate registered for this type, or null if none is found.
      Throws:
      WTException

    • getImpactedDelegate

      ImpactedDelegate getImpactedDelegate(Class<? extends Impacted> impactedClass) throws WTException
      Given a class of type Impacted, look up the registered ImpactedDelegate for this particular type of object and return it.

      Supported API: true
      Parameters:
      impactedClass - Impacted class object.
      Returns:
      ImpactedDelegate The impacted delegate registered for this type, or null if none is found.
      Throws:
      WTException

    • applyImpact

      boolean applyImpact(Impactor impactor) throws WTException
      Apply the impact of an Impactor object on all of its Impacted objects.

      Supported API: true
      Parameters:
      impactor - Impactor object.
      Returns:
      True if impacts were applied, false if not.
      Throws:
      WTException

    • applyImpacts

      boolean applyImpacts(WTCollection impactors) throws WTException
      Apply the impact of a collection of Impactor objects on all of their Impacted objects.

      Supported API: true
      Parameters:
      impactors - Collection of Impactor objects (other types ignored, will be inflated).
      Returns:
      True if impacts were applied, false if not.
      Throws:
      WTException

    • applyImpact

      boolean applyImpact(Impactor impactor, List<ConfigSpec> configSpecs) throws WTException
      Apply the impact of an Impactor object on all of its Impacted objects.

      Supported API: true
      Parameters:
      impactor - Impactor object.
      configSpecs - ConfigSpecs used to select a single version of any associated IteratedImpacted objects. If null then a latest ConfigSpec is used. If non-null but empty then all versions are selected.
      Returns:
      True if impacts were applied, false if not.
      Throws:
      WTException

    • applyImpacts

      boolean applyImpacts(WTCollection impactors, List<ConfigSpec> configSpecs) throws WTException
      Apply the impact of a collection of Impactor objects on all of their Impacted objects.

      Supported API: true
      Parameters:
      impactors - Collection of Impactor objects (other types ignored, will be inflated).
      configSpecs - ConfigSpecs used to select a single version of any associated IteratedImpacted objects. If null then a latest ConfigSpec is used. If non-null but empty then all versions are selected.
      Returns:
      True if impacts were applied, false if not.
      Throws:
      WTException