> APIs > Engine. (The PublicAPIs are sometimes called the Engine APIs).Your Java activity step can access Pega 7 Platform facilities, using the classes and interfaces in the com.pega.pegarules.pub.* packages. JavaDocs documentation for this Application Programmer Interface are available in the same location as the Application Developer Help System.
This PublicAPI is the supported public interface to the rules engine.
For example, these two PublicAPI Java methods are part of the ClipboardProperty interface to the com.pega.pegarules.pub.clipboard package. They get and set properties on a page:
public ClipboardProperty getProperty(java.lang.String propertyreference)
public boolean ClipboardProperty setValue(ClipboardProperty avalue)
The PublicAPI is different from the Process Engine API, a collection of activities for work items.
To access the home page of the JavaDocs pages for the PublicAPI, select > APIs > Engine. (The PublicAPIs are sometimes called the Engine APIs).
The keyword tools identifies the PublicAPI interface in Java calls.
The PublicAPI includes these 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
Caution: Use of Pega 7 Platform Java packages, classes, methods, or interfaces that are not part of the public interface might result in code that fails, or returns incorrect results with future releases or on specific platforms.
Related terms