com.pega.pegarules.pub.dictionary

Interface Dictionary

public interface Dictionary

DictionaryImpl contains the cache of ClassInfoImpl objects that have been accessed by this thread since this DictionaryImpl was created. By creating a new DictionaryImpl you clear that cache and begin collecting information again. Use the Dictionary object that you get from your thread's PRThread.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static int	PROMPTLIST_INDEX_LOCALIZEDVALUE Localized value field for Prompt List entries (pyLocalizedValue)
static int	PROMPTLIST_INDEX_STANDARDVALUE Value field for Prompt List entries (pyStandardValue)
static int	TABLEEDITINFO_INDEX_ENTRYCODE pzEntryCode
static int	TABLEEDITINFO_INDEX_FIELDCLASS pyFieldClass
static int	TABLEEDITINFO_INDEX_FIELDNAME pyFieldName
static int	TABLEEDITINFO_INDEX_TABLECLASS pyTableClass
static int	TABLEEDITINFO_INDEX_TABLEOPTION pyTableOption
static int	TABLEEDITINFO_INDEX_TABLESELECTOR pyTableSelector
static int	TABLEEDITINFO_INDEX_USEFORLOCALIZATION pyUseForLocalization
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
java.lang.String	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.
java.lang.String	fromDefinition(ClipboardProperty aProperty, java.lang.String aReference) fetch the value of the named property from the Rule-Obj-Property instance for this property.
java.lang.String	fromDefinition(java.lang.String aClassName, java.lang.String aReference) fetch the value of the named property from the Rule-Obj-Class instance for the class in aClassName.
java.lang.String	fromDefinition(java.lang.String aClassName, java.lang.String aPropertyName, java.lang.String aReference) fetch the value of the named property from the Rule-Obj-Property instance for the property that is defined by this class and property name.
java.lang.String	getApplet(java.lang.String aClassName) Returns the value of pyApplet for this Rule-Obj-Class
java.lang.String	getAppletHarness(java.lang.String aClassName) Returns the value of pyAppletHarness for this Rule-Obj-Class
java.lang.String	getCategory(java.lang.String aClassName) Returns the value of pyCategory for this Rule-Obj-Class
ClassInfo	getClassInfo(java.lang.String aClassName) fetches the informational object for classes.
java.lang.String	getClassName(java.lang.String aRootClass, java.lang.String aReference) Given a class and a page reference relative to that class, return the class of the referenced embedded page.
java.lang.String	getClassName(java.lang.String aRootClass, java.lang.String aReference, boolean aAllowEmptySubscripts) Given a class and a page reference relative to that class, return the class of the referenced embedded page.
java.lang.String	getExpectedSize(java.lang.String aClassName, java.lang.String aPropertyName) Get the Expected Size for a property (pyExpectedSize).
java.lang.String	getFormType(java.lang.String aClassName) Returns the value of pyFormType for this Rule-Obj-Class
java.lang.String	getGatewayClass(java.lang.String aClassName, java.lang.String aPropertyName) Returns the gateway class for a Rule-Obj-Property
java.util.Map	getGatewayPropertyMap(java.lang.String aClassName, java.lang.String aPropertyName) Returns a map containing key value for source and target properties for a gateway property
ImmutablePropertyInfo	getImmutablePropertyInfo(java.lang.String aClassName, java.lang.String aPropertyName) Get the ImmutablePropertyInfo object for the named property.
java.util.Set	getJavaPropertyNames(java.lang.String aClassName) Return a list of all properties in the given class that are of mode Java Property or Java Property List.
java.lang.String[]	getLocalList(java.lang.String aClassName, java.lang.String aPropertyName) Gets the local list information for this property.
java.lang.String	getMethodStatus(java.lang.String aClassName) Return the value of pyMethodStatus for this Rule-Obj-Class
java.lang.String	getModeName(char aMode) Translates a Property Mode code (like PropertyInfo.MODE_STRING) to its English string.
java.lang.String[][]	getPromptList(java.lang.String aClassName, java.lang.String aPropertyName) Gets the prompt list information for this property.
java.lang.String	getPropertyClass(java.lang.String aClassName, java.lang.String aPropertyName) Get the class that the requested property is actually defined on.
java.lang.String	getPropertyLabel(java.lang.String aClassName, java.lang.String aPropertyName) Get the label of the requested property.
ClipboardProperty	getPropertyViaQualifier(ClipboardProperty aProperty, java.lang.String aQualifierName) Retrieves the ClipboardProperty referred to by the value of the named qualifier.
java.lang.String	getQualifier(ClipboardProperty aProperty, java.lang.String aQualifierName) Returns the value of the named qualifier, if present, from the Rule-Obj-Property instance that defines this property.
java.lang.String	getQualifier(java.lang.String aClassName, java.lang.String aPropertyName, java.lang.String aQualifierName) Returns the value of the named qualifier, if present, from the Rule-Obj-Property instance that defines this property.
java.lang.String	getRuleSet(java.lang.String aClassName, java.lang.String aPropertyName) Get the ruleset name that the requested property is actually defined on.
java.lang.String	getRuleSetVersion(java.lang.String aClassName, java.lang.String aPropertyName) Get the ruleset version that the requested property is actually defined on.
java.lang.String[]	getTableEditInfo(java.lang.String aClassName, java.lang.String aPropertyName) Gets basic table edit information for this property.
java.lang.String	getTypeName(char aType) Translates a Property Type code (like PropertyInfo.TYPE_TEXT) to its English string.
boolean	hasQualifier(ClipboardProperty aProperty, java.lang.String aQualifierName) Test for the existance of a qualifier for a particular property.
boolean	hasQualifier(java.lang.String aClassName, java.lang.String aPropertyName, java.lang.String aQualifierName) Test for the existance of a qualifier for a particular property.
boolean	hasRuntimeQualifier(ClipboardProperty aProperty, java.lang.String aQualifierName) Test for the existance of a run-time qualifier definition for a particular property.
boolean	isReference(java.lang.String aClassName, java.lang.String aPropertyName) Is this property defined as a Reference property?
boolean	isRetrieveEachPageSeperately(java.lang.String aClassName, java.lang.String aPropertyName) Is this property defined as RetrieveEachPageSeperately?
boolean	isThereAnyLinkedPropertyInThisPropertyReference(java.lang.String aClassName, java.lang.String aPropRef)
void	reset() Clears the internal cache of classes and properties as looked up via rule resolution with the qualifiers that were in effect at that time.
boolean	setPropertyViaQualifier(ClipboardProperty aProperty, java.lang.String aQualifierName, ClipboardProperty aValue) Sets the ClipboardProperty referred to by the value of the named qualifier to the value provided.
boolean	setPropertyViaQualifier(ClipboardProperty aProperty, java.lang.String aQualifierName, java.lang.String aValue) Sets the ClipboardProperty referred to by the value of the named qualifier to the value provided.
java.lang.String	shouldSkipLocalization(java.lang.String aClassName, java.lang.String aPropertyName) Is this property configured to skip localization.
boolean	usesQualifiedRuleResolution(java.lang.String aClassName) Does this Rule-Obj-Class use circumstance qualified rule resolution (allows selection of rules based on property values)?
boolean	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	validate(ClipboardProperty aProp) Examine an instance of a ClipboardProperty and validate the contents against its definition (combined with the pxObjClass on its parent page).
boolean	validate(ClipboardProperty aProp, boolean aUseDictionary) examine an instance of a ClipboardProperty and validate the contents against its definition (combined with the pxObjClass on its parent page).
boolean	validate(ClipboardProperty aProp, boolean aUseDictionary, boolean aAvoidAutoChain) examine an instance of a ClipboardProperty and validate the contents against its definition (combined with the pxObjClass on its parent page).
boolean	validate(ClipboardProperty aProp, java.lang.String aValue, boolean aUseDictionary, boolean aAvoidAutoChain) Validate a property with a given value
java.lang.String	validate(java.lang.String aClassName, java.lang.String aPropertyName, java.lang.String aValue) Examine a string value and validate it against the named property's definition.
boolean	validateReference(java.lang.String aClassName, java.lang.String aReference) Takes a property reference and validates it against the specified class definition.
boolean	validateReferenceWithCaseSensitivity(java.lang.String aClassName, java.lang.String aReference) Takes a property reference and validates it against the specified class definition.
boolean	validateReferenceWithWildcards(java.lang.String aClassName, java.lang.String aReference) Takes a reference (that may contain wildcards) and validates it against the specified class.

