com.pega.pegarules.pub.dictionary
Interface ImmutablePropertyInfo

All Known Subinterfaces:

PropertyInfo

public interface ImmutablePropertyInfo

ImmutablePropertyInfo 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: 14515 $ $Date: 2011-09-23 11:35:56 -0400 (Fri, 23 Sep 2011) $

Author:

clinb

Field Summary

static java.lang.String	COPYRIGHT
static char	MODE_JAVAOBJECT This property contains a Java Object.
static char	MODE_JAVAOBJECT_GROUP This property is a text-subscripted (unordered) group of Java objects accessed by a logical identifier in the subscript.
static char	MODE_JAVAOBJECT_LIST This property is a numeric-subscripted (ordered) list of embedded Java objects.
static char	MODE_JAVAPROPERTY This property contains a Java Property.
static char	MODE_JAVAPROPERTY_LIST This property contains a Java Property List.
static char	MODE_PAGE This property is a single page that contains properties.
static char	MODE_PAGE_GROUP This property is a text-subscripted (unordered) group of pages accessed by a logical identifier in the subscript.
static char	MODE_PAGE_LIST This property is a numeric-subscripted (ordered) list of embedded pages.
static char	MODE_STRING This property identifies a scalar data node, whose value is a string.
static char	MODE_STRING_GROUP This property is a text-subscripted (unordered) group of scalar values accessed by a logical identifier in the subscript.
static char	MODE_STRING_LIST This property is a numeric-subscripted (ordered) list of scalar values.
static char	MODE_UNKNOWN This property is not defined.
static char	MODE_UNKNOWN_GROUP This property is a text-subscripted (unordered) list of unknown properties-- once a String or Page property is added to this group, the group will change to the appropriate mode.
static char	MODE_UNKNOWN_LIST This property is a numeric-subscripted (ordered) list of unknown properties-- once a String or Page property is added to this list, the list will change to the appropriate mode.
static char	MODE_UNRESOLVED This is used during validation to indicate a property that has no errors per se, but there was not enough information available to assign it any other more specific MODE_
static char	TYPE_AMOUNT This scalar (string) value specifies a 'measurement' that consists of an optionally-signed number (that may include fractional digits) combined with the named units of the measurement (such as 'days', 'dollars', or 'widgets').
static char	TYPE_DATE This scalar (string) value names a calendar date, typically independent of timezone.
static char	TYPE_DATETIME This scalar (string) value specifies a moment in time.
static char	TYPE_DECIMAL This scalar (string) value specifies an optionally-signed number that may include fractional digits.
static char	TYPE_DISTINCT_PAGE A special type that corresponds to a special embedded page, whose status is isolated from that of the page containing it.
static char	TYPE_DOUBLE This scalar (string) value specifies a double-precision float value.
static char	TYPE_FREEFORM This property is on a classless page, and is presumed to have an unconstrained scalar (string) value.
static char	TYPE_IDENTIFIER This scalar (string) value might participate in naming other objects.
static char	TYPE_IDSTRING This scalar (string) value might participate in naming other objects.
static char	TYPE_INCLUDED_PAGE A special type that corresponds to an embedded page that affects the status of the page containing it.
static char	TYPE_INTEGER This scalar (string) value specifies an optionally-signed whole-number.
static char	TYPE_JAVABEAN A special type that corresponds to a special embedded page, whose status is isolated from that of the page containing it.
static char	TYPE_JAVAOBJECT A special type that corresponds to a Java Object.
static char	TYPE_JAVAPROPERTY A special type that corresponds to a Java Property.
static char	TYPE_NUMBER This scalar (string) value specifies an optionally-signed whole-number.
static char	TYPE_PASSWORD This scalar (string) value should never be displayed.
static char	TYPE_TEXT This scalar (string) value is intended primarily for human viewing.
static char	TYPE_TEXTENCRYPTED This scalar (string) value specifies a value that is encrypted text and is conditionally decrypted when displayed
static char	TYPE_TIMEOFDAY This scalar (string) value names a time of day, typically independent of timezone.
static char	TYPE_TOPLEVEL_PAGE A special type that corresponds to a top-level page that is not embedded in any other page.
static char	TYPE_TRUEFALSE This boolean value can specify the selection or exclusion of a single option.
static char	TYPE_UNKNOWN This property is not bound, or its semantics could not be determined.
static char	TYPE_YESORNO Deprecated. Use TYPE_TRUEFALSE instead.
static java.lang.String	VERSION

