Complete list of Public API function in pega

1.void applyModel(ClipboardPage aClipboardPage, ParameterPage aNewParamPage, java.lang.String aModelName)
          It is used to apply a model to the specified clipboard page.
2.boolean checkCachingHeaders(long aLastModifiedDate, long aFileLength)
          It is used to validate the headers submitted as part of the request match the inputs provided.
3.void closeHTMLDoc()
          This must be called after getting a stream that is a top-level document.
4.ClipboardPage createPage(java.lang.String aClassName, java.lang.String aPageName)
          It is used to create a new page of the specified class.
5.void doAction(StringMap aKeys, ClipboardPage aNewStepPage, ParameterPage aNewParam)
          Executes the identified (typically custom) rule which uses the activity access interface by implementing com.pega.pegarules.pub.runtime.Activity.
6.void doActivity(StringMap aKeys, ClipboardPage aNewPrimaryPage, ParameterPage aNewParam)
          Executes the identified processing, which is typically defined by class Rule-Obj-Activity.
7.void editInput(ClipboardProperty aTarget, java.lang.String aValue, java.lang.String aEditName)
          Applies Rule-Edit-Input processing (if any) to the specified value before assigning it to the specified (scalar) property.
8.boolean editValidate(ClipboardProperty aTarget, java.lang.String aValidateName)
          Evaluates the named Rule-Edit-Validate for the specified (scalar) property.
9.java.lang.String entryHandle2Reference(java.lang.String aEntryHandle)
          It is used to convert an entry handle back into its corresponding reference.
10.boolean eTagMatches(long aLastModifiedDate)
          Deprecated.
11.boolean evaluateWhen(StringMap aKeys)
          Evaluates the identified conditional.
12.ClipboardPage findPage(java.lang.String aPageReference)
          It is used to locate the specified page, which can be either top-level or embedded..
13.ClipboardPage findPage(java.lang.String aPageReference, boolean aIfPresent)
          It is used to locate the specified page, which can be either top-level or embedded..
14.ClipboardPage findPageByHandle(java.lang.String aInsKey)
          It is used to locate the specified page, which must be top-level, by instance handle.
15.ClipboardPage findPageWithException(java.lang.String aPageReference)
          It is used to locate the specified page, which can be either top-level or embedded.
16.java.lang.String formatMessage(java.lang.String aKey, Database aDb)
          It is used to return localized value for Text.
17.ClipboardPage generateAgentDataPage(ClipboardPage aRuleAgentQueue)
          It is used to create a Data-Agent-Queue page, based on the specified Rule-Agent-Queue instance.
18.java.lang.String getActivityClassName()
          It is used to return a string representing the Java class file name of the currently executing activity.