Field Detail

VERSION

static final java.lang.String VERSION

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

TABLEEDITINFO_INDEX_ENTRYCODE

static final int TABLEEDITINFO_INDEX_ENTRYCODE

pzEntryCode

See Also:

Constant Field Values

TABLEEDITINFO_INDEX_TABLEOPTION

static final int TABLEEDITINFO_INDEX_TABLEOPTION

pyTableOption

See Also:

Constant Field Values

TABLEEDITINFO_INDEX_FIELDNAME

static final int TABLEEDITINFO_INDEX_FIELDNAME

pyFieldName

See Also:

Constant Field Values

TABLEEDITINFO_INDEX_FIELDCLASS

static final int TABLEEDITINFO_INDEX_FIELDCLASS

pyFieldClass

See Also:

Constant Field Values

TABLEEDITINFO_INDEX_TABLESELECTOR

static final int TABLEEDITINFO_INDEX_TABLESELECTOR

pyTableSelector

See Also:

Constant Field Values

TABLEEDITINFO_INDEX_USEFORLOCALIZATION

static final int TABLEEDITINFO_INDEX_USEFORLOCALIZATION

pyUseForLocalization

See Also:

Constant Field Values

TABLEEDITINFO_INDEX_TABLECLASS

static final int TABLEEDITINFO_INDEX_TABLECLASS

