com.pega.pegarules.pub.dictionary
Interface PropertyInfo

All Superinterfaces:

ImmutablePropertyInfo

public interface PropertyInfo
extends ImmutablePropertyInfo

PropertyInfo is used as the container for the definition of a particular property within a particular class as defined in the data dictionary. Methods exposed here allow you to create these Objects and interrogate them to discover the characteristics of classes defined within the system Data Dictionary. The methods used to determine what this property 'IS' are contained in the inherited PropertyCharacteristics methods. @see #PropertyCharacteristics for the specifics.

Version:

$Revision: 31 $ $Date: 2009-06-24 09:38:04 -0400 (Wed, 24 Jun 2009) $

Author:

clinb

Field Summary

static java.lang.String	COPYRIGHT
static java.lang.String	VERSION

Fields inherited from interface com.pega.pegarules.pub.dictionary.ImmutablePropertyInfo

MODE_JAVAOBJECT, MODE_JAVAOBJECT_GROUP, MODE_JAVAOBJECT_LIST, MODE_JAVAPROPERTY, MODE_JAVAPROPERTY_LIST, MODE_PAGE, MODE_PAGE_GROUP, MODE_PAGE_LIST, MODE_STRING, MODE_STRING_GROUP, MODE_STRING_LIST, MODE_UNKNOWN, MODE_UNKNOWN_GROUP, MODE_UNKNOWN_LIST, MODE_UNRESOLVED, TYPE_AMOUNT, TYPE_DATE, TYPE_DATETIME, TYPE_DECIMAL, TYPE_DISTINCT_PAGE, TYPE_DOUBLE, TYPE_FREEFORM, TYPE_IDENTIFIER, TYPE_IDSTRING, TYPE_INCLUDED_PAGE, TYPE_INTEGER, TYPE_JAVABEAN, TYPE_JAVAOBJECT, TYPE_JAVAPROPERTY, TYPE_NUMBER, TYPE_PASSWORD, TYPE_TEXT, TYPE_TEXTENCRYPTED, TYPE_TIMEOFDAY, TYPE_TOPLEVEL_PAGE, TYPE_TRUEFALSE, TYPE_UNKNOWN, TYPE_YESORNO

Method Summary

java.lang.String	fromDefinition(java.lang.String aReference) fetches the value of the named property from the Rule-Obj-Property instance defined for the class that this PropertyInfo instance belongs to.
java.lang.String	getName()
ClassInfo	getOwner() returns the ClassInfo of the object that contains this PropertyInfo.
java.lang.String	getQualifier(java.lang.String aQualifierName) Returns the value of the named qualifier, if present, from the Rule-Obj-Property instance defined for the class that this PropertyInfo instance belongs to.
boolean	hasAccessReserved()
boolean	hasQualifier(java.lang.String aQualifierName) Reports on the existance of named qualifier.

Methods inherited from interface com.pega.pegarules.pub.dictionary.ImmutablePropertyInfo

getEmbeddedPageClass, getEntryCode, getJavaObjectClass, getLocalizedText, getLocalizedText, getMaxLength, getMode, getStandardText, getType, hasAccessSpecial, hasAccessStandard, hasEditDefined, hasTableEdit, hasTypeAmount, hasTypeDate, hasTypeDateTime, hasTypeDecimal, hasTypeDistinctPage, hasTypeDouble, hasTypeFreeform, hasTypeIdentifier, hasTypeIncludedPage, hasTypeInteger, hasTypeNumber, hasTypePassword, hasTypeText, hasTypeTextEncrypted, hasTypeTimeOfDay, hasTypeTopLevelPage, hasTypeTrueFalse, hasTypeUnknown, hasTypeYesOrNo, isModeGroup, isModeJavaObject, isModeList, isModePage, isModePageGroup, isModePageList, isModeString, isModeStringGroup, isModeStringList, isModeUnknown, validate

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

static final java.lang.String VERSION

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Returns:

The Name of this property.

hasAccessReserved

boolean hasAccessReserved()

Returns:

true if this has standard access. false otherwise

getOwner

ClassInfo getOwner()

returns the ClassInfo of the object that contains this PropertyInfo.

Returns:

ClassInfo of the container.

fromDefinition

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

fetches the value of the named property from the Rule-Obj-Property instance defined for the class that this PropertyInfo instance belongs to.

Parameters:

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

Returns:

value of that property.

getQualifier

java.lang.String getQualifier(java.lang.String aQualifierName)

Returns the value of the named qualifier, if present, from the Rule-Obj-Property instance defined for the class that this PropertyInfo instance belongs to. Run-time qualifier values cannot be retrieved with this method.

Parameters:

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

hasQualifier

boolean hasQualifier(java.lang.String aQualifierName)

Reports on the existance of named qualifier. Run-time qualifiers are not detected by this method.

Parameters:

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

Returns:

true if the parameter is a defined qualifier for this property false otherwise