PeopleCode Functions - Revision history

WikiSysop: /* List of PeopleCode Functions */

2018-12-10T21:53:16Z

‎List of PeopleCode Functions

WikiSysop at 21:51, 10 December 2018

2018-12-10T21:51:41Z

WikiSysop: /* S, T, U */

2017-07-05T09:26:09Z

‎S, T, U

WikiSysop: /* P, Q, R */

2017-07-05T09:25:30Z

‎P, Q, R

WikiSysop: /* G, H, I */

2017-07-05T09:23:34Z

‎G, H, I

WikiSysop: /* D, E, F */

2017-07-05T09:22:48Z

‎D, E, F

WikiSysop: /* A, B, C */

2017-07-05T09:21:55Z

‎A, B, C

WikiSysop: /* A, B, C */

2017-01-24T18:25:23Z

‎A, B, C

WikiSysop: /* A, B, C */

2017-01-24T18:23:04Z

‎A, B, C

WikiSysop: /* A, B, C */

2017-01-24T18:15:53Z

‎A, B, C

@@ Line 27: / Line 27: @@
 |}
-==List of [[PeopleCode]] Functions ==
+==List of [[PeopleCode]] Functions (including 8.57)==
 ===A, B, C===

@@ Line 337: / Line 337: @@
 |Returns true if the component data has changed since the last save.
 |<nowiki>&isChanged=ComponentChanged();</nowiki>
 |-
@@ Line 821: / Line 831: @@
 |Saves immediately, executing the save PeopleCode. Useful if calling a remote call program that accesses the page data direct.
 |<nowiki>DoSaveNow();</nowiki>
 |-
@@ Line 1,343: / Line 1,358: @@
 |Returns a string of the current working directory (on the server)
 |<nowiki>&pathString=GetCwd();</nowiki>
 |-
@@ Line 1,823: / Line 1,843: @@
 |FLUID: Returns true if browser Back is enabled, false otherwise.
 |<nowiki>&isBackEnabled=IsBackEnabled();</nowiki>
 |-
@@ Line 1,883: / Line 1,908: @@
 |FLUID: Returns true if LogOut button is enabled on the Component.
 |<nowiki>&isLogoutOn=IsLogoutEnabled();</nowiki>
 |-
@@ Line 1,898: / Line 1,928: @@
 |FLUID: Returns true if Master/Detail or Activity Component has page navigation presented as a drop down list (same as IsMDNonOptimized).
 |<nowiki>&isMdPopup=IsMDListPopup();</nowiki>
 |-
@@ Line 2,669: / Line 2,704: @@
 |Sets user interface and data language code for this session. Language Code must be a translate value of LANGUAGE_CD. Not in Sign on PeopleCode
 |<nowiki>[&isOK=]SetLanguage(&LanguageCd);</nowiki>
 |-
@@ Line 2,679: / Line 2,719: @@
 |FLUID: Sets Master/Detail and Activity Guide Components to switch navigation to pages as a drop down list (or back to a left hand panel).
 |<nowiki>[&isOK=]SetMDListPopup(&isPopup);</nowiki>
 |-
@@ Line 2,729: / Line 2,774: @@
 |Sets re-edit mode on/off to run Fed, check translate and prompt table edits on all fields on component as though the entries were all new.
 |<nowiki>SetReEdit(&isReEdit);</nowiki>
 |-
@@ Line 2,779: / Line 2,829: @@
 |Returns true if specified user option default is set to new value
 |<nowiki>&isOK=SetUserOption(&OptionCategoryLevel, &OptionName, &DefaultValue);</nowiki>
 |-
@@ Line 2,952: / Line 3,007: @@
 |-
 |TransferMobilePage
-|DEPRECATED: Transfers to the specified Mobile Page Detail View.
+|DEPRECATED/REMOVED: Transfers to the specified Mobile Page Detail View.
 |<nowiki>TransferMobilePage( [MOBILEPAGE.]PageName, &TabNumber, &CiObject);</nowiki>
@@ Line 2,979: / Line 3,034: @@
 |Transfers to a page in another Portal with action (A , U , L , C , E). Current keys are added to Key Fields and searched using equals. Search dialog shown if not a single row selected
 |<nowiki>[&isOK=]TransferPortal(&IsNewWindow, PORTAL.PortalName, NODE.NodeName, MENU.MenuName, MARKET.MarketName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName, &Action [, [RecordName1.]KeyFieldName1...]);</nowiki>
 |-
@@ Line 3,054: / Line 3,114: @@
 |Returns value of single unit after uniform series of payments at Interest Rate
 |<nowiki>&unitValue=UniformSeriesPV(&InterestRate, &NumberOfPeriods);</nowiki>
 |-
@@ Line 3,119: / Line 3,184: @@
 |Creates new browser window showing URL specified
 |<nowiki>ViewContentURL({&UrlString | URL.UrlName});</nowiki>
 |-