pyTableClass

See Also:

Constant Field Values

PROMPTLIST_INDEX_STANDARDVALUE

static final int PROMPTLIST_INDEX_STANDARDVALUE

Value field for Prompt List entries (pyStandardValue)

See Also:

Constant Field Values

PROMPTLIST_INDEX_LOCALIZEDVALUE

static final int PROMPTLIST_INDEX_LOCALIZEDVALUE

Localized value field for Prompt List entries (pyLocalizedValue)

See Also:

Constant Field Values

Method Detail

getImmutablePropertyInfo

ImmutablePropertyInfo getImmutablePropertyInfo(java.lang.String aClassName,
                                               java.lang.String aPropertyName)

Get the ImmutablePropertyInfo object for the named property.

Parameters:

aClassName - class containing the property

aPropertyName - the property to retrieve

The result for property reference is provided for the first property name from a reference i.e leading page names are ignored. Subscripts are stripped. Examples: "page.property" ==> "property", "property" ==> "property", ".property(3)" ==> "property"

Returns:

an ImmutablePropertyInfo object if the named property is present in aClassName, null if not

getClassInfo

ClassInfo getClassInfo(java.lang.String aClassName)

fetches the informational object for classes.

Parameters:

aClassName -

Returns:

ClassInfo for name

See Also:

ClassInfo

getPromptList

java.lang.String[][] getPromptList(java.lang.String aClassName,
                                   java.lang.String aPropertyName)

Gets the prompt list information for this property.

Parameters:

aPropertyName - the property to retrieve

aClassName - class containing the property

Returns:

array of prompt list values. The first index is the row (0 based). The second index is one of PROMPTLIST_INDEX_LOCALIZEDVALUE or PROMPTLIST_INDEX_STANDARDVALUE. Can be null if there is no prompt list defined for this property.

getLocalList

java.lang.String[] getLocalList(java.lang.String aClassName,
                                java.lang.String aPropertyName)

Gets the local list information for this property.

Parameters:

aPropertyName - the property to retrieve

aClassName - class containing the property

Returns:

array of local list values. Can be null if there is no local list defined for this property.

getTableEditInfo

java.lang.String[] getTableEditInfo(java.lang.String aClassName,
                                    java.lang.String aPropertyName)

Gets basic table edit information for this property. See getPromptList(String, String) to retrieve the prompt list values for a property.

Parameters:

aPropertyName - the property to retrieve

aClassName - class containing the property

Returns:

array of table edit information. Use these indexes to find the appropriate value: TABLEEDITINFO_INDEX_ENTRYCODE, TABLEEDITINFO_INDEX_FIELDCLASS, TABLEEDITINFO_INDEX_FIELDNAME, TABLEEDITINFO_INDEX_TABLECLASS, TABLEEDITINFO_INDEX_TABLEOPTION, TABLEEDITINFO_INDEX_TABLESELECTOR, TABLEEDITINFO_INDEX_USEFORLOCALIZATION. Individual values can be null if there's no such value in the property definition (although the array itself will never be null if the property is defined).

reset

void reset()

Clears the internal cache of classes and properties as looked up via rule resolution with the qualifiers that were in effect at that time. Call this method when it is known that the qualifiers for Rule Resolution have changed and definitions need to be looked up again. This supports the ability for code to make intelligent choices about local cache lifetimes.

fromDefinition

java.lang.String fromDefinition(ClipboardProperty aProperty,
                                java.lang.String aReference)

fetch the value of the named property from the Rule-Obj-Property instance for this property. The class of the property comes from the properties parent page. (so the parent page must have a pxObjClass)

Parameters:

aProperty - A ClipboardProperty which determines which Rule-Obj-Class (from the parent page of this property) and which Rule-Obj-Property instance we lookup aReference within.

aReference - A reference to a property on the Rule-Obj-Property page.

Returns:

The value of that property.

fromDefinition

java.lang.String fromDefinition(java.lang.String aClassName,
                                java.lang.String aPropertyName,
                                java.lang.String aReference)

fetch the value of the named property from the Rule-Obj-Property instance for the property that is defined by this class and property name.

Parameters:

aClassName - class in which to evaluate the property in aPropertyName

aPropertyName - name of the Rule-Obj-Property instance in class aClassName

aReference - a reference to a property in the Rule-Obj-Property

Returns:

the value of the property at aReference.

fromDefinition

java.lang.String 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.

Parameters:

aClassInstance - A ClipboardPage containing a class instance which determines which Rule-Obj-Class instance we lookup aReference within.

aReference - A reference to a property on the Rule-Obj-Class page.

Returns:

The value of the property at this aReference.

fromDefinition

java.lang.String fromDefinition(java.lang.String aClassName,
                                java.lang.String aReference)

fetch the value of the named property from the Rule-Obj-Class instance for the class in aClassName.

Parameters:

aClassName - class in which to evaluate the property in aPropertyName. which Rule-Obj-Class instance we lookup aReference within.

aReference - A reference to a property on the Rule-Obj-Class page.

Returns:

The value of the property at this aReference.

hasQualifier

boolean hasQualifier(ClipboardProperty aProperty,
                     java.lang.String aQualifierName)

Test for the existance of a qualifier for a particular property. Only design-time qualifiers are detected.

Parameters:

aProperty - ClipboardProperty instance for which the Qualifier is desired

aQualifierName - name of Qualifier that might appear in the Rule-Obj-Property instance.

Returns:

true if this named qualifier is defined for this property false otherwise

hasQualifier

boolean hasQualifier(java.lang.String aClassName,
                     java.lang.String aPropertyName,
                     java.lang.String aQualifierName)

Test for the existance of a qualifier for a particular property. Only design-time qualifiers are detected.

Parameters:

aClassName - class containing the property

aPropertyName - property that may contain qualifier

aQualifierName - name of Qualifier that might appear in the Rule-Obj-Property instance.

Returns:

true if this named qualifier is defined for this property false otherwise

hasRuntimeQualifier

boolean hasRuntimeQualifier(ClipboardProperty aProperty,
                            java.lang.String aQualifierName)

Test for the existance of a run-time qualifier definition for a particular property. This method only checks if a qualifier has been defined; it does not check if a qualifier value has been assigned to this property. Design-time qualifiers are not detected.

Parameters:

aProperty - ClipboardProperty instance for which the Qualifier is desired

aQualifierName - name of Qualifier that might appear in the Rule-Obj-Property instance.

Returns:

true if this named qualifier is defined for this property false otherwise

getQualifier

java.lang.String getQualifier(ClipboardProperty aProperty,
                              java.lang.String aQualifierName)