19.ProcessingStatus getActivityStatus()
          It is used to return the cumulative ProcessingStatus instance to which the current instance will be added.
 20.AgentUtils getAgentUtils()
          It is used to return an instance of the AgentUtils class.
 21.java.lang.Object getAliasValue(ClipboardPage aPage, ImmutablePropertyAliasInfo aPropertyAliasInfo)
          It is used to resolve the identified property alias, by evaluating the alias on the specified clipboard page.
 22.java.lang.Object getAliasValue(ClipboardPage aPage, java.lang.String aClassName, java.lang.String aAliasName)
          It is used to resolve the identified property alias, by evaluating the alias on the specified clipboard page.
 23.java.lang.Object getAliasValue(java.lang.String aClassName, java.lang.String aAliasName)
          It is used to resolve the identified property alias, by evaluating the alias on the step page.
 24.PRAuthorization getAuthorizationHandle()
          It is used to get PRAuthorization instance handle.
 25.Database getDatabase()
          It is used to Identify a Database instance that can be used for this processing.
 26.DateTimeUtils getDateTimeUtils()
          It is used to return the DateTime utility object for this Node.
 27.Dictionary getDictionary()
          It is used to provide the Dictionary instance associated with this Thread.
 28.EFormUtils getEFormUtils()
          It is used to return an instance of the EFormUtils class.
 29.ClipboardProperty getIfPresent(java.lang.String aReference)
          It is used to provide the ClipboardProperty instance identified by the specified reference, using the current Step Page as the default.
 30.GeneratedJava getImplementation(StringMap aKeys)
          Deprecated. use one of the specific interface methods such as doAction(com.pega.pegarules.pub.util.StringMap, com.pega.pegarules.pub.clipboard.ClipboardPage, com.pega.pegarules.pub.runtime.ParameterPage)
 31.com.pega.pegarules.priv.InfEngUtils getInfEngUtils()
          Returns an instance of the InfEngUtils class.
 32.java.lang.String getLocalizedText(java.lang.String aRef)
          Get the localized text for the property named by the given reference
 33.java.lang.String getLocalizedTextForString(java.lang.String aRef, java.lang.String aString)
          Get the localized version of the given string, using the localization information from the given property.
 34.java.lang.String getLocalizedTextForString(java.lang.String aRef, java.lang.String aString, byte aMode)
          Get the localized version of the given string, using the localization information from the given property.
 35.java.util.Map getMetadata(StringMap aKeys, ClipboardPage aPrimaryPage)
          Returns metadata if available from the rule instance.
 36.PAL getPAL()
          Returns an instance of the PAL class.
 37.com.pega.ibm.icu.math.BigDecimal getParamAsBigDecimal(char aType, java.lang.String aName)
          Returns the value, if any, of the named parameter on the current ParameterPage.
 38.boolean getParamAsBoolean(char aType, java.lang.String aName)
          Returns the value, if any, of the named parameter on the current ParameterPage.
 39.java.util.Date getParamAsDate(char aType, java.lang.String aName)
          Returns the value, if any, of the named parameter on the current ParameterPage.
 40.double getParamAsDouble(char aType, java.lang.String aName)
          Returns the value, if any, of the named parameter on the current ParameterPage.
 41.int getParamAsInteger(char aType, java.lang.String aName)
          Returns the value, if any, of the named parameter on the current ParameterPage.
 42.ParameterPage getParameterPage()
          Identifies the current ParameterPage.
 43.java.lang.String getParamValue(java.lang.String aName)
          Returns the value, if any, of the named parameter on the current ParameterPage.
 44.ParseState getParseState(java.io.InputStream stream)
          Returns a new instance of ParseState on an InputStream.
 45.ParseState getParseState(java.io.Reader reader)
          Returns a new instance of ParseState on a Reader.
 46.ParseUtils getParseUtils()
          Returns an instance of the ParseUtils class.
 47.PDFUtils getPDFUtils()
          Returns an instance of PDFUtils class
 48.IPRCrypto getPRCrypto()
          Returns an instance of PegaRules cryptography interface
 49.ClipboardPage getPrimaryPage()
          Identifies the current Primary Page.
 50.ClipboardProperty getProperty(java.lang.String aReference)
          Provides the ClipboardProperty instance identified by the specified reference, using the current Step Page as the default.
 51.PRRequestor getRequestor()
          Identifies the Requestor that 'owns' the current processing.
 52.java.lang.String getRuleMessage(java.lang.String aMsgDescr)
          Given a Rule-Message descriptor (which consists of a Rule-Message key and a list of tab-separated parameters), produce a verbose message.
 53.ServiceUtils getServiceUtils()
          Returns an instance of the ServiceUtils class.
 54.PRStackFrame getStackFrame()
          Identifies the current (top) PRStackFrame instance.
 55.ClipboardPage getStepPage()
          Identifies the current Step Page.
 56.ProcessingStatus getStepStatus()
          Returns the ProcessingStatus associated with the current stack frame.
 57.java.lang.String getStream(StringMap aKeys, ClipboardPage aNewPrimary)
          Builds the stream identified by a set of keys.
 58.java.lang.String getStream(StringMap aKeys, ClipboardPage aNewPrimary, long aMode)
          Builds the stream identified by a set of keys.
 59.StructuredUtils getStructuredUtils()
          Returns an instance of the StructuredUtils class.
 60.PRSystemSettings getSystemSettings()
          Returns the SystemSettings interface
 61.PRThread getThread()
          Identifies the Thread that 'owns' the current processing.
 62.TracerUserWatchList getTracerUserWatchList()
          Get the TracerUserWatchList instance.
 63.XMLUtils getXMLUtils()
          Returns an instance of the XMLUtils class.
 64.boolean hasIfNoneMatch()
          Did the request that came in have an If-None-Match request header?
 65.boolean interpretBoolean(java.lang.String aBooleanString)
          Interpret a string as a either boolean true or false.
 66.boolean isNotModifiedSet()
         
 67.void openHTMLDoc()
          This must be called before getting a stream that is a top-level document.
 68.void preventStaleHTTPRequestProcessing(java.lang.String aFrameName)
          Prevent the outgoing HTML frame from being resubmitted by the client after initial submission.
 69.void putParamValue(java.lang.String aName, boolean aValue)
          Assigns the specified value to the named parameter, on the current ParameterPage.
 70.void putParamValue(java.lang.String aName, char aType, com.pega.ibm.icu.math.BigDecimal aValue)
          Assigns the specified value to the named parameter, on the current ParameterPage.
 71.void putParamValue(java.lang.String aName, char aType, boolean aValue)
          Assigns the specified value to the named parameter, on the current ParameterPage.
 72.void putParamValue(java.lang.String aName, char aType, java.util.Date aValue)
          Assigns the specified value to the named parameter, on the current ParameterPage.
 73.void putParamValue(java.lang.String aName, char aType, double aValue)
          Assigns the specified value to the named parameter, on the current ParameterPage.
 74.void putParamValue(java.lang.String aName, char aType, int aValue)
          Assigns the specified value to the named parameter, on the current ParameterPage.
 75.void putParamValue(java.lang.String aName, char aType, java.lang.Object aValue)
          Assigns the specified value to the named parameter, on the current ParameterPage.
 76.void putParamValue(java.lang.String aName, char aType, java.lang.String aValue)
          Assigns the specified value to the named parameter, on the current ParameterPage.
 77.void putParamValue(java.lang.String aName, ClipboardProperty aValue)
          Assigns the specified value (by reference) to the named parameter, on the current ParameterPage.
 78.void putParamValue(java.lang.String aName, double aValue)
          Assigns the specified value to the named parameter, on the current ParameterPage.
 79.void putParamValue(java.lang.String aName, int aValue)
          Assigns the specified value to the named parameter, on the current ParameterPage.
 80.void putParamValue(java.lang.String aName, java.lang.Object aValue)
          Assigns the specified value to the named parameter, on the current ParameterPage.
 81.void putParamValue(java.lang.String aName, java.lang.String aValue)
          Assigns the specified value to the named parameter, on the current ParameterPage.
 82.void resetNotModified()
          Sets the clears the result code (if set) for the servlet to 200.
 83.java.lang.String sendFile(byte[] aFileData, java.lang.String aFileName, boolean aPersistFileToServiceExport, StringMap aHttpHeaders, boolean aSendForDownload)
          Send file data in aFileData.
 84.java.lang.String sendFile(ClipboardPage aInstancePage, java.lang.String aFileSourceReference, boolean aIsBase64Encoded, java.lang.String aFileNameReference, java.lang.String aFileName, boolean aPersistFileToServiceExport, StringMap aHttpHeaders, boolean aSendForDownload)
          Send file data designated by aFileSourceReference in the clipboard page aInstancePage.
