| Package | Description |
|---|---|
| com.pega.pegarules.pub.clipboard |
Clipboard, Page, and Property interfaces.
|
| com.pega.pegarules.pub.context | |
| com.pega.pegarules.pub.database |
Provides access to the relational database.
|
| com.pega.pegarules.pub.generator |
Java generation public interfaces and classes.
|
| com.pega.pegarules.pub.runtime |
Public interfaces for activities, models, whens, edits, and streams.
|
| com.pega.pegarules.pub.util |
Miscellaneous public utility classes and interfaces.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
ClipboardPage
ClipboardPage provides a common interface to PegaRULES pages.
|
| Modifier and Type | Method and Description |
|---|---|
StringMap |
PRStackFrame.getParameterPage()
Identifies the
ParameterPage of this stack frame. |
StringMap |
AgentUtils.getQueue(java.lang.String aRuleSetName,
int aQueueNumber)
For the specified Agent name (ruleset name) and the specified row number in that Agent,
return state data about that agent queue.
|
| Modifier and Type | Method and Description |
|---|---|
ClipboardPage |
PRQueueManager.dequeue(java.lang.String aItemId,
StringMap aOptions)
Return one specific item from the queue by Item ID.
|
void |
PRRequestProcessor.dequeueExecutionRequest(java.lang.String aExecutionRequestID,
StringMap aOptions)
Retrieve an execution request from the queue using its unique ID
|
ClipboardPage |
PRQueueManager.dequeueForUpdate(java.lang.String aItemId,
StringMap aOptions)
Return one specific item from the queue by Item ID.
|
ClipboardPage |
PRQueueManager.dequeueLightWeight(java.lang.String aItemId,
StringMap aOptions)
Return one specific item which does not have stream from the queue by Item ID.
|
ClipboardPage |
PRQueueManager.getFirst(java.lang.String aQueueClass,
StringMap aOptions)
Get and lock the first available queue item based on the specified criteria
Options:
|
ClipboardPage |
PRQueueManager.getFirst(java.lang.String aQueueClass,
java.lang.String aAgentName,
StringMap aOptions)
Get and lock the first available queue item based on the specified criteria
Options:
|
PRQueueIterator |
PRQueueManager.iterator(java.lang.String aQueueClass,
StringMap aOptions)
Get simple iterator object that will return the next item matching
the specified criteria.
|
PRQueueIterator |
PRQueueManager.iterator(java.lang.String aQueueClass,
java.lang.String aAgentName,
StringMap aOptions)
Get simple iterator object that will return the next item matching
the specified criteria.
|
PRQueueIterator |
PRQueueManager.lightWeightIterator(java.lang.String aQueueClass,
StringMap aOptions)
Get simple iterator object that will return the next item matching
the specified criteria.This API needs to be used to retrieve the items enqueued using
PRQueueManager.enqueueLightWeightDeferred(ClipboardPage aItemPage) |
PRQueueIterator |
PRQueueManager.lightWeightIterator(java.lang.String aQueueClass,
java.lang.String aAgentName,
StringMap aOptions)
Get simple iterator object that will return the next item matching
the specified criteria.This API needs to be used to retrieve the items enqueued using
PRQueueManager.enqueueLightWeightDeferred(ClipboardPage aItemPage) |
int |
PRRequestProcessor.processQueue(java.lang.String aQueueClass,
StringMap aOptions)
Process execution requests stored in the queue
|
void |
PRThread.saveRuleImpl(StringMap aKeys,
java.lang.Object aImpl)
Deprecated.
use saveRuleImpl() that takes reusableKey as a String instead.
|
void |
PRStackFrame.setParameterPage(StringMap aNewPage)
Identifies the new
ParameterPage of this stack frame. |
| Modifier and Type | Method and Description |
|---|---|
int |
LockManager.acquireLock(java.lang.String aLockName,
boolean aUnlockOnCommit,
StringMap aInfo)
Attempts to lock against a specific string, returning a specific
return status.
|
void |
RulesetContext.addDataPageAsRuleReference(StringMap aPropertyKeys)
Adds a reference to data page rule (without trying to open it).
|
java.lang.String |
Database.findHandle(StringMap aKeys)
Finds the handle of the instance that would be opened given a set of
keys.
|
java.lang.String |
RulesetContext.findHandle(StringMap aKeys)
Finds the handle of the instance that would be opened from the RuleSet context, given a set of
keys.
|
boolean |
RulesetContext.findRuleInClassSet(StringMap aKeys,
java.util.Set aClassToTry)
Looks for the specified rule in any of the classes given in the
aClassToTry list.
|
java.lang.String |
Database.getHandle(StringMap aInstancePage)
Calculates the handle of an instance.
|
java.lang.String |
Database.getInstanceName(StringMap aInstancePage,
ClassDefinition aClassDef)
Get the instance name for a page.
|
java.lang.String |
LockManager.getLockHandle(StringMap aInstancePage)
Gets the handle that would be used to lock an instance.
|
boolean |
LockManager.isLocked(StringMap aLockPage,
StringMap aInfo)
Deprecated.
As of version 7.9, use
LockManager.lockExists(String, StringMap) instead. |
boolean |
LockManager.isLocked(java.lang.String aLockName,
StringMap aInfo)
Deprecated.
As of version 7.9, use
LockManager.lockExists(String, StringMap) instead. |
boolean |
LockManager.lock(java.lang.String aLockName,
boolean aUnlockOnCommit,
StringMap aInfo)
Locks a generic string.
|
boolean |
LockManager.lock(StringMap aInstancePage,
boolean aUnlockOnCommit)
Locks an instance.
|
boolean |
LockManager.lock(StringMap aInstancePage,
boolean aUnlockOnCommit,
StringMap aInfo)
Locks an instance.
|
int |
LockManager.lockExists(java.lang.String aLockName,
StringMap aLockInfoReturned)
Check if active lock is held by a user.
|
boolean |
LockManager.lockOnNode(java.lang.String aLockName,
StringMap aInfo)
Obtain a node-level lock, using the given key
|
ClipboardPage |
Database.open(java.lang.String aInstanceHandle,
boolean aCheckSecurity,
boolean aLock,
boolean aUnlockOnCommit,
StringMap aLockInfo)
Opens an instance from an object table by its handle.
|
ClipboardPage |
RulesetContext.open(StringMap aInstancePage)
Opens an instance given its key properties.
|
ClipboardPage |
Database.open(StringMap aInstancePage,
boolean aCheckSecurity)
Opens the instance with the given keys.
|
ClipboardPage |
Database.open(StringMap aInstancePage,
boolean aCheckSecurity,
boolean aLock,
boolean aUnlockOnCommit,
StringMap aLockInfo)
Opens the instance with the given keys.
|
ClipboardPage |
RulesetContext.openDefault(StringMap aKeys)
Opens the default version of the Rule with the given keys.
|
ClipboardPage |
Database.openDefault(StringMap aKeys,
boolean aCheckSecurity)
Opens the default version of the Rule with the given keys.
|
java.util.Map |
Database.openForAllCircumstanceVals(StringMap aInstancePage,
RuleResolutionInformation aRuleInfo)
Deprecated.
|
java.util.Map |
RulesetContext.openForAllCircumstanceVals(StringMap aInstancePage,
RuleResolutionInformation aRuleInfo)
Deprecated.
|
ClipboardPage |
Database.openIfStale(ClipboardPage aInstancePage,
boolean aCheckSecurity,
boolean aLock,
boolean aUnlockOnCommit,
StringMap aLockInfo)
Checks to see if an instance has been modfied; if it has, this function returns
a ClipboardPage with the new definition, if not return a handle to the input
page.
|
void |
RulesetContext.openRuleUtilityFunction(StringMap aKeyPage)
Opens the undecorated and decorated(if any) Rule-Utility-Function instances
and add it to Rule Referencing.
|
boolean |
LockManager.unlock(StringMap aInstancePage,
boolean aInDifferentRequestor)
Unlocks an instance.
|
| Modifier and Type | Method and Description |
|---|---|
StringMap |
FirstUseAssembler.getKeys()
Identifies the key information for this instance.
|
| Modifier and Type | Method and Description |
|---|---|
void |
FirstUseAssembler.noteInstanceUsed(StringMap aKeys)
Adds the specified instance to the list of rule dependencies, and
optionally to the list of used rules.
|
void |
FirstUseAssembler.noteInstanceUsed(StringMap aKeys,
PageDescriptor pageDesc)
Adds the specified instance to the list of rule dependencies, and
optionally to the list of used rules.
|
ClipboardPage |
FirstUseAssembler.openRule(StringMap aKeyPage,
boolean aForceDBOpen)
Opens the specified database instance, using either the RulesetContext
(at design time) or Database (at runtime) so that referenced rule tracking
is properly performed.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ParameterPage
The
ParameterPage class allows a collection of
String-valued, named parameters to be shared easily and
automatically during processing. |
| Modifier and Type | Method and Description |
|---|---|
StringMap |
IUIComponent.getDefaultPropertyValueMap()
Returns the Map of key value pair to avoid the defaults to be register with
change tracker.
|
StringMap |
CollectionRule.getRuleKeys()
Returns the keys to this Rule.
|
| Modifier and Type | Method and Description |
|---|---|
void |
StreamBuilderToolKit.appendStream(StringMap aKeys)
Adds specified, separately defined, stream to generated stream.
|
void |
StreamBuilderToolKit.appendStream(StringMap aKeys,
ParameterPage aParamPage)
Adds specified, separately defined, stream to generated stream.
|
void |
PublicAPI.applyCollection(StringMap aCollectionKeys,
ClipboardPage aPage,
ParameterPage aParams)
Applies a Collection to an instance.
|
void |
PublicAPI.applyModel(ClipboardPage aClipboardPage,
StringMap aKeys,
ParameterPage aNewParamPage)
Apply a model to the specified clipboard page.
|
void |
PublicAPI.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.
|
void |
PublicAPI.doActivity(StringMap aKeys,
ClipboardPage aNewPrimaryPage,
ParameterPage aNewParam)
Executes the identified processing, which is typically defined by class
Rule-Obj-Activity.
|
boolean |
PublicAPI.evaluateWhen(StringMap aKeys)
Evaluates the identified conditional.
|
GeneratedJava |
PublicAPI.getImplementation(StringMap aKeys)
Deprecated.
use one of the specific interface methods such as
PublicAPI.doAction(com.pega.pegarules.pub.util.StringMap, com.pega.pegarules.pub.clipboard.ClipboardPage, com.pega.pegarules.pub.runtime.ParameterPage) |
java.util.Map |
PublicAPI.getMetadata(StringMap aKeys,
ClipboardPage aPrimaryPage)
Returns metadata if available from the rule instance.
|
java.lang.String |
PublicAPI.getStream(StringMap aKeys,
ClipboardPage aNewPrimary)
Builds the stream identified by a set of keys.
|
java.lang.String |
PublicAPI.getStream(StringMap aKeys,
ClipboardPage aNewPrimary,
long aMode)
Builds the stream identified by a set of keys.
|
java.lang.String |
PublicAPI.sendFile(byte[] aFileData,
java.lang.String aFileName,
boolean aPersistFileToServiceExport,
StringMap aHttpHeaders,
boolean aSendForDownload)
Send file data in aFileData.
|
java.lang.String |
PublicAPI.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.
|
java.lang.String |
PublicAPI.sendFile(PRFile aFile,
boolean aDeleteFile,
StringMap aHttpHeaders,
boolean aSendForDownload)
Send file designated by aFile to the client.
|
java.lang.String |
PublicAPI.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.
|
java.lang.String |
PublicAPI.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.
|
void |
IUIComponent.setDefaultPropertyValueMap(StringMap nonTrackedProperties)
While registering with change tracker default properties will be ignored
if value matches to the tracked properties.
|
| Modifier and Type | Class and Description |
|---|---|
class |
HashStringMap
Simplest implementation of the
StringMap interface, using a
java.util.HashMap internally. |
| Modifier and Type | Method and Description |
|---|---|
StringMap |
StringMapFactory.acquire() |
| Modifier and Type | Method and Description |
|---|---|
void |
ServiceUtils.configureMappingRules(XSDComponentBuilder aBuilder,
StringMap aOptions,
ClipboardProperty aRuleList)
Configure XML mapping rules that have already been added to the rule list.
|
void |
ServiceUtils.createWSDL(StringMap aParams,
ClipboardPage aListPage)
Generate and return the WSDL for a SOAP service class.
|
void |
ServiceUtils.createWSDL(StringMap aParams,
java.util.List aMethodList)
Generate and return the WSDL for a SOAP service class.
|
void |
ServiceUtils.generateMappingRules(XSDComponentBuilder aBuilder,
java.util.List aElemNames,
StringMap aOptions,
ClipboardProperty aRuleList)
Generate rules for the given set of element names.
|
byte[] |
PDFUtils.generatePDF(java.lang.String aHtmlStream,
StringMap options)
Generates the PDF given the HTML Stream and formatting options
Formatting options are declared as constants with the "PARAM_" prefix in this interface.
|
java.util.Map |
ServiceUtils.getReponseData(java.lang.Object aResponse,
ClipboardPage aAttachPage,
StringMap aOptions)
Deprecated.
|
java.util.Map |
ServiceUtils.getResponseData(java.lang.Object aResponse,
ClipboardPage aAttachPage,
StringMap aOptions)
Get HTTP Response data from an HTTP Response object
The resulting map may or may not contain the following data:
KEY: Description:
---------------------------------------------------------------------------------
body (Object): String or Byte Array containing response body
size (int): size of response body
charset (String): character encoding of response body
contentType (String): value of Content-Type header
contentDisposition (Sring): vaue of Content-Disposition header
|
void |
StringMapFactory.release(StringMap aSm) |
Copyright © 2015 Pegasystems Inc. All Rights Reserved.