PeopleCode API Reference
This preface introduces the PeopleCode API Reference PeopleBook.
PeopleCode API Reference
PeopleCode is the proprietary language used in the development of Oracle's PeopleSoft applications. This PeopleBook provides a reference for the PeopleCode application programming interface (API)—that is, the classes delivered with PeopleCode. The chapters of this PeopleBook describe the syntax and fundamental elements of this part of the PeopleCode language—for example, all of the methods and properties of the Rowset class, the Field class, and so on.
There are two accompanying PeopleBooks about PeopleCode: the PeopleCode Language Reference and the PeopleCode Developer's Guide. The language reference covers the language elements of PeopleCode, such as the built-in functions, meta-SQL, system variables, and so on. Its chapters contain reference material for the PeopleCode language. The PeopleCode Developer's Guide contains conceptual information about developing programs with the PeopleCode language, the PeopleCode API, the component processor, and so on.
PeopleBooks and the Online PeopleSoft Library contains general information about Oracle's PeopleTools product line, such as related documentation, common page elements, and typographical conventions.
See Also
PeopleTools 8.52: PeopleCode Language Reference PeopleBook
PeopleTools 8.52: PeopleCode Developer's Guide PeopleBook
PeopleCode Typographical Conventions
Throughout this book, we use typographical conventions to distinguish between different elements of the PeopleCode language, such as bold to indicate function names, italics for arguments, and so on.
Please take a moment to review the following typographical cues:
|
Font Type |
Description |
|
Indicates a PeopleCode program or other example |
|
Keyword |
In PeopleCode syntax, items in keyword font indicate function names, method names, language constructs, and PeopleCode reserved words that must be included literally in the function call. |
|
In PeopleCode syntax, items in variable font are placeholders for arguments that your program must supply. |
|
|
... |
In PeopleCode syntax, ellipses indicate that the preceding item or series can be repeated any number of times. |
|
{Option1|Option2} |
In PeopleCode syntax, when there is a choice between two options, the options are enclosed in curly braces and separated by a pipe. |
|
[ ] |
In PeopleCode syntax optional items are enclosed in square brackets. |
|
&Parameter |
In PeopleCode syntax an ampersand before a parameter indicates that the parameter is an already instantiated object. |
PeopleBooks and the PeopleSoft Online LibraryA companion PeopleBook called PeopleBooks and the PeopleSoft Online Library contains general information, including:
Understanding the PeopleSoft online library and related documentation.
How to send PeopleSoft documentation comments and suggestions to Oracle.
How to access hosted PeopleBooks, downloadable HTML PeopleBooks, and downloadable PDF PeopleBooks as well as documentation updates.
Understanding PeopleBook structure.
Typographical conventions and visual cues used in PeopleBooks.
ISO country codes and currency codes.
PeopleBooks that are common across multiple applications.
Common elements used in PeopleBooks.
Navigating the PeopleBooks interface and searching the PeopleSoft online library.
Displaying and printing screen shots and graphics in PeopleBooks.
How to manage the locally installed PeopleSoft online library, including web site folders.
Understanding documentation integration and how to integrate customized documentation into the library.
Application abbreviations found in application fields.
You can find PeopleBooks and the PeopleSoft Online Library in the online PeopleBooks Library for your PeopleTools release.