Package com.polarion.platform.persistence

Interface ICalculatedFieldsService

public interface ICalculatedFieldsService
Since:
3.3.0
Author:
Jiri Banszel, Polarion Software

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<String>
    getCalculatedFieldIds(IPObject instance)
    Calculated fields configured for given instance.
    Set<String>
    getCalculatedFieldIds(IContextId contextId, String prototypeName, Object controlValue)
    Calculated fields configured for given context and control value.
    String
    getControlField(String prototypeName)
    Returns name of the field which controls set of calculated fields defined for the object of given prototype.
    IJob
    recalculate(IContextId contextId)
    Starts job that recalculates calculated fields in all objects in given context (recalculation needs to be done after change of calculated fields configuration).
    IJob
    recalculate(IContextId contextId, String nodeId)
    Starts job that recalculates calculated fields in all objects in given context (recalculation needs to be done after change of calculated fields configuration) and on given node in cluster.
    void
    startup()
    Called internally during startup of the platform.

  • Method Details

    • getCalculatedFieldIds

      Set<String> getCalculatedFieldIds(IPObject instance)
      Calculated fields configured for given instance.
      Parameters:
      instance -

    • getControlField

      String getControlField(String prototypeName)
      Returns name of the field which controls set of calculated fields defined for the object of given prototype. The field is the same as returned by @link ICustomFieldsProvider.getControlField(String).
      Parameters:
      prototypeName -

    • getCalculatedFieldIds

      Set<String> getCalculatedFieldIds(IContextId contextId, String prototypeName, Object controlValue)
      Calculated fields configured for given context and control value. Control value is value of a control field - the same as for custom fields.
      Parameters:
      contextId -
      controlValue -

    • recalculate

      IJob recalculate(IContextId contextId) throws GenericJobException
      Starts job that recalculates calculated fields in all objects in given context (recalculation needs to be done after change of calculated fields configuration).
      Parameters:
      contextId - in which to recalculate objects
      Returns:
      recalculation job
      Throws:
      GenericJobException

    • recalculate

      IJob recalculate(IContextId contextId, String nodeId) throws GenericJobException
      Starts job that recalculates calculated fields in all objects in given context (recalculation needs to be done after change of calculated fields configuration) and on given node in cluster. If server is not configured as cluster then it always recalculate objects on local instance.
      Parameters:
      contextId - in which to recalculate objects
      nodeId - where fields will be recalculated or null if should be run on all nodes in cluster
      Returns:
      recalculation job
      Throws:
      GenericJobException
      Since:
      3.8.0

    • startup

      void startup()
      Called internally during startup of the platform.