Class ContractHelper


  • public class ContractHelper
    extends LineItemHelper
    A helper class that assists in manipulating the contract object. Instance of this class can be obtained via call cProcessor.getHelper() from contract header logic.

    Recommended Reading:

    To understand how how calculation logics in contracts work please read article Contract Calculation Logic Details.

    Example:

      def isHighPriority = cProcessor.getHelper().getRoot().getInputByName("IsHighPriority")?.value
     
    See Also:
    LineItemHelper
    • Constructor Detail

      • ContractHelper

        public ContractHelper​(Map<String,​Object> calculableLineItemCollection)
    • Method Detail

      • findAllWithContractTermTypeUN

        public List<LineItemHelper.LineItem> findAllWithContractTermTypeUN​(String contractTermTypeUN)
        Finds all contract line items with the specified contract term type.
        Parameters:
        contractTermTypeUN - unique name of contract term type
        Returns:
        list of line items LineItemHelper.LineItem

        Example:

          def lineItems = cProcessor.getHelper().findAllWithContractTermTypeUN("BundleUp")
          lineItems.each { api.logInfo("line item label", it.label )}  // Bundle Up