Returns the value of the named qualifier, if present, from the Rule-Obj-Property instance that defines this property. Only design-time qualifiers are visible with this method.

Parameters:

aProperty - ClipboardProperty instance for which the Qualifier value is desired

aQualifierName - name of Qualifier that might appear in the Rule-Obj-Property instance.

Returns:

value of the Qualifier, or an empty String if it is not included in this definition

Throws:

PRRuntimeException - if the qualifier is defined as a run-time qualifier

getQualifier

java.lang.String getQualifier(java.lang.String aClassName,
                              java.lang.String aPropertyName,
                              java.lang.String aQualifierName)

Returns the value of the named qualifier, if present, from the Rule-Obj-Property instance that defines this property. Only design-time qualifiers are visible with this method.

Parameters:

aClassName - class in which to evaluate the named property

aPropertyName - name of the property for which the Qualifier value is wanted.

aQualifierName - name of Qualifier that might appear in the Rule-Obj-Property instance.

Returns:

value of the Qualifier, or an empty String if it is not included in this definition

Throws:

PRRuntimeException - if the qualifier is defined as a run-time qualifier

getExpectedSize

java.lang.String getExpectedSize(java.lang.String aClassName,
                                 java.lang.String aPropertyName)

Get the Expected Size for a property (pyExpectedSize).

Parameters:

aClassName - class of the page containing the property

aPropertyName - name of the property (note that for a list or group element, the name of the list or group property should be provided)

Returns:

the value of pyExpectedSize for the Rule-Obj-Property resolved to by the input arguments and the current ruleset list context

getPropertyViaQualifier

ClipboardProperty getPropertyViaQualifier(ClipboardProperty aProperty,
                                          java.lang.String aQualifierName)

Retrieves the ClipboardProperty referred to by the value of the named qualifier. This is an indirection mechanism to allow one property to be 'related' to the value of another in its definiiton. An example is that a Decimal field containing an amount can have a reference to a related property that contains the currency code for that amount. The reference can only be the name of a property that is a sibling of the property. The reference may not refer to a different page or a different level in the current page's structure. The qualifier must be defined design-time.

Parameters:

aProperty - property contianing the qualifier

aQualifierName - name of the qualifier containing the refernce.

Returns:

the ClipboardProperty referred to if it exists, null if that property does not exist.

Throws:

PRRuntimeException - if the qualifier is defined as a run-time qualifier

setPropertyViaQualifier

boolean setPropertyViaQualifier(ClipboardProperty aProperty,
                                java.lang.String aQualifierName,
                                java.lang.String aValue)

Sets the ClipboardProperty referred to by the value of the named qualifier to the value provided. This is an indirection mechanism to allow one property to be 'related' to the value of another in its definiiton. An example is that a Decimal field containing an amount can have a reference to a related property that contains the currency code for that amount. The reference can only be the name of a property that is a sibling of the property. The reference may not refer to a different page or a different level in the current page's structure. The qualifier must defined as design-time.

Parameters:

aProperty - property contianing the qualifier

aQualifierName - name of the qualifier containing the refernce.

aValue - String value to place into the referred-to property

Returns:

true if the property was set false otherwise

Throws:

PRRuntimeException - if the qualifier is defined as a run-time qualifier

setPropertyViaQualifier

boolean setPropertyViaQualifier(ClipboardProperty aProperty,
                                java.lang.String aQualifierName,
                                ClipboardProperty aValue)

Sets the ClipboardProperty referred to by the value of the named qualifier to the value provided. This is an indirection mechanism to allow one property to be 'related' to the value of another in its definiiton. An example is that a Decimal field containing an amount can have a reference to a related property that contains the currency code for that amount. The reference can only be the name of a property that is a sibling of the property. The reference may not refer to a different page or a different level in the current page's structure. The qualifier must defined as design-time.

Parameters:

aProperty - property contianing the qualifier

aQualifierName - name of the qualifier containing the refernce.

aValue - ClipboardProperty copied over the referred-to property

Returns:

true if the property was set false otherwise

Throws:

PRRuntimeException - if the qualifier is defined as a run-time qualifier

validate

boolean 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). This includes validating the list of properties found AND the values for those properties which have defined constraints.