Method Summary

java.lang.String	getEmbeddedPageClass() returns the detail string, which for MODE_PAGE* properties contains the class of the embedded page.
java.lang.String	getEntryCode() The EntryCode contains all of the dictionary-related definition information for this property in an encoded form.
java.lang.String	getJavaObjectClass() returns the detail string, which for MODE_JAVAOBJECT* properties contains the class of the Java object.
java.lang.String	getLocalizedText(ClipboardProperty aProp) Returns the localized value of a property
java.lang.String	getLocalizedText(ClipboardProperty aProp, java.lang.String aString) Returns the localized value of aString, using the localization info from aProp
int	getMaxLength()
char	getMode()
java.lang.String	getStandardText(ClipboardProperty aProp, java.lang.String aKey) Returns the standard value of a property
char	getType()
boolean	hasAccessSpecial()
boolean	hasAccessStandard()
boolean	hasEditDefined()
boolean	hasTableEdit()
boolean	hasTypeAmount()
boolean	hasTypeDate() contains a date.
boolean	hasTypeDateTime() contains a datetime type.
boolean	hasTypeDecimal()
boolean	hasTypeDistinctPage()
boolean	hasTypeDouble()
boolean	hasTypeFreeform() has freeform (String) type.
boolean	hasTypeIdentifier() contains a valid identifier.
boolean	hasTypeIncludedPage()
boolean	hasTypeInteger() contains an integer number type.
boolean	hasTypeNumber() Deprecated. Use hasTypeInteger() instead
boolean	hasTypePassword() has an encrypted value.
boolean	hasTypeText() contains Text.
boolean	hasTypeTextEncrypted() has a site specific cipher encrypted text value.
boolean	hasTypeTimeOfDay() contains a time-of-day.
boolean	hasTypeTopLevelPage()
boolean	hasTypeTrueFalse() contains 'T', 'F', 'true', 'false'.
boolean	hasTypeUnknown() has not yet been fully decipherd.
boolean	hasTypeYesOrNo() Deprecated: use properties with TYPE_TRUEFALSE instead.
boolean	isModeGroup()
boolean	isModeJavaObject()
boolean	isModeList()
boolean	isModePage() contains an embedded page.
boolean	isModePageGroup() has an embedded list of named pages.
boolean	isModePageList() has an embedded list of subscripted pages.
boolean	isModeString()
boolean	isModeStringGroup() has an embedded list of named strings.
boolean	isModeStringList() has an embedded list of subscripted strings.
boolean	isModeUnknown() has the mode not been fully resolved
boolean	validate(ClipboardProperty aProperty, boolean aForceExpand) reports the validity of the data in this property.

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

MODE_UNKNOWN

static final char MODE_UNKNOWN

This property is not defined.

See Also:

Constant Field Values

MODE_STRING

static final char MODE_STRING

This property identifies a scalar data node, whose value is a string.

See Also:

Constant Field Values

MODE_STRING_LIST

static final char MODE_STRING_LIST

This property is a numeric-subscripted (ordered) list of scalar values.

See Also:

Constant Field Values

MODE_STRING_GROUP

static final char MODE_STRING_GROUP

This property is a text-subscripted (unordered) group of scalar values accessed by a logical identifier in the subscript.

See Also:

Constant Field Values

MODE_PAGE

static final char MODE_PAGE

This property is a single page that contains properties.

See Also:

Constant Field Values

MODE_PAGE_LIST

static final char MODE_PAGE_LIST

This property is a numeric-subscripted (ordered) list of embedded pages.

See Also:

Constant Field Values

MODE_UNKNOWN_LIST

static final char MODE_UNKNOWN_LIST

This property is a numeric-subscripted (ordered) list of unknown properties-- once a String or Page property is added to this list, the list will change to the appropriate mode.

See Also:

Constant Field Values

MODE_UNKNOWN_GROUP

static final char MODE_UNKNOWN_GROUP

This property is a text-subscripted (unordered) list of unknown properties-- once a String or Page property is added to this group, the group will change to the appropriate mode.

See Also:

Constant Field Values

MODE_PAGE_GROUP

