Returns the Cash Settlement Payment Date Business Day Convention.

The XPath query which can also be passed to the FpMLGenericQuery() function to generate the same result is : //descendant::Swaption/cashSettlement[1]/cashSettlementPaymentDate[1]/relativeDate[1]/businessDayConvention/text(). This function requires the input of a FpMLDoc object key, which must have been produced via a call to the ReadFpML() function.

This function would have returned a string 'KEY' which is to be passed to the 'FpMLDocKey' parameter of this function.

If you were looking at the FpML document, a typical example of walking to this(these) node(s) would be...

  // FpML Document -> Swaption

    -> cashSettlement[1]

      -> cashSettlementPaymentDate[1]

        -> relativeDate[1]

          -> businessDayConvention

            -> return( nodeValue(s) )

Or if using the FpMLGenericQuery() function...

//descendant::Swaption/cashSettlement[1]/cashSettlementPaymentDate[1]/relativeDate[1]/businessDayConvention/text()

String CTFpMLOS.CashSettledPayBDC( _
String FpMLDocKey)

=CT.FpML.OS.CashSettledPayBDC(
Excel String Cell FpMLDocKey)

static std::string CashSettledPayBDC(
std::string FpMLDocKey);

System.String CTFpMLOSSA.CashSettledPayBDC(
System.String FpMLDocKey);