Package net.pricefx.common.apibuilder.contract

Interface ContractHelper

All Superinterfaces:

LineItemHelper, Reviewable

public interface ContractHelper
extends LineItemHelper, Reviewable

A helper interface that assists in manipulating the contract object. An instance can be obtained via call cProcessor.getHelper() from a 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 interface LineItemHelper

LineItemHelper.LineItem, LineItemHelper.ReviewSubStep

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 interface LineItemHelper

findAllWithLabel, findByLineId, getRoot, lineItemFromMap

Methods inherited from interface Reviewable

getItemsForReview, getReviewSubStep, isInReview

Method Details

findAllWithContractTermTypeUN

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