This cannot be called on a read-only page since messages are added to the page describing the errors found and the page status is updated. If a read only page is used the exception ReadOnlyException is thrown by ClipboardPage.addMessage(String).

Content of pages which is still embedded in a stream can be considered valid since it came from the database. This can be selected using the aForceExpand parameter.

Parameters:

aPage - - containing a page

aForceExpand - - should embedded pages be expanded from their streams? (lazy page evaluation)

Returns:

true if the page is well-formed with values that are within constraints, false otherwise. This also implies that error messages have been added to ClipboardPage 'aPage' indicating the specifics of the errors.

validate

boolean validate(ClipboardProperty aProp)

Examine an instance of a ClipboardProperty and validate the contents against its definition (combined with the pxObjClass on its parent page). Table and Java validation are applied as well. This cannot be called on a property embedded in a read-only page since messages are added to the page describing the errors found and the page status is updated. If a read-only page is used the exception ReadOnlyException is thrown by ClipboardPage.addMessage(String).

Parameters:

aProp - a property to validate

Returns:

true if the property is well-formed with values that are within constraints, false otherwise. This also implies that error messages have been added to ClipboardProperty 'aProp' indicating the specifics of the errors.

validate

java.lang.String validate(java.lang.String aClassName,
                          java.lang.String aPropertyName,
                          java.lang.String aValue)

Examine a string value and validate it against the named property's definition. Table and Java validation are applied as well.

Parameters:

aClassName - name of the class containing the the property aPropertyName

aPropertyName - name of property whose definition should be used (any subscripts are truncated)

aValue - value to be validated

Returns:

null if the value is valid or the class or property is undefined, the property is not a String, String Group, String List, Java Property, or Java Property List; otherwise a String containing the validation error messages.

validate

boolean validate(ClipboardProperty aProp,
                 boolean aUseDictionary)

examine an instance of a ClipboardProperty and validate the contents against its definition (combined with the pxObjClass on its parent page). This cannot be called on a property embedded in a read-only page since messages are added to the page describing the errors found and the page status is updated. If a read-only page is used the exception ReadOnlyException is thrown by ClipboardPage.addMessage(String).

Parameters:

aProp - a property to validate

aUseDictionary - true to use the dictionary definition of this property for validation. false to only use the attributes present within the property itself for validation. This option is useful to do cheap validation of a property that already has known attributes applied to it. Table and Java Edits are not applied in this scenario.

Returns:

true if the property is well-formed with values that are within constraints, false otherwise. This also implies that error messages have been added to ClipboardProperty 'aProp' indicating the specifics of the errors.

validate

boolean validate(ClipboardProperty aProp,
                 boolean aUseDictionary,
                 boolean aAvoidAutoChain)

examine an instance of a ClipboardProperty and validate the contents against its definition (combined with the pxObjClass on its parent page). This cannot be called on a property embedded in a read-only page since messages are added to the page describing the errors found and the page status is updated. If a read-only page is used the exception ReadOnlyException is thrown by ClipboardPage.addMessage(String).

Parameters:

aProp - a property to validate

aUseDictionary - true to use the dictionary definition of this property for validation. false to only use the attributes present within the property itself for validation. This option is useful to do cheap validation of a property that already has known attributes applied to it. Table and Java Edits are not applied in this scenario.

aAvoidAutoChain - aAvoidAutoChain flag to avoid auto chain

Returns:

true if the property is well-formed with values that are within constraints, false otherwise. This also implies that error messages have been added to ClipboardProperty 'aProp' indicating the specifics of the errors.

validate

boolean validate(ClipboardProperty aProp,
                 java.lang.String aValue,
                 boolean aUseDictionary,
                 boolean aAvoidAutoChain)

Validate a property with a given value

Parameters:

aProp - the property to validate

aValue - Optional String value of that property. If this is null, the value of the current property will be retrieved. If this is set, it is assumed that the property has already been set to this value. No additional get of the property will be performed.

aUseDictionary - true to use the dictionary definition of this property for validation. false to only use the attributes present within the property itself for validation. This option is useful to do cheap validation of a property that already has known attributes applied to it. Table and Java Edits are not applied in this scenario.

