| 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.dictionary |
Dictionary validation interface for PegaRULES engine.
|
| com.pega.pegarules.pub.generator |
Java generation public interfaces and classes.
|
| com.pega.pegarules.pub.infengine |
Declarative rules processing common classes.
|
| com.pega.pegarules.pub.pal |
Reports various statistics about a PegaRULES Thread.
|
| 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 | Method and Description |
|---|---|
ClipboardPage |
ClipboardPage.copy()
Copies this page and all of its properties to a new page.
|
ClipboardPage |
ClipboardPage.copy(boolean aReadOnlyCopy,
boolean aAvoidChangeTracking)
Copies this page and all of its properties to a new page.
|
ClipboardPage |
PRDeclarePageException.getDeclarePage() |
ClipboardPage |
ClipboardPage.getPage(java.lang.String aReference)
Returns the page value of the referenced property.
|
ClipboardPage |
ClipboardProperty.getPageValue()
Return value of this property as a page.
|
ClipboardPage |
ClipboardProperty.getPageValue(int aIndex)
Returns the ClipboardPage value of an element of this page list
property.
|
ClipboardPage |
ClipboardProperty.getPageValue(java.lang.String aGroupSubscript)
Returns the ClipboardPage value of an element of this page group
property.
|
ClipboardPage |
ClipboardProperty.getParentPage()
Identifies the page which contains this property.
|
ClipboardPage |
ClipboardPage.getParentPage()
Identifies the page which contains this page.
|
ClipboardPage |
ClipboardProperty.getTopLevelPage()
Identifies the top-level page that contains this property.
|
ClipboardPage |
ClipboardPage.getTopLevelPage()
Gets the top-level page for this object.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
ClipboardPage.addMessages(ClipboardPage aSourcePage)
Copies all of the page messages on aSourcePage and adds them to this page's messages.
|
java.lang.String |
ClipboardProperty.getGatewayPageName(ClipboardPage aPage,
java.lang.String aGatewayClass)
Get the fully qualified gateway page name if this property was used as a gateway to other
instance's properties.
|
void |
ClipboardPage.movePage(java.lang.String aReference,
ClipboardPage aSourcePage)
Move a page value into a property on this page.
|
void |
ClipboardPage.putPage(java.lang.String aReference,
ClipboardPage aValue)
A shortcut method, essentially the same as calling
thisPage.getProperty(aReference).setValue(aValue). |
boolean |
ClipboardPage.replace(ClipboardPage aSource)
Clear this page and place the entire contents of this page,
if any, with a copy of the contents of another page.
|
boolean |
ClipboardPage.replace(ClipboardPage aSource,
boolean aAvoidChangeTracking)
Clear this page and place the entire contents of this page,
if any, with a copy of the contents of another page.
|
| Constructor and Description |
|---|
PRDeclarePageException(java.lang.String aMessage,
ClipboardPage aDeclarePage,
java.lang.Throwable aCause)
Constructor for PRDeclarePageException that can hold a clipboard page
|
PRDeclarePageLoadException(java.lang.String aMessage,
ClipboardPage aDeclarePage,
java.lang.Throwable aCause) |
| Modifier and Type | Method and Description |
|---|---|
ClipboardPage |
PRThread.createPage(java.lang.String aClassName,
java.lang.String aPageName)
Create a new page of the specified class
If an existing page has the same name, the old page becomes an unnamed page.
|
ClipboardPage |
PRThread.createPageForPageNew(java.lang.String aClassName,
java.lang.String aPageName)
Create a new page of the specified class
If an existing page has the same name, the old page becomes an unnamed page.
|
ClipboardPage |
PRQueueManager.dequeue(java.lang.String aItemId)
Return one specific item from the queue by Item ID.
|
ClipboardPage |
PRQueueManager.dequeue(java.lang.String aItemId,
StringMap aOptions)
Return one specific item from the queue by Item ID.
|
ClipboardPage |
PRQueueManager.dequeueForUpdate(java.lang.String aItemId)
Return one specific item from the queue by Item 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 |
PRQueueIterator.first()
Get oldest (first) queue item based on criteria and class specified when
this QueueIterator was constructed via
PRQueueManager.iterator(String) |
ClipboardPage |
PRQueueIterator.first(boolean aAcquireLock)
Get oldest (first) queue item based on criteria and class specified when
this QueueIterator was constructed via
PRQueueManager.iterator(String) |
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:
|
ClipboardPage |
PRQueueManager.getLockedItem()
Get the currently locked item (or null) for this Queue Manager
|
ClipboardPage |
PRThread.getNodePage()
Obtain a reference to the pxProces page
|
ClipboardPage |
PageDirectory.getPage(java.lang.String aName)
Returns the page with the specified name.
|
ClipboardPage |
PageDirectory.getPage(java.lang.String aName,
ParameterPage aParameterPage)
Returns the page with the specified name and parameters.
|
ClipboardPage |
PageDirectory.getPage(java.lang.String aName,
ParameterPage aParameterPage,
boolean aCreateIfMissing) |
ClipboardPage |
PRStackFrame.getPrimaryPage()
Identifies the Primary Page of this stack frame.
|
ClipboardPage |
PRRequestor.getRequestorPage()
obtain a reference to the pxRequestor page
|
ClipboardPage |
PRThread.getRequestorPage()
Obtain a reference to the pxRequestor page
|
ClipboardPage |
PRStackFrame.getStepPage()
Identifies the Step Page of this stack frame.
|
ClipboardPage |
PRThread.getThreadPage()
Return the pxThread page
|
ClipboardPage |
PRQueueIterator.next(boolean aAcquireLock)
Get next queue item based on criteria and class specified when
this QueueIterator was constructed via
PRQueueManager.iterator(String) |
| Modifier and Type | Method and Description |
|---|---|
void |
PRThread.appendActivity(int aWhichList,
java.lang.String aClassName,
java.lang.String aActivityName,
ClipboardPage aPrimaryPage,
ParameterPage aParamPage)
Append a standard activty to one of the run queues.
|
void |
PRThread.appendActivity(int aWhichList,
java.lang.String aActivityRuleClass,
java.lang.String aClassName,
java.lang.String aActivityName,
ClipboardPage aPrimaryPage,
ParameterPage aParamPage)
Append alternate activty class to one of the run queues.
|
java.lang.String |
PRQueueManager.enqueue(ClipboardPage aItemPage)
Immediately enqueue an item for processing.
|
java.lang.String |
PRQueueManager.enqueue(ClipboardPage aItemPage,
boolean aWithErrors)
Immediately enqueue an item for processing, optionally allowing page to be saved with page/property messagse.
|
java.lang.String |
PRQueueManager.enqueueDeferred(ClipboardPage aItemPage)
Enqueue an item for processing, on the deferred operation list.
|
java.lang.String |
PRQueueManager.enqueueDeferred(ClipboardPage aItemPage,
boolean aWithErrors)
Enqueue an item for processing, on the deferred operation list.
|
java.lang.String |
PRQueueManager.enqueueLightWeight(ClipboardPage aItemPage)
Immediately enqueue an item for processing.
|
java.lang.String |
PRQueueManager.enqueueLightWeightDeferred(ClipboardPage aItemPage)
Enqueue an item for processing, on the deferred operation list.
|
java.lang.String |
PageDirectory.findName(ClipboardPage aPage)
Returns the name of the specified page.
|
java.util.Date |
PRQueueManager.getNextExecutionDateTime(ClipboardPage aItemPage)
Returns the next execution DateTime of an Item.
|
java.lang.String |
AgentUtils.getScheduleExecutionPattern(java.lang.String mCurrentLocale,
ClipboardPage page)
Fetch the agent details
|
boolean |
PRAuthorization.haveAccess(java.lang.Object aCaller,
java.lang.String aClassName,
int aAccessCode,
ClipboardPage aPage)
Return true if specified access is permitted
Similar logic is used to evaluate pre-defined access types and
application-specific privileges.
|
boolean |
PRAuthorization.haveAuthorization(java.lang.Object aCaller,
java.lang.String aClassName,
java.lang.String aRoles,
java.lang.String aPrivileges,
java.lang.String aConditions,
ClipboardPage aPage)
Return true if specified roles, privileges are held, or if specified conditions are satisfied
|
boolean |
PRAuthorization.havePrivilege(java.lang.Object aCaller,
java.lang.String aPrivilegeName,
java.lang.String aClassName,
ClipboardPage aPage)
Return true if specified privileges are held
|
boolean |
PRAuthorization.havePrivilege(java.lang.Object aCaller,
java.lang.String aPrivilegeName,
java.lang.String aClassName,
ClipboardPage aPage,
boolean aCheckForAccessManagerPrivilege)
Return true if specified privileges are held
|
void |
PRThread.prependActivity(int aWhichList,
java.lang.String aClassName,
java.lang.String aActivityName,
ClipboardPage aPrimaryPage,
ParameterPage aParamPage)
Prepend an activty to one of the run queues.
|
java.lang.Object |
PRRequestor.queueAsyncActivityOnThread(java.lang.String aClassName,
java.lang.String aActivityName,
ParameterPage aParamPage,
ClipboardPage aPrimaryPage,
java.util.List aOtherPages) |
java.lang.Object |
PRRequestor.queueBatchActivity(java.lang.String aClassName,
java.lang.String aActivityName,
ParameterPage aParamPage,
ClipboardPage aPrimaryPage)
Queue an activity to be executed within a new batch requestor
|
java.lang.Object |
PRRequestor.queueBatchActivity(java.lang.String aClassName,
java.lang.String aActivityName,
ParameterPage aParamPage,
ClipboardPage aPrimaryPage,
java.util.List aOtherPages,
boolean aIsDetachedTask)
Queue an activity to be executed within a new batch requestor
|
java.lang.String |
PRRequestProcessor.queueConnectRequest(java.lang.String aActivityClass,
java.lang.String aActivityName,
ClipboardPage aPrimaryPage,
ParameterPage aParams,
java.util.List aOtherPages)
Enqueue Connect Execution Request
|
boolean |
PageDirectory.removePage(ClipboardPage aPage)
Removes the association between the specified ClipboardPage and any name
it has been given.
|
boolean |
PageDirectory.renamePage(ClipboardPage aPage,
java.lang.String aName)
Renames the page to the specified new name.
|
boolean |
PRAuthentication.setUserSecurityProfile(PublicAPI aCaller,
java.lang.String aUserID,
ClipboardPage aOperPage)
Deprecated.
convert callers to AuthService
|
void |
PRQueueManager.update(ClipboardPage aItemPage)
Perform an immediate update (save) of the specified item.
|
void |
PRQueueManager.updateDeferred(ClipboardPage aItemPage)
Perform a deferred update (save) of the specified item.
|
void |
PRQueueManager.updateDeferred(ClipboardPage aItemPage,
boolean repairBroken)
Perform a deferred update (save) of the specified item.
|
| Modifier and Type | Method and Description |
|---|---|
ClipboardPage |
RulesetContext.getClosestVersion(ClipboardPage aRulePage)
Returns the version of a rule that is most closely related
to a given version.
|
ClipboardPage |
RulesetContext.getClosestVersionOrCurrentRule(ClipboardPage aRulePage)
Returns the version of a rule that is most closely related
to a given version or the rule itself including checked out rules
|
ClipboardPage |
CircumstanceResult.getVersion()
Deprecated.
Returns the version.
|
ClipboardPage |
Database.open(java.lang.String aInstanceHandle,
boolean aCheckSecurity)
Opens an instance from an object table by its handle.
|
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.
|
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.
|
ClipboardPage |
Database.openRDB(java.lang.String aObjectClass,
java.lang.String aRequestType,
java.lang.String aAccessMethod,
boolean aCheckSecurity)
Reads an instance using an RDB rule.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Database.addToUpdatesCache(java.lang.String aClearType,
ClipboardPage aInstancePage,
java.lang.String aParameters,
boolean aPerformOnThisNode,
boolean aPerformOnAllSystems)
Cause a rule instance to be updated on all nodes during their system pulse.
|
void |
Database.cancelDeferredUpdate(ClipboardPage aInstancePage)
Cancels the deferred addition, deletion, or update of a page.
|
void |
Database.convertListCriteria(ClipboardPage aListPage)
Converts an old-style (version 2) list criteriapage to a current
list criteria page.
|
static BadInputException |
BadInputException.createShortcutException(ClipboardPage aShortcutPage,
java.lang.String aDescr)
Creates an exception due to operating on a shortcut page.
|
boolean |
Database.delete(ClipboardPage aInstancePage,
boolean aCheckSecurity)
Immediately deletes a database instance from an object table.
|
void |
Database.deleteDeferred(ClipboardPage aInstancePage,
boolean aCheckSecurity)
Defers deleting a database instance from an object table.
|
int |
Database.executeRDB(com.pega.pegarules.priv.sqlgeneration.ISQLSelectQuery aSQLObject,
ClipboardPage aListPage)
Executes a SQL statement by using a Generated SQL Object.
|
int |
Database.executeRDB(java.lang.String aSQL,
ClipboardPage aListPage)
Executes a SQL statement.
|
ClipboardPage |
RulesetContext.getClosestVersion(ClipboardPage aRulePage)
Returns the version of a rule that is most closely related
to a given version.
|
ClipboardPage |
RulesetContext.getClosestVersionOrCurrentRule(ClipboardPage aRulePage)
Returns the version of a rule that is most closely related
to a given version or the rule itself including checked out rules
|
RulesetContext |
Database.getRulesetContext(ClipboardPage aRulePage)
Returns rule editing tools associated with a particular page.
|
RulesetContext |
Database.getRulesetContext(ClipboardPage aRulePage,
java.lang.String aRuleSetNameProperty,
java.lang.String aRuleSetVersionProperty)
Returns rule editing tools associated with a particular page when
the page has non-standard RuleSet name and RuleSet version properties.
|
boolean |
RulesetContext.isBasisOf(ClipboardPage aVersion1,
ClipboardPage aVersion2)
Is one version of a rule the basis of another version.
|
int |
Database.list(ClipboardPage aListPage,
boolean aCheckSecurity)
Lists instances from an object table.
|
int |
Database.listRDB(ClipboardPage aListPage,
java.lang.String aRequestType,
java.lang.String aAccessMethod,
boolean aCheckSecurity)
Lists instances using an RDB rule.
|
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 |
Database.removeFromNodeCache(ClipboardPage aInstancePage)
Remove a specific instance from the node's cache.
|
void |
Database.resolveResultsOnListPage(ClipboardPage aListPage)
Filters a code-pega-list page so that it only contains the rule resolved classes.
|
void |
Database.save(ClipboardPage aInstancePage,
boolean aOnlyIfNew,
boolean aCheckSecurity)
Immediately writes an instance to an object table.
|
void |
Database.save(ClipboardPage aInstancePage,
boolean aOnlyIfNew,
boolean aCheckSecurity,
boolean aWithErrors)
Immediately writes an instance to the database.
|
void |
Database.saveDeferred(ClipboardPage aInstancePage,
boolean aOnlyIfNew,
boolean aCheckSecurity)
Defers writing an instance to an object table.
|
void |
Database.saveDeferred(ClipboardPage aInstancePage,
boolean aOnlyIfNew,
boolean aCheckSecurity,
boolean aWithErrors)
Defers writing an instance to an object table.
|
void |
Database.writeIndexesForPage(ClipboardPage aPage) |
| Constructor and Description |
|---|
BadInputException(ClipboardPage aPage,
java.lang.String aDescr)
Creates an bad input exception due to the attempt to
save an invalid page.
|
CircumstanceResult(CircumstanceResult.Status aStatus,
ClipboardPage aVersion,
java.lang.String aCircumstanceProperty,
java.util.Date aExpirationDate)
Deprecated.
Creates a result.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ClassInfo.checkPropertyDefinition(ClipboardPage aPropDef)
Edits the contents of the Rule-Obj-Property instance passed to it.
|
void |
ClassInfo.checkPropertyKeys(ClipboardPage aPropDef)
Validates the contents of the Rule-Obj-Property instance passed to it.
|
java.lang.String |
Dictionary.fromDefinition(ClipboardPage aClassInstance,
java.lang.String aReference)
fetch the value of the named property from the Rule-Obj-Class instance
for the class that this instance contains.
|
boolean |
ClassInfo.isAncestorOf(ClipboardPage aPage)
Test to see if this is an ancestor of the class of aPage.
|
boolean |
ClassInfo.isChildOf(ClipboardPage aPage)
Test to see if this represents a child of a class of aPage.
|
boolean |
ClassInfo.isDefinitionOf(ClipboardPage aPage)
Test the class of the aPage parameter to see if it matches this objects' class,
|
boolean |
ClassInfo.isParentOf(ClipboardPage aPage)
Test to see if this represents the parent of the class of aPage.
|
boolean |
ClassInfo.validate(ClipboardPage aPage,
boolean aForceExpand)
Examine an instance of a ClipboardPage and validate the contents against the definition
of the class (indicated in the pxObjClass on aPage).
|
boolean |
Dictionary.validate(ClipboardPage aPage,
boolean aForceExpand)
Examine an instance of a ClipboardPage and validate the contents against the definition
of the class (indicated in the pxObjClass on aPage).
|
| Modifier and Type | Method and Description |
|---|---|
ClipboardPage |
FirstUseAssembler.getDefinition()
Supplies the definition being processed.
|
ClipboardPage |
FirstUseAssembler.getRuleBasis()
Supplies the basis, if any, for the Rule- instance being edited.
|
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 | Method and Description |
|---|---|
static boolean |
DeclarativeReference.designationsMatch(ClipboardPage aChange,
DeclarativeReference aDeclRef) |
void |
IControlTemplateGenerator.generateDropdown(ClipboardPage aCellPage,
ClipboardPage aModePage,
boolean aBLocalize) |
void |
IControlTemplateGenerator.generateLabel(ClipboardPage cellPage,
ClipboardPage modePage,
boolean bLocalize) |
void |
IControlTemplateGenerator.generateLink(ClipboardPage cellPage,
ClipboardPage modePage,
boolean bLocalize) |
IControlTemplateGenerator |
IAssemblyStreamSupport.getControlTemplateGenerator(ClipboardPage pyGenJava)
Return a reference to ControlTemplateGenerator used for generating templatized controls
|
boolean |
IControlTemplateGenerator.isTemplateSupported(ClipboardPage cellPage,
ClipboardPage modePage) |
void |
FirstUseAssembler.setOverrideDefinition(ClipboardPage aDef)
Overrides the definition being processed, original definitions are saved for
FirstUseAssembler.resetDefaultDefinition(). |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
FirstUseAssembler.translateCodeBlock(java.lang.String aCodeBlock,
java.util.Map<java.lang.String,ClipboardPage> actionPagesForErrorMessages,
boolean aSupportLinkedReference,
java.util.List<java.lang.String> aErrorList)
Translates a block of statements for a single rule as a unit.
|
| Modifier and Type | Method and Description |
|---|---|
ClipboardPage |
ChainingException.getPage()
Get the clipboard page that was the subject of the aborted declarative processing.
|
| Constructor and Description |
|---|
ChainingException(java.lang.String aCause,
ClipboardPage aPage,
java.lang.String aReference)
Construct a new ChainingException instance, providing the cause,
the target clipboard page and the target reference.
|
ChainingException(java.lang.String aCause,
ClipboardPage aPage,
java.lang.String aReference,
java.lang.String aReason) |
IndeterminateGoalException(ClipboardPage aPage,
java.lang.String aReference)
Constructor for MissingPropertyException.
|
IndeterminateGoalException(ClipboardPage aPage,
java.lang.String aReference,
java.lang.String aReason) |
MissingPropertyException(ClipboardPage aPage,
java.lang.String aReference)
Constructor for MissingPropertyException.
|
MissingPropertyException(java.lang.String aCause,
ClipboardPage aPage,
java.lang.String aReference) |
| Modifier and Type | Method and Description |
|---|---|
ClipboardPage |
PAL.getStats()
Returns the standard statistics for the current Thread, as a clipboard
page.
|
ClipboardPage |
PAL.getStats(java.util.Set aOptionalStats)
Returns the standard statistics for the current Thread, as a clipboard
page, as well as some of the optional statistics.
|
ClipboardPage |
PAL.getStats(java.lang.String aConnectionID,
java.lang.String aThreadName)
Returns the statistics for a different Thread, as a clipboard
page
|
| Modifier and Type | Method and Description |
|---|---|
ClipboardPage |
PublicAPI.createPage(java.lang.String aClassName,
java.lang.String aPageName)
Create a new page of the specified class.
|
ClipboardPage |
PublicAPI.findPage(java.lang.String aPageReference)
Locates the specified page, which can be either top-level or embedded..
|
ClipboardPage |
PublicAPI.findPage(java.lang.String aPageReference,
boolean aIfPresent)
Locates the specified page, which can be either top-level or embedded..
|
ClipboardPage |
PublicAPI.findPage(java.lang.String aPageReference,
ParameterPage aParameterPage)
Locates the specified page, which can be either top-level or embedded..
|
ClipboardPage |
PublicAPI.findPage(java.lang.String aPageReference,
ParameterPage aParameterPage,
boolean aIfPresent)
Locates the specified page, which can be either top-level or embedded..
|
ClipboardPage |
PublicAPI.findPageByHandle(java.lang.String aInsKey)
Locates the specified page, which must be top-level, by instance handle.
|
ClipboardPage |
PublicAPI.findPageWithException(java.lang.String aPageReference)
Locates the specified page, which can be either top-level or embedded.
|
ClipboardPage |
PublicAPI.generateAgentDataPage(ClipboardPage aRuleAgentQueue)
Create a Data-Agent-Queue page, based on the specified Rule-Agent-Queue instance.
|
ClipboardPage |
IUIComponent.getMetaPage()
Gets the Component meta page.
|
ClipboardPage |
PublicAPI.getPrimaryPage()
Identifies the current Primary Page.
|
ClipboardPage |
PublicAPI.getStepPage()
Identifies the current Step Page.
|
| Modifier and Type | Method and Description |
|---|---|
void |
PublicAPI.applyCollection(StringMap aCollectionKeys,
ClipboardPage aPage,
ParameterPage aParams)
Applies a Collection to an instance.
|
void |
PublicAPI.applyModel(ClipboardPage aClipboardPage,
ParameterPage aNewParamPage,
java.lang.String aModelName)
Apply a model to the specified clipboard page.
|
void |
PublicAPI.applyModel(ClipboardPage aClipboardPage,
StringMap aKeys,
ParameterPage aNewParamPage)
Apply a model to the specified clipboard page.
|
java.lang.String |
IUIComponent.beginComponent(java.lang.String name,
ClipboardPage metaPage,
java.util.Map configMap)
Starts the component rendering
|
java.lang.String |
IUIComponent.beginComponent(java.lang.String name,
ClipboardPage metaPage,
java.lang.String componentUniqueId,
java.util.Map configMap)
Starts the component rendering
|
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.
|
ClipboardPage |
PublicAPI.generateAgentDataPage(ClipboardPage aRuleAgentQueue)
Create a Data-Agent-Queue page, based on the specified Rule-Agent-Queue instance.
|
java.lang.Object |
PublicAPI.getAliasValue(ClipboardPage aPage,
ImmutablePropertyAliasInfo aPropertyAliasInfo)
Resolve the identified property alias, by evaluating the alias
on the specified clipboard page.
|
java.lang.Object |
PublicAPI.getAliasValue(ClipboardPage aPage,
java.lang.String aClassName,
java.lang.String aAliasName)
Resolve the identified property alias, by evaluating the alias
on the specified clipboard page.
|
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(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.
|
| Modifier and Type | Method and Description |
|---|---|
ClipboardPage |
ServiceUtils.deleteSavedRecords(ClipboardPage aSummaryPage,
java.util.Set aRecordTypes,
boolean aPurgeLogs)
Deletes the records generated by RuleSaver
|
ClipboardPage |
SchemaParser.generateRules()
Generate rules for the selected subset of global complex element
and type definitions.
|
ClipboardPage |
ServiceUtils.getServiceMethod(java.lang.String aType,
java.lang.String aPackage,
java.lang.String aClass,
java.lang.String aMethod)
Look up a service method instance for the given service package, class,
and method keys using the rulesets visible to the package access group.
|
ClipboardPage |
SchemaParser.parse(PRFile aFile)
Parse a schema definition document into class, model, and
property instances.
|
ClipboardPage |
SchemaParser.parse(java.io.Reader aReader)
Parse a schema definition document into class, model, and
property instances.
|
ClipboardPage |
SchemaParser.parse(java.lang.String aSource)
Parse a schema definition document into class, model, and
property instances.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ServiceUtils.buildXMLTree(java.lang.String aClassName,
ClipboardPage aTreePage,
ClipboardPage dataOptionsPage)
Populate a clipboard page with embedded page content that can be used
as the data structure for a tree view display of a complex XML element.
|
void |
ServiceUtils.buildXMLTree(java.lang.String aElemName,
java.lang.String aElemNS,
java.lang.String aClassName,
XSDComplexTypeDefinition aTypeDef,
ClipboardPage aTreePage)
Populate a clipboard page with embedded page content that can be used
as the data structure for a tree view display of a complex XML element.
|
void |
ServiceUtils.buildXMLTree(java.lang.String aElemName,
java.lang.String aElemNS,
XSDComplexTypeDefinition aTypeDef,
ClipboardPage aTreePage)
Populate a clipboard page with embedded page content that can be used
as the data structure for a tree view display of a complex XML element.
|
void |
ServiceUtils.buildXMLTree(java.lang.String aClassName,
XSDElementDeclaration aElemDecl,
ClipboardPage aTreePage)
Populate a clipboard page with embedded page content that can be used
as the data structure for a tree view display of a complex XML element.
|
void |
ServiceUtils.buildXMLTree(XSDElementDeclaration aElemDecl,
ClipboardPage aTreePage)
Populate a clipboard page with embedded page content that can be used
as the data structure for a tree view display of a complex XML element.
|
org.opensaml.saml2.core.AuthnRequest |
SAMLUtils.createAuthenticationRequest(ClipboardPage samlSSOConfigPage)
Generates the SAML Authentication Request from the given input ClipboardPage of "Data-Admin-Security-SSO-SAML"
The input ClipboardPage should contain values for the below properties :
pyIssuer - Issuer or entity ID
pyIDPSSOServiceLocation - IDP's Single Sign On Service endpoint
pyProtocolBinding - IDP's Response binding protocol
pyAssertionConsumerServiceURL - Assertion Consumer Service URL
pyIsSigningDisabled, pyKeystore, pySignatureUser, pySignaturePassword - For signing information
|
org.opensaml.saml2.core.LogoutRequest |
SAMLUtils.createLogoutRequest(ClipboardPage samlSSOConfigPage)
Generates the SAML Logout Request from the given input ClipboardPage of "Data-Admin-Security-SSO-SAML"
|
org.opensaml.saml2.core.LogoutResponse |
SAMLUtils.createLogoutResponse(ClipboardPage samlSSOConfigPage,
java.lang.String logoutRequestString)
Generates the SAML Logout Response from the given input ClipboardPage of "Data-Admin-Security-SSO-SAML"
|
java.lang.String |
ServiceUtils.createMDBComponent(ClipboardPage aJMSListenerPage)
Generate, compile, and JAR a deployable MDB for JMS MDB Listener.
|
java.lang.String |
ServiceUtils.createSampleXMLInstance(ClipboardPage aTreePage,
boolean aIsEncoded)
Create a sample XML instance using the XML metadata derived from the
given clipboard page.
|
java.lang.String |
ServiceUtils.createSOAPRequestEnvelope(ClipboardPage aServiceRule)
Create a sample SOAP request envelope to be used as input for
performing a SOAP service simulation.
|
java.lang.String |
SAMLUtils.createSPmetadataServiceURL(ClipboardPage authServicePage)
gets the sp meta data url
|
void |
ServiceUtils.createWSDL(StringMap aParams,
ClipboardPage aListPage)
Generate and return the WSDL for a SOAP service class.
|
ClipboardPage |
ServiceUtils.deleteSavedRecords(ClipboardPage aSummaryPage,
java.util.Set aRecordTypes,
boolean aPurgeLogs)
Deletes the records generated by RuleSaver
|
void |
ServiceUtils.evaluateRulesFromMetadata(ClipboardPage aGenerationRequest,
ParameterPage aParams,
ClipboardPage aResultPage)
Deprecated.
- use generateRulesFromMetadata method with generation request parameter:
pyEvaluate = true
|
void |
ServiceUtils.executeServiceSimulation(ClipboardPage aSimulationData)
Execute a service rule using the input data on the provided clipboard page.
|
int |
EFormUtils.extractDataFromEForm(byte[] aEFormBytes,
java.lang.String aEFormMappingRule,
ClipboardPage aPage)
Extracts eForm form field values and maps them to the clipboard.
|
int |
EFormUtils.extractDataFromEForm(java.io.File aEFormFile,
java.lang.String aEFormMappingRule,
ClipboardPage aPage)
Extracts eForm field values and maps them to the clipboard.
|
int |
EFormUtils.extractDataFromEForm(java.io.InputStream aEFormInputStream,
java.lang.String aEFormMappingRule,
ClipboardPage aPage)
Extracts eForm field values and maps them to the clipboard.
|
int |
EFormUtils.extractDataFromEForm(java.lang.String aEFormMappingRule,
ClipboardPage aPage)
Extracts eForm field values and maps them to the clipboard.
|
int |
EFormUtils.extractDataFromEForm(java.net.URL aEFormUrl,
java.lang.String aEFormMappingRule,
ClipboardPage aPage)
Extracts eForm field values and maps them to the clipboard.
|
java.lang.String |
SAMLUtils.generateArtifactId(org.opensaml.common.SAMLObject samlObject,
ClipboardPage samlSSOConfigPage)
Method which generates the ArtifactId for the given SAMLObject
|
java.lang.String |
SAMLUtils.generateArtifactResolveRequest(java.lang.String artifactIdString,
ClipboardPage samlSSOConfigPage)
Generates the ArtifactResolveRequest based on the artifactString and
the details available on clipboard page
|
java.lang.String |
ServiceUtils.generateMDBDescriptor(ClipboardPage aJMSListenerPage)
Generate MDB EJB Deployment Descriptor for Rule-Service-JMS Listener
|
void |
ServiceUtils.generatePegaDataModelFromSampleXMLInstances(ClipboardPage aGenerationRequest,
ParameterPage aParams)
Deprecated.
- use generateRulesFromMetadata method with generation request parameters:
pyMetadataType = "XML" and pyGenerationPurpose = "DataModel"
|
byte[] |
EFormUtils.generatePopulatedEForm(byte[] aEFormBytes,
java.lang.String aEFormMappingRule,
ClipboardPage aPage)
Merge clipboard data into a eForm.
|
byte[] |
EFormUtils.generatePopulatedEForm(java.io.File aEFormFile,
java.lang.String aEFormMappingRule,
ClipboardPage aPage)
Merge clipboard data into a eForm.
|
byte[] |
EFormUtils.generatePopulatedEForm(java.io.InputStream aEFormInputStream,
java.lang.String aEFormMappingRule,
ClipboardPage aPage)
Merge clipboard data into a eForm.
|
byte[] |
EFormUtils.generatePopulatedEForm(java.lang.String aEFormMappingRule,
ClipboardPage aPage)
Merge clipboard data into a eForm.
|
byte[] |
EFormUtils.generatePopulatedEForm(java.net.URL aEFormUrl,
java.lang.String aEFormMappingRule,
ClipboardPage aPage)
Merge clipboard data into a eForm.
|
java.lang.String |
SAMLUtils.generateRedirectURL(java.lang.String endpoint,
org.opensaml.common.SAMLObject samlObject,
ClipboardPage samlSSOConfigPage,
java.lang.String relayState)
Method which generates the Single logout redirect URL for response purpose
|
void |
ServiceUtils.generateRulesFromJsonStream(ClipboardPage aGenerationRequest,
ParameterPage aParams)
Deprecated.
- use generateRulesFromMetadata method with generation request parameters:
pyMetadataType = "JSON" and pyGenerationPurpose = "DataModel"
|
void |
ServiceUtils.generateRulesFromMetadata(ClipboardPage aGenerationRequest,
ParameterPage aParams)
Generate Rules from a metadata source
|
void |
ServiceUtils.generateStreamRuleContent(ClipboardPage aRulePage)
Create the JSP stream content for a Rule-Obj-XML rule instance using
the XML metadata derived from the tree view rule data of the given
rule instance page.
|
java.lang.String |
COBOLUtils.getCobolCopybookDefinition(ClipboardPage aPrimaryPage) |
java.util.HashMap |
ServiceUtils.getCredentials(java.util.List keyList,
ClipboardPage aAuthPage,
ClipboardPage aObjPage)
fetch property values from authentication profiles, accounting for indirection and encryption.
|
java.util.HashMap |
ServiceUtils.getJMSConfigFollowingSojSpec(ClipboardPage aConnectorPage,
java.lang.String aEndPointURL)
fetch SOAP over JMS config as per SOJ spec
|
javax.naming.Context |
ServiceUtils.getJNDIContext(ClipboardPage aServerPage)
Get the JNDI server initial context object.
|
javax.naming.Context |
ServiceUtils.getJNDIContext(ClipboardPage aServerPage,
boolean isLocal)
Get the JNDI server initial context object.
|
java.lang.Object |
ServiceUtils.getOutboundClipboardValue(java.lang.String aMapFromKey,
java.lang.String aDataType,
ParameterPage aParamPage,
ClipboardPage aPrimaryPage)
Map Clipboard property value to outbound object value
|
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
|
java.util.List<java.lang.String> |
ServiceUtils.getSavedRecordHandles(ClipboardPage aSummaryPage,
java.util.Set aRecordTypes)
Obtains a List of handles for records saved by a RuleSaver object
Placeholder handles are used for records that are missing from the database.
|
java.lang.Class |
ServiceUtils.initializeAxisClient(ClipboardPage aRulePage,
boolean aForce)
Deprecated.
|
void |
ServiceUtils.invokeCMISConnector(ClipboardPage aConnectorPage,
ClipboardPage aCMISServicePage)
Invoke a CMIS Connector
|
void |
ServiceUtils.invokeFTPConnector(ClipboardPage aFTPServerPage,
java.util.Map aMethodParams)
Invoke an FTP Connector
|
boolean |
ServiceUtils.isListenerBlocked(ClipboardPage aListener)
Should we be running this listener on any nodes?
|
java.io.ByteArrayOutputStream |
COBOLUtils.mapFromClipboardToStream(ClipboardPage aPrimaryPage,
MapCOBOLDataStructure data)
Applies Map-COBOL rule to the contents of the clipboard and maps values to the output stream,
filling in gaps with pad characters.
|
java.io.ByteArrayOutputStream |
StructuredUtils.mapFromClipboardToStream(ClipboardPage aPrimaryPage,
java.lang.String aPurpose)
Applies Map-Structured rule to the contents of the clipboard and maps values to the output stream,
filling in gaps with pad characters.
|
java.lang.String |
COBOLUtils.mapFromClipboardToString(ClipboardPage aPrimaryPage,
MapCOBOLDataStructure data)
Applies Map-COBOL rule to the contents of the clipboard and maps values to the output string,
filling in gaps with pad characters.
|
java.lang.String |
StructuredUtils.mapFromClipboardToString(ClipboardPage aPrimaryPage,
java.lang.String aPurpose)
Applies Map-Structured rule to the contents of the clipboard and maps values to the output string,
filling in gaps with pad characters.
|
boolean |
ServiceUtils.mapInboundAxisHeaders(ClipboardProperty aMappings,
java.util.Map aValues,
ParameterPage aParamPage,
ClipboardPage aPrimaryPage)
Map inbound java object values to Clipboard data.
|
boolean |
ServiceUtils.mapInboundAxisValues(ClipboardProperty aMappings,
ClipboardProperty aPageMappings,
java.util.List aValues,
ParameterPage aParamPage,
ClipboardPage aPrimaryPage)
Map inbound java object values to Clipboard data.
|
boolean |
ServiceUtils.mapInboundData(ClipboardProperty aMappings,
java.util.List aValues,
ParameterPage aParamPage,
ClipboardPage aPrimaryPage)
Map inbound java object values to Clipboard data.
|
boolean |
ServiceUtils.mapInboundData(ClipboardProperty aMappings,
java.util.Map aValues,
ParameterPage aParamPage,
ClipboardPage aPrimaryPage)
Map inbound string values to Clipboard data.
|
boolean |
ServiceUtils.mapOutboundAxisHeaders(ClipboardProperty aMappings,
java.util.Map aValues,
ParameterPage aParamPage,
ClipboardPage aPrimaryPage)
Map Clipboard data to outbound java object values.
|
boolean |
ServiceUtils.mapOutboundAxisValues(ClipboardProperty aMappings,
ClipboardProperty aPageMappings,
java.util.List aValues,
ParameterPage aParamPage,
ClipboardPage aPrimaryPage)
Map Clipboard data to outbound java object values.
|
boolean |
ServiceUtils.mapOutboundData(ClipboardProperty aMappings,
java.util.List aValues,
ParameterPage aParamPage,
ClipboardPage aPrimaryPage)
Map Clipboard data to outbound java object values.
|
boolean |
ServiceUtils.mapOutboundData(ClipboardProperty aMappings,
java.util.Map aValues,
ParameterPage aParamPage,
ClipboardPage aPrimaryPage)
Map Clipboard data to outbound string values.
|
void |
COBOLUtils.mapToClipboard(ClipboardPage aPrimaryPage,
java.io.InputStream inputStream,
MapCOBOLDataStructure data)
Applies Map-COBOL rule to the contents of the stream and maps values to the clipboard.
|
void |
StructuredUtils.mapToClipboard(ClipboardPage aPrimaryPage,
java.io.InputStream inputStream,
java.lang.String aPurpose)
Applies Map-Structured rule to the contents of the stream and maps values to the clipboard.
|
void |
COBOLUtils.mapToClipboard(ClipboardPage aPrimaryPage,
java.lang.String inputString,
MapCOBOLDataStructure data)
Applies Map-COBOL rule to the contents of the string and maps values to the clipboard.
|
void |
StructuredUtils.mapToClipboard(ClipboardPage aPrimaryPage,
java.lang.String inputString,
java.lang.String aPurpose)
Applies Map-Structured rule to the contents of the string and maps values to the clipboard.
|
boolean |
ParseUtils.parseDelimited(java.io.Reader aData,
java.lang.String aNamespace,
java.lang.String aRecordType,
ClipboardPage aPrimaryPage,
ParameterPage aParameterPage)
Apply a delimited parse rule.
|
boolean |
ParseUtils.parseDelimited(java.io.Reader aData,
java.lang.String aNamespace,
java.lang.String aRecordType,
ClipboardPage aPrimaryPage,
ParameterPage aParameterPage,
int length)
Apply a delimited parse rule.
|
boolean |
ParseUtils.parseDelimited(java.io.Reader aData,
java.lang.String aNamespace,
java.lang.String aRecordType,
ClipboardPage aPrimaryPage,
ParameterPage aParameterPage,
java.lang.String aDelimiter)
Apply a delimited parse rule.
|
void |
ParseUtils.parseStructured(java.io.Reader aData,
java.lang.String aRecordType,
ClipboardPage aPrimaryPage,
ParameterPage aParameterPage)
Apply a structured parse rule.
|
void |
ParseUtils.parseXML(org.w3c.dom.Element aNode,
java.lang.String aNamespace,
ClipboardPage aPrimaryPage)
Deprecated.
|
void |
ParseUtils.parseXML(org.w3c.dom.Element aNode,
java.lang.String aNamespace,
java.lang.String aElementName,
ClipboardPage aPrimaryPage)
Apply an XML parse rule.
|
void |
ParseUtils.parseXML(java.io.Reader aReader,
java.lang.String aNamespace,
ClipboardPage aPrimaryPage)
Deprecated.
|
void |
ParseUtils.parseXML(java.io.Reader aReader,
java.lang.String aNamespace,
java.lang.String aElementName,
ClipboardPage aPrimaryPage)
Apply an XML parse rule.
|
void |
ParseUtils.parseXML(java.lang.String aXMLData,
java.lang.String aNamespace,
ClipboardPage aPrimaryPage)
Deprecated.
|
void |
ParseUtils.parseXML(java.lang.String aXMLData,
java.lang.String aNamespace,
ClipboardPage aPrimaryPage,
java.lang.String aElementName)
Deprecated.
|
void |
ParseUtils.parseXML(java.lang.String aXMLData,
java.lang.String aNamespace,
java.lang.String aElementName,
ClipboardPage aPrimaryPage)
Apply an XML parse rule.
|
void |
ParseUtils.parseXMLUsingNewAssembly(java.lang.String aXMLData,
java.lang.String aNamespace,
java.lang.String aElemName,
ClipboardPage aPrimaryPage)
Apply an XML parse rule using the new assembly
|
java.lang.String |
SAMLUtils.processArtifactResolveResponse(java.lang.String artifactRespString,
ClipboardPage samlSSOConfigPage)
Processes the response which comes in the form of a Artifact id and uses the
details available on clipboard page to generate the SAML response
|
java.util.Map<java.lang.String,java.lang.Object> |
SAMLUtils.processAuthenticationResponse(java.lang.String responseMessage,
ClipboardPage samlSSOConfigPage)
Process the SAML Authentication Response - Performs SAML Protocol validation,
SAML Web SSO profile validation and prepares map of attribute values in received assertion
|
java.lang.String |
SAMLUtils.processLogoutRequest(java.lang.String logoutRequest,
ClipboardPage samlSSOConfigPage)
Method to process the logout response and finds whether the response is valid or not
|
java.lang.String |
SAMLUtils.processLogoutResponse(java.lang.String logoutResponse,
ClipboardPage samlSSOConfigPage)
Method to process the logout response and finds whether the response is valid or not
|
void |
ServiceUtils.removeEmptyPropertiesFromPage(ClipboardPage aPage)
Recursively traverse a clipboard page, removing all properties that contain no data.
|
java.lang.String |
ServiceUtils.resolvePassword(java.lang.String aVal,
ClipboardPage aObjPage)
Resolve a password by decoding, following up to 10 nested references.
|
void |
ServiceUtils.setInboundClipboardValue(java.lang.String aMapToKey,
java.lang.Object aSourceValue,
ParameterPage aParamPage,
ClipboardPage aPrimaryPage)
Map inbound Object to Clipboard property value.
|
boolean |
ServiceUtils.testCMISConnection(ClipboardPage aPrimaryPage,
ClipboardPage aResultsPage)
Test Connectivity for a CMIS Server
Fill in results on the page passed in.
|
boolean |
ServiceUtils.testFTPConnection(ClipboardPage aFTPServerPage,
ClipboardPage aResultsPage)
Test Connectivity for an FTP Server.
|
void |
ServiceUtils.upgradeLegacyParseRule(ClipboardPage aRulePage)
Convert the rule data of the legacy parse rule to the new format.
|
void |
ServiceUtils.validateListener(ClipboardPage aStepPage)
Deprecated.
|
boolean |
ServiceUtils.validateXMLParseRule(ClipboardPage aRulePage)
Generate the java source for the parse steps contained in the given
Rule-Parse-XML record.
|
Copyright © 2015 Pegasystems Inc. All Rights Reserved.