static final char MODE_PAGE_GROUP

This property is a text-subscripted (unordered) group of pages accessed by a logical identifier in the subscript.

See Also:

Constant Field Values

MODE_JAVAOBJECT

static final char MODE_JAVAOBJECT

This property contains a Java Object. See the property TYPE for more info.

See Also:

Constant Field Values

MODE_JAVAOBJECT_LIST

static final char MODE_JAVAOBJECT_LIST

This property is a numeric-subscripted (ordered) list of embedded Java objects.

See Also:

Constant Field Values

MODE_JAVAOBJECT_GROUP

static final char MODE_JAVAOBJECT_GROUP

This property is a text-subscripted (unordered) group of Java objects accessed by a logical identifier in the subscript.

See Also:

Constant Field Values

MODE_JAVAPROPERTY

static final char MODE_JAVAPROPERTY

This property contains a Java Property.

See Also:

Constant Field Values

MODE_JAVAPROPERTY_LIST

static final char MODE_JAVAPROPERTY_LIST

This property contains a Java Property List.

See Also:

Constant Field Values

MODE_UNRESOLVED

static final char MODE_UNRESOLVED

This is used during validation to indicate a property that has no errors per se, but there was not enough information available to assign it any other more specific MODE_

See Also:

Constant Field Values

TYPE_UNKNOWN

static final char TYPE_UNKNOWN

This property is not bound, or its semantics could not be determined.

See Also:

Constant Field Values

TYPE_FREEFORM

static final char TYPE_FREEFORM

This property is on a classless page, and is presumed to have an unconstrained scalar (string) value.

See Also:

Constant Field Values

TYPE_TEXT

static final char TYPE_TEXT

This scalar (string) value is intended primarily for human viewing.

See Also:

Constant Field Values

TYPE_IDENTIFIER

static final char TYPE_IDENTIFIER

This scalar (string) value might participate in naming other objects. Typically key-like data with a liberal character set for values. (allows white space)

See Also:

Constant Field Values

TYPE_IDSTRING

static final char TYPE_IDSTRING

This scalar (string) value might participate in naming other objects. Typically key-like data with a restricted character set for values. (unicodeIdentifiers plus @_-.)

See Also:

Constant Field Values

TYPE_PASSWORD

static final char TYPE_PASSWORD

This scalar (string) value should never be displayed. Encrypted.

See Also:

Constant Field Values

TYPE_DATETIME

static final char TYPE_DATETIME

This scalar (string) value specifies a moment in time. Uses modified ISO 8601 format using the GMT time zone.

See Also:

Constant Field Values

TYPE_DATE

static final char TYPE_DATE

This scalar (string) value names a calendar date, typically independent of timezone. Formatted as yyyymmdd.

See Also:

Constant Field Values

TYPE_TIMEOFDAY

static final char TYPE_TIMEOFDAY

This scalar (string) value names a time of day, typically independent of timezone. Formatted as hhmm[ss[.sss]][ z] using a 24-hour clock. The seconds, fractional seconds, and time-zone indicator are optional.

See Also:

Constant Field Values

TYPE_TRUEFALSE

static final char TYPE_TRUEFALSE

This boolean value can specify the selection or exclusion of a single option. It is stored as true or false. Input values "Y", "1", or "-1" are also interpreted as true, while the values "N" and "0" are also interpreted as false.

See Also:

Constant Field Values

TYPE_YESORNO

static final char TYPE_YESORNO

Deprecated. Use TYPE_TRUEFALSE instead.

See Also:

Constant Field Values

TYPE_NUMBER

static final char TYPE_NUMBER

This scalar (string) value specifies an optionally-signed whole-number. No decimal point or punctuation allowed.

See Also:

Constant Field Values

TYPE_INTEGER

static final char TYPE_INTEGER

This scalar (string) value specifies an optionally-signed whole-number. No decimal point or punctuation allowed.

See Also:

Constant Field Values

TYPE_DECIMAL

static final char TYPE_DECIMAL

This scalar (string) value specifies an optionally-signed number that may include fractional digits. Includes a decimal point and no other punctuation.

See Also:

Constant Field Values

TYPE_DOUBLE

static final char TYPE_DOUBLE

This scalar (string) value specifies a double-precision float value.

See Also:

Constant Field Values

TYPE_AMOUNT