85. java.lang.String sendFile(PRFile aFile, boolean aDeleteFile, StringMap aHttpHeaders, boolean aSendForDownload)
          Send file designated by aFile to the client.
86. java.lang.String sendFile(StringMap aInstanceKeys, java.lang.String aFileSourceReference, boolean aIsBase64Encoded, java.lang.String aFileNameReference, java.lang.String aFileName, boolean aPersistFileToServiceExport, StringMap aHttpHeaders, boolean aSendForDownload)
          Send file data designated by aFileSourceReference in the instance keyed by aInstanceKeys.
87. java.lang.String sendFile(java.lang.String aInstanceHandle, java.lang.String aFileSourceReference, boolean aIsBase64Encoded, java.lang.String aFileNameReference, java.lang.String aFileName, boolean aPersistFileToServiceExport, StringMap aHttpHeaders, boolean aSendForDownload)
          Send file data designated by aFileSourceReference in the instance keyed by aInstanceHandle.
88. void sendHTTPRedirect(java.lang.String aLocation)
          Redirect a user to a new location (HTTP 303) This function is only meaningful in the context of a HTTP interaction.
89. void setCachingHeaders(long aLastModifiedDate)
          Sets the ETag and Last-Modified headers to contain values appropriate for client side caching.
90.void setETag(long aLastModifiedDate)
          Deprecated.
91.void setNotModified()
          Sets the result code for the servlet to 304.
92.void setNotModified(boolean aModified)
          Sets the result code for the servlet to 304.