aAvoidAutoChain - aAvoidAutoChain flag to avoid auto chain

Returns:

true if the property is well-formed with values that are within constraints, false otherwise. This also implies that error messages have been added to ClipboardProperty 'aProp' indicating the specifics of the errors.

validateReference

boolean validateReference(java.lang.String aClassName,
                          java.lang.String aReference)

Takes a property reference and validates it against the specified class definition. If an embedded page does not have a defined class (eg, blank, $ANY, or $CLASS), all subsequent properties in the reference are assumed to be valid. This validation (like all validation by default) is NOT case sensitive. .pyLabel, .PYLABEL, and .pyLABel are all valid.

Parameters:

aClassName -

aReference -

Returns:

true if the reference is valid for this class, false otherwise.

validateReferenceWithCaseSensitivity

boolean validateReferenceWithCaseSensitivity(java.lang.String aClassName,
                                             java.lang.String aReference)

Takes a property reference and validates it against the specified class definition. If an embedded page does not have a defined class (eg, blank, $ANY, or $CLASS), all subsequent properties in the reference are assumed to be valid. This validation (unlike default validation) IS case sensitive. If the property is defined as .pyLabel, .PYLABEL and .pyLABel are not valid.

Parameters:

aClassName -

aReference -

Returns:

true if the reference is valid for this class, false otherwise.

validateReferenceWithWildcards

boolean validateReferenceWithWildcards(java.lang.String aClassName,
                                       java.lang.String aReference)

Takes a reference (that may contain wildcards) and validates it against the specified class.

Parameters:

aClassName - the name of the class

aReference - the reference--it may contain wildcards

Returns:

true if the reference is valid for this definition, false otherwise.

Throws:

InvalidReferenceException - if the reference is not valid

getTypeName

java.lang.String getTypeName(char aType)

Translates a Property Type code (like PropertyInfo.TYPE_TEXT) to its English string.

Parameters:

aType - type to be translated

Returns:

the string form of the type name

getModeName

java.lang.String getModeName(char aMode)

Translates a Property Mode code (like PropertyInfo.MODE_STRING) to its English string.

Parameters:

aMode - mode to be translated

Returns:

the string form of the mode name

getClassName

java.lang.String getClassName(java.lang.String aRootClass,
                              java.lang.String aReference)

Given a class and a page reference relative to that class, return the class of the referenced embedded page.

Parameters:

aRootClass - class to use as base for reference

aReference - reference to a page property relative to aRootClass

Returns:

name of the class of the referenced page property

getClassName

java.lang.String getClassName(java.lang.String aRootClass,
                              java.lang.String aReference,
                              boolean aAllowEmptySubscripts)

Given a class and a page reference relative to that class, return the class of the referenced embedded page.

Parameters:

aRootClass - class to use as base for reference

aReference - reference to a page property relative to aRootClass

aAllowEmptySubscripts - Allow empty subscripts in the reference

Returns:

name of the class of the referenced page property

getRuleSet

java.lang.String getRuleSet(java.lang.String aClassName,
                            java.lang.String aPropertyName)

Get the ruleset name that the requested property is actually defined on.

Parameters:

aPropertyName - the property to retrieve

aClassName - class containing the property

Returns:

the pyRuleSet of the Rule-Obj-Property resolved by a lookup with the given keys

getRuleSetVersion

java.lang.String getRuleSetVersion(java.lang.String aClassName,
                                   java.lang.String aPropertyName)

Get the ruleset version that the requested property is actually defined on.

Parameters:

aPropertyName - the property to retrieve

aClassName - class containing the property

Returns:

the pyRuleSetVersion of the Rule-Obj-Property resolved by a lookup with the given keys

getPropertyClass

java.lang.String getPropertyClass(java.lang.String aClassName,
                                  java.lang.String aPropertyName)

Get the class that the requested property is actually defined on. For example, calling getPropertyClass("PegaSample", "pyLabel") might return "Work-".

Parameters:

aPropertyName - the property to retrieve

aClassName - class containing the property

Returns:

the pyClassName of the Rule-Obj-Property resolved by a lookup with the given keys

getPropertyLabel

