PublicAPI

The PublicAPI is the supported public interface to the rules engine. As such, the PublicAPI is sometimes referred to as the Engine API. The keyword tools identifies the PublicAPI interface in Java calls.

The PublicAPI includes the following classes:


      com.pega.pegarules.pub.*;            // Classes common to most public interfaces. 
      com.pega.pegarules.pub.clipboard.*;  // Clipboard, Page, and Property 
      com.pega.pegarules.pub.context.*;    // Requestor, Thread, and Node 
      com.pega.pegarules.pub.database.*;   // Relational database access 
      com.pega.pegarules.pub.dictionary.*; // Dictionary validation interface 
      com.pega.pegarules.pub.generator.*;  // Java generation 
      com.pega.pegarules.pub.pal.*;        // Reports statistics about a Thread 
      com.pega.pegarules.pub.runtime.*;    // Activities, Data Transforms, Whens, Streams 
      com.pega.pegarules.pub.util.*;       // Miscellaneous utilities

In Designer Studio, you can access the home page of the Javadoc documentation for the PublicAPI from Designer Studio. From the Resources menu, click Engine API.

CAUTION:

Use of Pega Platform Java packages, classes, methods, or interfaces that are not part of the public interface might result in code that fails, or code that returns incorrect results.