Class CFSAction<ATTACHEDTO extends Help>

  • All Implemented Interfaces:
    Help

    public class CFSAction<ATTACHEDTO extends Help>
    extends Action
    This action starts calculation of selected CFS. It's a programmatic version of the same action available in UI. As such it allows user to schedule the action in calculation flow formula.
    • Constructor Detail

      • CFSAction

        public CFSAction​(ATTACHEDTO backLink,
                         Invocations<MethodInvocationRecord> invocations,
                         String cfsLabel)
    • Method Detail

      • setCalculate

        public CFSAction<ATTACHEDTO> setCalculate​(Boolean calculate)
        Whether the action is valid and should be triggered or not.
        Parameters:
        calculate -
        • true - calculation of the CFS is started as background process
        • false - calculation of the CFS is NOT started at all
      • setPriority

        public CFSAction<ATTACHEDTO> setPriority​(int priority)
        Sets the prority of this job.
        Parameters:
        priority - Default is 0 (lowest user-definable priority). Max value is 9.
        Returns:
      • setDistributedCalculationThreshold

        public CFSAction<ATTACHEDTO> setDistributedCalculationThreshold​(int threshold)
        Sets a job-individual threshold to start a distributed calculation. Please note: Any values below 1000 may very well be counter-productive and make the job slower!
        Parameters:
        threshold - The number of items that need to be part of the job in order to execute it in distributed mode.
        Returns:
      • getObjectName

        public String getObjectName()
      • setNextJobs

        public CFSAction<ATTACHEDTO> setNextJobs​(List<ChainedJobInfo> jobs)
        Defines subsequent follow-on jobs
        Parameters:
        jobs - List of ChainedJobInfo objects
        Returns:
      • getCfsLabel

        public String getCfsLabel()
      • getCalculate

        public Boolean getCalculate()
      • getDistributedCalculationThreshold

        public int getDistributedCalculationThreshold()
      • getPriority

        public int getPriority()
      • getNextJobs

        public List<ChainedJobInfo> getNextJobs()