Package net.pricefx.common.apibuilder.contract

Class ContractHelper

Object

LineItemHelper

ContractHelper

public class ContractHelper
extends LineItemHelper

A helper class that assists in manipulating the contract object. An instance of this class can be obtained via call cProcessor.getHelper() from contract header logic.

Recommended Reading:

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

Example:

  def isHighPriority = cProcessor.getHelper().getRoot().getInputByName("IsHighPriority")?.value
 

See Also:

• LineItemHelper

Nested Class Summary

Nested classes/interfaces inherited from class LineItemHelper

LineItemHelper.LineItem

Field Summary

Fields inherited from class LineItemHelper

calculableLineItemCollection, idToLineItem, parentIdToLineItems, root

Constructor Summary

Constructors

Constructor	Description
ContractHelper(Map<String,Object> calculableLineItemCollection)

Method Summary

Modifier and Type	Method	Description
List<LineItemHelper.LineItem>	findAllWithContractTermTypeUN(String contractTermTypeUN)	Finds all contract line items with the specified contract term type.

Methods inherited from class LineItemHelper

findAllWithLabel, findByLineId, getFlattedInputs, getRoot, lineItemFromMap

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ContractHelper

public ContractHelper(Map<String,Object> calculableLineItemCollection)

Method Details

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