static final char TYPE_AMOUNT

This scalar (string) value specifies a 'measurement' that consists of an optionally-signed number (that may include fractional digits) combined with the named units of the measurement (such as 'days', 'dollars', or 'widgets'). The optional units name must be a valid identifier (with the same constraints as a property name), and if present, is separated from the measurement by a colon.

See Also:

Constant Field Values

TYPE_TEXTENCRYPTED

static final char TYPE_TEXTENCRYPTED

This scalar (string) value specifies a value that is encrypted text and is conditionally decrypted when displayed

See Also:

Constant Field Values

TYPE_TOPLEVEL_PAGE

static final char TYPE_TOPLEVEL_PAGE

A special type that corresponds to a top-level page that is not embedded in any other page.

See Also:

Constant Field Values

TYPE_INCLUDED_PAGE

static final char TYPE_INCLUDED_PAGE

A special type that corresponds to an embedded page that affects the status of the page containing it.

See Also:

Constant Field Values

TYPE_DISTINCT_PAGE

static final char TYPE_DISTINCT_PAGE

A special type that corresponds to a special embedded page, whose status is isolated from that of the page containing it.

See Also:

Constant Field Values

TYPE_JAVAOBJECT

static final char TYPE_JAVAOBJECT

A special type that corresponds to a Java Object.

See Also:

Constant Field Values

TYPE_JAVAPROPERTY

static final char TYPE_JAVAPROPERTY

A special type that corresponds to a Java Property.

See Also:

Constant Field Values

TYPE_JAVABEAN

static final char TYPE_JAVABEAN

A special type that corresponds to a special embedded page, whose status is isolated from that of the page containing it.

See Also:

Constant Field Values

Method Detail

getMode

char getMode()

Returns:

The Mode value for this property.

getType

char getType()

Returns:

The Type of this property.

getMaxLength

int getMaxLength()

Returns:

The Length characteristic of this property.

getEmbeddedPageClass

java.lang.String getEmbeddedPageClass()

returns the detail string, which for MODE_PAGE* properties contains the class of the embedded page.

Returns:

The embedded page's class for this property.

getJavaObjectClass

java.lang.String getJavaObjectClass()

returns the detail string, which for MODE_JAVAOBJECT* properties contains the class of the Java object.

Returns:

The Java object's class for this property.

hasEditDefined

boolean hasEditDefined()

Returns:

true if this property is defined to have an Input Edit, false otherwise

isModeString

boolean isModeString()

Returns:

true if this is a scalar string property false otherwise

isModeJavaObject

boolean isModeJavaObject()

Returns:

true if this is a Java Object property false otherwise

isModeStringList

boolean isModeStringList()

has an embedded list of subscripted strings.

Returns:

true if this is a string list property false otherwise

isModeStringGroup

boolean isModeStringGroup()

has an embedded list of named strings.

Returns:

true if this is a string group property false otherwise

isModePage

boolean isModePage()

contains an embedded page.

Returns:

true if this is a Page property false otherwise

isModeGroup

boolean isModeGroup()

Returns:

true if this is any type of Group property false otherwise

isModeList

boolean isModeList()

Returns:

true if this is any type of List property false otherwise

isModeUnknown

boolean isModeUnknown()

has the mode not been fully resolved

Returns:

true if the mode has UNKNOWN / UNRESOLVED in it false otherwise

isModePageList

boolean isModePageList()

has an embedded list of subscripted pages.

Returns:

true if this is a Page List property false otherwise

isModePageGroup

boolean isModePageGroup()

has an embedded list of named pages.

Returns:

true if this is a Page Group property false otherwise

hasTypeUnknown

boolean hasTypeUnknown()

has not yet been fully decipherd.

Returns:

true if this has an Unknown Type false otherwise

hasTypeFreeform

boolean hasTypeFreeform()

has freeform (String) type.

Returns:

true if this has a Freeform Type false otherwise

hasTypeText

boolean hasTypeText()

contains Text.

Returns:

true if this has a Text Type false otherwise

hasTypeIdentifier

boolean hasTypeIdentifier()

contains a valid identifier.

Returns:

true if this has an Identifier Type false otherwise

hasTypePassword

boolean hasTypePassword()

has an encrypted value.

Returns:

true if this has a Password Type false otherwise