@@ Line 3,134: / Line 3,209: @@
 |Views (external) URL in on top of current Page in a modal window.  You can specify the modal options in the form of "bAutoCloseWarn@1;width@200".
 |<nowiki>ViewURL({&UrlString | URL.UrlName} [, &strOptions ]);</nowiki>
 |-

@@ Line 2,534: / Line 2,534: @@
 |DEPRECATED Removes all rows from a page scroll and component buffer not database. Use RowSet.Flush
 |<nowiki>ScrollFlush([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row,  RECORD.TargetRecordName);</nowiki>
 |-
@@ Line 2,544: / Line 2,539: @@
 |DEPRECATED Loads specified scroll from database applying where clause and ordering under single parent row. Use RowSet.Select
 |<nowiki>[&numberRows=]ScrollSelect(&LevelNumber, [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row,  RECORD.TargetRecordName, RECORD.RecordName [, &WhereOrderString [, &BindVariable1 ]... ] [, &isTurbo]);</nowiki>
 |-
@@ Line 2,599: / Line 2,599: @@
 |Returns %MDA_Success if field format is changed. FormatFamilyNumber example: %FormatFamilyType_SSN
 |<nowiki>&errorCode=SetDBFieldCharDefn(FIELD.FieldName, &LengthNumber [,&FormatFamilyNumber]);</nowiki>
 |-
@@ Line 2,609: / Line 2,604: @@
 |Returns %MDA_Success if character field with LengthNumber characters. FormatFamilyNumber example: %FormatFamilyType_MixedCase
 |<nowiki>&errorCode=SetDBFieldFormat(FIELD.FieldName ,&FormatFamilyNumber [,&FamilyName, &DisplayName]);</nowiki>
 |-
@@ Line 2,769: / Line 2,769: @@
 |Sets specific behaviour when transferring to a Page or Component. These can be set prior to transfer or immediately on activating the Page. Transfer Parameters are in the form Field1@Value1;Field2@Value2... returntolastpage@1 returns to last viewed Page of Component.
 |<nowiki>SetTransferAttributes(&isAnimated, &isAddedToHistory, &strBackBtnLabel, &strTransferParameters, &arrArrStrUrlQueryParameters);</nowiki>
 |-
@@ Line 2,779: / Line 2,774: @@
 |Returns a new process request object for a Scheduled JobSet
 |<nowiki>&processRequest=SetupScheduleDefnItem(&ProcessTypeName, &JobName);</nowiki>
 |-
@@ Line 2,972: / Line 2,972: @@
 |-
 |TransferPanel
-|DEPRECATED. Use TransferPage
+|DEPRECATED. Use TransferPage (the do the same thing).
 |<nowiki>[&isOK=]TransferPanel([PANEL.PageName]);</nowiki>

@@ Line 2,457: / Line 2,457: @@
 |-
 |Return
-|Return from function with a return function.
+|This returns from a function. Value is returned value of function.
-|<nowiki>Return [&value];</nowiki>
+|<nowiki>Return [&Value];</nowiki>
 |-
 |Returns
 |In function definition, specifies the returned value type.
-|<nowiki>Returns...</nowiki>
+|<nowiki>Returns String;</nowiki>
 |-
@@ Line 2,469: / Line 2,469: @@
 |Returns value from a PeopleCode messaging program to all subscription and publication nodes or none, or nodes in array as either a message or XML document.
 |<nowiki>ReturnToServer({&isAllNodes | &arrNodes}, {&objMessage | &XmlDoc} )</nowiki>
 |-
@@ Line 2,488: / Line 2,482: @@
 |-
 |Right
-|Returns the last Number Characters (or the last character if number omitted) of String. Unicode surrogate pairs treated as pairs of characters
+|Returns the last Number Of Characters (or the last character if number omitted) of String. Unicode surrogate pairs treated as pairs of characters
-|<nowiki>&endString=(&String [, &NumberCharacters] );</nowiki>
+|<nowiki>&endString=(&String [, &NumberOfCharacters] );</nowiki>
 |-

@@ Line 1,151: / Line 1,151: @@
 |-
 |GenerateMobileTree
-|DEPRECATED/REMOVED: Returns HTML of a tree representing a populated CI
+|DEPRECATED/REMOVED (PT8.55): Returns HTML of a tree representing a populated CI
 |<nowiki>&treeHTML=GenerateMobileTree(&CI [,&CIProperty ] );</nowiki>
 |-
 |GenerateQueryContentURL
-|Returns content URL of specified quey
+|Returns content URL of specified query
 |<nowiki>&URLString=GenerateQueryContentURL(PORTAL.PortalName, NODE.NodeName, &QueryName, &isPublicQuery [, &isInNewWindow] );</nowiki>
 |-
 |GenerateQueryPortalURL
-|Returns portal URL of specified quey
+|Returns portal URL of specified query
 |<nowiki>&URLString=GenerateQueryPortalURL(PORTAL.PortalName, NODE.NodeName, &QueryName, &isPublicQuery [, &isInNewWindow] );</nowiki>
 |-
 |GenerateQueryRelativeURL
-|Returns relative URL of specified quey
+|Returns relative URL of specified query
 |<nowiki>&URLString=GenerateQueryRelativeURL(PORTAL.PortalName, NODE.NodeName, &QueryName, &isPublicQuery [, &isInNewWindow] );</nowiki>
@@ Line 1,673: / Line 1,673: @@
 |Creates a global PeopleCode variable that is constant for that session
 |<nowiki>Global DataType &variable</nowiki>
 |-
@@ Line 1,683: / Line 1,678: @@
 |Switches the field to not be changeable on the page.
 |<nowiki>[&isOK=]Gray(RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row,  RECORD.TargetRecordName, &TargetRowNumber, [RecordName.FieldName);</nowiki>
 |-
@@ Line 1,708: / Line 1,708: @@
 |Calculates Hermitian Cubic to mimic hand drawn curve - number array element - (inX,inY,outX0Coefficient,outX1Coefficient,outX2Coefficient,outX3Coefficient)
 |<nowiki>HermiteCubic(&inOutArrayOfDataPointArray);</nowiki>
 |-
@@ Line 1,723: / Line 1,728: @@
 |Hides entire scroll bar and data inside. Use &Rowset.HideAllRows
 |<nowiki>[&isOK=]HideScroll([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row,  RECORD.TargetRecordName, &TargetRowNumber, [RecordName.]FieldName);</nowiki>
 |-

@@ Line 767: / Line 767: @@
 |Cancels current page or menu. Does not stop SaveEdit, SavePreChange, SavePostChange
 |<nowiki>DoCancel();</nowiki>
 |-
@@ Line 786: / Line 791: @@
 |-
 |DoModalPanelGroup
-|Displays secondary component in action mode A/U/L(Upddisp all)/C/E (Data Entry)/P (Prompt), returns 1 (OK) or 0 (cancelled). Use DoModalComponent now.
+|DEPRECATED: Displays secondary component in action mode A/U/L(Upddisp all)/C/E (Data Entry)/P (Prompt), returns 1 (OK) or 0 (cancelled). Use DoModalComponent now.
 |<nowiki>&OKCancel=DoModalPanelGoup(MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PANEL.LandingPageName, &Action, &RECORD.SharedRecordName);</nowiki>
@@ Line 806: / Line 811: @@
 |<nowiki>&OKCancel=DoModalXComponent
 (&isModal, "", , MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.LandingPageName, &Action, &RECORD.SharedRecordName [, RecordName.Field ]...);</nowiki>
 |-
@@ Line 816: / Line 816: @@
 |Saves at end of current PeopleCode event, executes PeopleCode associated with save. Only usable in FEd, FCh, MenuItemSelected.
 |<nowiki>DoSave();</nowiki>
 |-

@@ Line 525: / Line 525: @@
 |Returns reference to new RowSetCache object if one does not already exist with that name
 |<nowiki>&rowsetCache=CreateRowsetCache(&rowset, [ROWSET.]Name, Description);</nowiki>
 |-

@@ Line 143: / Line 143: @@
 |-
 |And
-|Boolean and in conditiona
+|Boolean and in conditions such as if statements.
 |<nowiki>if &isOk and &isReady then ... end-if;</nowiki>

@@ Line 169: / Line 169: @@
 |-
 |BlackScholesCall
-|Returns the value of a call against an equity according to [https://en.wikipedia.org/wiki/Black%E2%80%93Scholes_model Black Scholes]
+|Returns the value of a call against an equity according to [https://en.wikipedia.org/wiki/Black%E2%80%93Scholes_model Black Scholes] financial calculation.
 |<nowiki>&equityCall=BlackScholesCall(&AssetPrice, &StrikePrice, &NoRiskInterestRate, &YearsToExpire, &Volatility);</nowiki>
 |-
 |BlackScholesPut
-|[https://en.wikipedia.org/wiki/Black%E2%80%93Scholes_model Black Scholes] financial calculation.
+|Returns the value of a put against an equity according to [https://en.wikipedia.org/wiki/Black%E2%80%93Scholes_model Black Scholes] financial calculation.
 |<nowiki>&equityCall=BlackScholesPut(&AssetPrice, &StrikePrice, &NoRiskInterestRate, &YearsToExpire, &Volatility);</nowiki>
 |-
 |BootstrapYTMs
-|Does this make sense to anyone out there?
+|Returns [https://en.wikipedia.org/wiki/Bootstrapping_(finance) bootstrap yield-to-maturity curve] as an array.
 |<nowiki>&arrayOfNumberArrays=BootstrapYTMs(&TradingDate, &MarketInstrumentArrayOfNumberArrays, &AccrualConvention); </nowiki>