Package | Description |
---|---|
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.
|
Modifier and Type | Method and Description |
---|---|
void |
PRQueueManager.commit()
Commit currently locked queue item to queue.
|
void |
PRQueueManager.delete(java.lang.String aItemId)
Delete an item immediately from the queue by Item ID.
|
void |
PRQueueManager.deleteDeferred(java.lang.String aItemId)
Delete an item from the queue by Item ID.
|
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.
|
PRQueueManager |
PRThread.getQueueManager()
Return the Agent Queue Manager interface
|
boolean |
PRQueueManager.repair(java.lang.String aItemId)
Repair an item that is broken.
|
boolean |
PRQueueManager.repairDeferred(java.lang.String aItemId)
Repair an item that is broken, using a deferred save.
|
void |
PRQueueManager.rollback()
Deal with failed item processing for the currently locked item.
|
void |
PRQueueManager.rollback(java.lang.String aReason) |
void |
PRQueueManager.update()
Perform an immediate update (save) of the currently locked item.
|
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 | Class and Description |
---|---|
class |
AuthorizationException
Indicates that a database operation could not be performed due to
insufficient authorization.
|
class |
BadClassDefinitionException
Indicates that a PegaRULES class does not exist, or if there
is some other problem with its definition.
|
class |
BadDatabaseDefinitionException
Database configuration is invalid or missing.
|
class |
BadInputException
Indicates that an input to a database method is invalid.
|
class |
BadInstanceDataException
This exception is thrown when PegaRULES encounters a database record with corrupt data.
|
class |
BadRoleException
Exception thrown when a bad role is specified.
|
class |
BadRulesetException
An exception with a ruleset--either a badly formatted
ruleset string, or an undefined ruleset, depending on the method.
|
class |
BadTableMappingException
Indicates that there is a problem mapping from a class instance
to a table.
|
class |
CacheException
Indicates that the cache detected an error.
|
class |
ConfigurationException
This exception is thrown if there is bad configuration.
|
class |
ConnectionException
This class and its subclasses represent database-related connectivity
errors (as opposed to operational errors).
|
class |
DuplicateKeyException
Indicates that a duplicate key violation occurred, such as a duplicate primary key or any other unique constraint
|
class |
InitializationException
Deprecated.
use a more specific exception class instead
|
class |
IntegrityConstraintViolationException
Indicates that the Integrity constraint violation is detected
|
class |
JTAException
JTAException simply encapsulates the myriad exceptions that come from
the Java Transaction API.
|
class |
LockFailureException
An exception that is thrown when a lock-related problem
occurs.
|
class |
LockGoneException
This exception indicates that an expected lock is gone.
|
class |
LockStolenException
An exception indicating that a required lock has been stolen by another
Requestor.
|
class |
MultipleCircumstancePropertiesException
This exception is thrown when PegaRULES encounters more than one version of
a Rule with the same name, but different Circumstance (
pyCircumstanceProp ) or Date
Circumstance (pyCircumstanceDateProp ) Properties. |
class |
MultipleInstancesWithKeyException
Describes the problem where the Database Interface encounters more
than one record when submitting a query to perform an "open."
|
class |
MultipleRuleVersionException
This exception is thrown when PegaRULES encounters more than one version of a
Rule with identical Rule Resolution characteristics.
|
class |
NonexistentTableException
This exception is thrown when PegaRULES configuration points to a database
table that does not exist.
|
class |
NoRuleVersionWithoutCircumstanceException
This exception is thrown during Rule Resolution if there is no default
Rule version found.
|
class |
RuleSaveNotSupportedException
An exception in database processing.
|
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 |
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.addToUpdatesCache(java.lang.String aClearType,
java.lang.String aObjClass,
java.lang.String aInsKey,
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 |
LockManager.checkRequiredLocks(java.util.Set keyset)
Check that all keys in keyset are locked
|
void |
Database.commit()
Commits the current PegaRULES Transaction (applies all deferred
database changes).
|
void |
Database.convertListCriteria(ClipboardPage aListPage)
Converts an old-style (version 2) list criteriapage to a current
list criteria 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.
|
void |
Database.deleteRDB(java.lang.String aObjectClass,
java.lang.String aRequestType,
java.lang.String aAccessMethod,
boolean aCheckSecurity)
Immediately deletes data from the database using an RDB rule.
|
boolean |
Database.doClassesBelongToSingleDb(boolean aUseReportDb,
java.util.ArrayList aClasses)
Figures out if all classes in a SQL statement use the same dtabase instance.
|
boolean |
Database.doesInstanceExist(java.lang.String aInstanceHandle)
Indicates whether a particular instance exists in the database.
|
void |
Database.executeDBSchemaUpdates(java.util.List aSQL,
java.lang.String aDBName,
java.lang.String aUserName,
java.lang.String aPassword)
Executes SQL statements against a particular database, connecting with
a specified user name.
|
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.
|
int |
LockManager.expireRequestorLocks()
When current requestor times out expire all locks
held by him by moving the expiration date to now
|
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.
|
void |
Database.flushUpdatesCache(int aDeltaMinutes)
Flush out entries in pr_sys_updatescache older than given number of minutes
|
java.util.Collection |
Database.getClassesInTable(java.lang.String aDBName,
java.lang.String aTableName)
|
java.util.Collection |
Database.getClassesInTable(java.lang.String aDBName,
java.lang.String aCatalog,
java.lang.String aSchema,
java.lang.String aTable)
Gets all the classes that live in a particular database table.
|
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
|
java.lang.String |
Database.getColumnDataTypeForProperty(java.lang.String aClassName,
java.lang.String aPropertyName)
Returns the column data type for a property whether explicitly mapped or not.
|
java.lang.String |
Database.getColumnForProperty(java.lang.String aClassName,
java.lang.String aPropertyName)
Returns the column name for a property whether explicitly mapped or not.
|
java.util.SortedSet |
Database.getColumnsForTable(java.lang.String aDBName,
java.lang.String aTableName)
Deprecated.
this method does not allow you to specify the
catalog and schema of the table
|
java.lang.String |
ClassDefinition.getDatabase()
Returns the database (as defined in
Data-Admin-DB-Name ) in
which instances of this class are stored. |
java.lang.String |
ClassDefinition.getDatabase(boolean isReportDb)
Returns the database (as defined in
Data-Admin-DB-Name ) in
which instances of this class are stored. |
java.lang.String |
Database.getDataUniqueID(java.lang.String aOrganization,
java.lang.String aPrefix,
java.lang.String aSuffix)
Obtain a unique ID value for items
|
DatabaseInformation |
Database.getDBInfo(java.lang.String aDBName)
Returns low-level information about a database.
|
java.lang.String |
ClassDefinition.getDBProductName()
Deprecated.
|
java.lang.String |
ClassDefinition.getDBProductName(PublicAPI aPega)
Returns the name of the database program that manages the table in which
this class is stored.
|
java.util.List |
Database.getDBSchemas(java.lang.String aDBName)
Returns a array of strings that are the schema's available from this db connection.
|
java.util.Collection |
Database.getDBTables(java.lang.String aDBName,
java.lang.String aCatalogName,
java.lang.String aSchemaName,
java.lang.String[] aTableTypes)
Returns a Collection of com.pega.pegarules.pub.database.DatabaseTable objects
that contain information about a database's tables.
|
java.util.Collection |
Database.getExposedList(ClassDefinition cdCurrentClass)
Deprecated.
use
PegaClassDefinition.getColumnsInTable()
instead |
java.lang.String |
Database.getHandle(StringMap aInstancePage)
Calculates the handle of an instance.
|
java.lang.String |
LockManager.getLockHandle(StringMap aInstancePage)
Gets the handle that would be used to lock an instance.
|
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.
|
java.util.List<java.lang.String> |
Database.getRulesetsFromApplication(java.util.List aApplicationList,
boolean aFollowDependencies,
boolean aFollowByParent)
Takes a list of Applications and returns the rulesets defined in those applications
|
java.lang.String |
DatabaseTable.getSchemaNameForTable()
Returns the value of the pySchemaName property of this Data-Admin-DB-Table instance.
|
DatabaseTable |
ClassDefinition.getTable()
Returns table that a class is mapped to.
|
java.lang.String |
ClassDefinition.getTableName()
Deprecated.
|
java.lang.String |
ClassDefinition.getTableName(PublicAPI aPega)
Returns the table in which this class is stored.
|
boolean |
DatabaseTable.hasStream()
Indicates whether this database table have a stream column?
|
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 |
ClassDefinition.isMappedToBaseTable()
Is this class mapped to the base table?
|
boolean |
ClassDefinition.isMappedToExternalTable()
Is this class mapped to an external table?
|
boolean |
ClassDefinition.isPropertyExposed(java.lang.String aPropertyName,
PublicAPI aContext)
Is a property exposed as a column in the
table in which instances of this class live?
|
int |
ClassDefinition.isPropertyMappedtoAnotherName(java.lang.String aPropertyName,
PublicAPI aContext,
java.lang.StringBuffer aMappedName)
Determine if the passed in property is mapped to another case
sensitive version of the property also mapped to the same
db table
|
boolean |
DatabaseTable.isTable()
Indicates whether or not the database table is a table (as opposed to a view or something else).
|
boolean |
DatabaseTable.isView()
Indicates whether or not the database table is a view (as opposed to a table or something else).
|
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.
|
boolean |
LockManager.lock(java.lang.String aLockName,
boolean aUnlockOnCommit)
Locks a generic string.
|
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.
|
void |
Database.noteConfigChangesInClassMap(java.util.Collection configSaves,
java.util.Collection configDeletes)
Used by the system pulse (Code-.SystemPulse) to notify the classMap of config changes
|
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.
|
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.
|
ClipboardPage |
Database.openRDB(java.lang.String aObjectClass,
java.lang.String aRequestType,
java.lang.String aAccessMethod,
boolean aCheckSecurity)
Reads an instance using an RDB rule.
|
void |
RulesetContext.openRuleUtilityFunction(StringMap aKeyPage)
Opens the undecorated and decorated(if any) Rule-Utility-Function instances
and add it to Rule Referencing.
|
java.util.Map |
Database.performSystemIndex()
Synchronizes the PegaRULES index with changes from all the nodes on this system.
|
java.util.Hashtable |
Database.performSystemPulse()
Synchronize self with rest of nodes on this system
|
void |
Database.resolveResultsOnListPage(ClipboardPage aListPage)
Filters a code-pega-list page so that it only contains the rule resolved classes.
|
void |
Database.rollback()
Rolls back a PegaRULES Transaction (discards all deferred database changes).
|
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.saveRDB(java.lang.String aObjectClass,
java.lang.String aRequestType,
java.lang.String aAccessMethod,
boolean aCheckSecurity)
Immediately saves information to the database, using an RDB rule.
|
void |
Database.testConnection(java.lang.String aConnectMethod,
java.lang.String aDBName,
java.lang.String aDBUrl,
java.lang.String aDBJndiName,
java.lang.String aDBUserName,
java.lang.String aDBPassword,
com.pega.pegarules.priv.PegaAPI aPega)
Tests to see if we can get a connection to a particular database.
|
boolean |
LockManager.unlock(java.lang.String aLockName,
boolean aInDifferentRequestor)
Unlocks a generic string.
|
boolean |
LockManager.unlock(StringMap aInstancePage,
boolean aInDifferentRequestor)
Unlocks an instance.
|
int |
LockManager.unlockAllForOperator()
Deprecated.
As of version 6.3, use
LockManager.unlockForRequestor() instead. |
int |
LockManager.unlockForRequestor()
Unlocks all locks held by the current requestor.
|
void |
Database.writeIndexesForPage(ClipboardPage aPage) |
Constructor and Description |
---|
BadRulesetException(java.lang.String aBadRuleset,
java.lang.String aDescr,
DatabaseException e) |
Modifier and Type | Method and Description |
---|---|
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.
|
Copyright © 2015 Pegasystems Inc. All Rights Reserved.