hasTypeTextEncrypted

boolean hasTypeTextEncrypted()

has a site specific cipher encrypted text value.

Returns:

true if this has a TextEncrypted Type false otherwise

hasTypeDateTime

boolean hasTypeDateTime()

contains a datetime type.

Returns:

true if this has a DateTime Type false otherwise

hasTypeDate

boolean hasTypeDate()

contains a date.

Returns:

true if this has a Date Type false otherwise

hasTypeTimeOfDay

boolean hasTypeTimeOfDay()

contains a time-of-day.

Returns:

true if this has a Time-Of-Day Type false otherwise

hasTypeTrueFalse

boolean hasTypeTrueFalse()

contains 'T', 'F', 'true', 'false'.

Returns:

true if this has a True-False Type false otherwise

hasTypeYesOrNo

boolean hasTypeYesOrNo()

Deprecated: use properties with TYPE_TRUEFALSE instead.

Returns:

true if this has a Yes-No Type false otherwise

hasTypeNumber

boolean hasTypeNumber()

Deprecated. Use hasTypeInteger() instead

contains an integer number type.

Returns:

true if this has a Number Type false otherwise

hasTypeInteger

boolean hasTypeInteger()

contains an integer number type.

Returns:

true if this has a Integer Type false otherwise

hasTypeDecimal

boolean hasTypeDecimal()

Returns:

true if this has a Decimal Type false otherwise

hasTypeDouble

boolean hasTypeDouble()

Returns:

true if this has a Double Type false otherwise

hasTypeAmount

boolean hasTypeAmount()

Returns:

true if this has a Amount Type false otherwise

hasTypeTopLevelPage

boolean hasTypeTopLevelPage()

Returns:

true if this is a Top-Level Page Type false otherwise

hasTypeIncludedPage

boolean hasTypeIncludedPage()

Returns:

true if this is a Included Page Type false otherwise

hasTypeDistinctPage

boolean hasTypeDistinctPage()

Returns:

true if this is a Distinct Page Type false otherwise

hasAccessStandard

boolean hasAccessStandard()

Returns:

true if this has standard access. false otherwise

hasAccessSpecial

boolean hasAccessSpecial()

Returns:

true if this has standard access. false otherwise

hasTableEdit

boolean hasTableEdit()

Returns:

true if this has a table edit defined. false otherwise

getEntryCode

java.lang.String getEntryCode()

The EntryCode contains all of the dictionary-related definition information for this property in an encoded form. It is strongly recommeded that the value of the entry code be treated as an opaque value and the methods of this class to access a properties definition be used instead. The content and format of the entrycode is subject to change without notice or apology! This method is public only to allow our stream generation facilities to access this value as a handle for performance resons. Use at your own risk.

Returns:

The EntryCode for this property.

validate

boolean validate(ClipboardProperty aProperty,
                 boolean aForceExpand)

reports the validity of the data in this property. Properties are evaluated against the definitions present in the Rule-Obj-Property class for this property. Note that properties on pages read in from the database are in an internal stream format until each property is accessed. At that time the property is reconstituted from its' stream. This process is called 'lazy property evaluation' and is a performance feature of the system. To enhance performance of your processing you can choose to validate only the properties on a page that have been touched since read in. The aForceExpand option allows you to select this behavior. This practice can be considered safe as long as your processing only commits instances of the class being validated to the database when they are considered valid.

Parameters:

aProperty - property to validate

aForceExpand - true if you want every property on the page expanded as part of the process of validation (expensive) false to leave unexpanded pages alone and assume that they contain valid data.

Returns:

true if the proposed property is valid false otherwise

getLocalizedText

java.lang.String getLocalizedText(ClipboardProperty aProp)

Returns the localized value of a property

Parameters:

aProp - ClipboardProperty

Returns:

String localized value

getLocalizedText

java.lang.String getLocalizedText(ClipboardProperty aProp,
                                  java.lang.String aString)

Returns the localized value of aString, using the localization info from aProp

Parameters:

aProp - the property to use

aString - the string to localize

Returns:

the localized version of aString

getStandardText

java.lang.String getStandardText(ClipboardProperty aProp,
                                 java.lang.String aKey)

Returns the standard value of a property

Parameters:

aProp - ClipboardProperty

aKey - String

Returns:

String standard value