java.lang.String getPropertyLabel(java.lang.String aClassName,
                                  java.lang.String aPropertyName)

Get the label of the requested property.

Parameters:

aPropertyName - the property to retrieve

aClassName - class containing the property

Returns:

the pyLabel of the Rule-Obj-Property resolved by a lookup with the given keys

getJavaPropertyNames

java.util.Set getJavaPropertyNames(java.lang.String aClassName)

Return a list of all properties in the given class that are of mode Java Property or Java Property List. This can be useful when looking for a dump of values in an attached Java object.

Parameters:

aClassName - name of class to inspect

Returns:

Set of property names. null if there was no database access necessary to run the search.

isReference

boolean isReference(java.lang.String aClassName,
                    java.lang.String aPropertyName)

Is this property defined as a Reference property?

Parameters:

aClassName -

aPropertyName -

Returns:

boolean true if is a Reference Property

isRetrieveEachPageSeperately

boolean isRetrieveEachPageSeperately(java.lang.String aClassName,
                                     java.lang.String aPropertyName)

Is this property defined as RetrieveEachPageSeperately?

Parameters:

aClassName -

aPropertyName -

Returns:

boolean true if is a Reference Property

usesQualifiedRuleResolution

boolean usesQualifiedRuleResolution(java.lang.String aClassName)

Does this Rule-Obj-Class use circumstance qualified rule resolution (allows selection of rules based on property values)?

Parameters:

aClassName - Name of class

Returns:

boolean True if uses circumstances, false otherwise

getFormType

java.lang.String getFormType(java.lang.String aClassName)

Returns the value of pyFormType for this Rule-Obj-Class

Parameters:

aClassName - Name of class

Returns:

String Value of pyFormType, or empty string ("") if no value

getAppletHarness

java.lang.String getAppletHarness(java.lang.String aClassName)

Returns the value of pyAppletHarness for this Rule-Obj-Class

Parameters:

aClassName - Name of class

Returns:

String Value of pyAppletHarness, or empty string ("") if no value

getApplet

java.lang.String getApplet(java.lang.String aClassName)

Returns the value of pyApplet for this Rule-Obj-Class

Parameters:

aClassName - Name of class

Returns:

String Value of pyApplet, or empty string ("") if no value

getCategory

java.lang.String getCategory(java.lang.String aClassName)

Returns the value of pyCategory for this Rule-Obj-Class

Parameters:

aClassName - Name of class

Returns:

String Value of pyCategory, or empty string ("") if no value

getMethodStatus

java.lang.String getMethodStatus(java.lang.String aClassName)

Return the value of pyMethodStatus for this Rule-Obj-Class

Parameters:

aClassName - Name of class

Returns:

String Value of pyMethodStatus, or empty string ("") if no value

getGatewayClass

java.lang.String getGatewayClass(java.lang.String aClassName,
                                 java.lang.String aPropertyName)

Returns the gateway class for a Rule-Obj-Property

Parameters:

aClassName - Name of pyClassName

aPropertyName - Name of property

Returns:

String Value of pyGatewayClass, "" if none.

getGatewayPropertyMap

java.util.Map getGatewayPropertyMap(java.lang.String aClassName,
                                    java.lang.String aPropertyName)

Returns a map containing key value for source and target properties for a gateway property

Parameters:

aClassName - Name of pyClassName

aPropertyName - Name of property

Returns:

String Value of pyGatewayPropertyMap, "" if none.

isThereAnyLinkedPropertyInThisPropertyReference

boolean isThereAnyLinkedPropertyInThisPropertyReference(java.lang.String aClassName,
                                                        java.lang.String aPropRef)

shouldSkipLocalization

java.lang.String shouldSkipLocalization(java.lang.String aClassName,
                                        java.lang.String aPropertyName)

Is this property configured to skip localization. Localization can be a time consuming process. Many out of the box properties will not be displayed in UIs and therefore, attempting localization of those at runtime can be avoided. Each property has a pySkipLocalization which defaults to false, and can be set to true if desired. This method returns the value for pySkipLocalization.

Parameters:

aClassName - Name of the class

aPropertyName - Name of property

Returns:

true if localization can be skipped for this property, false otherwise.