public interface ImmutablePropertyInfo
Modifier and Type | Field and Description |
---|---|
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 |
Modifier and Type | Method and Description |
---|---|
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.
|
static final java.lang.String VERSION
static final java.lang.String COPYRIGHT
static final char MODE_UNKNOWN
static final char MODE_STRING
static final char MODE_STRING_LIST
static final char MODE_STRING_GROUP
static final char MODE_PAGE
static final char MODE_PAGE_LIST
static final char MODE_UNKNOWN_LIST
static final char MODE_UNKNOWN_GROUP
static final char MODE_PAGE_GROUP
static final char MODE_JAVAOBJECT
static final char MODE_JAVAOBJECT_LIST
static final char MODE_JAVAOBJECT_GROUP
static final char MODE_JAVAPROPERTY
static final char MODE_JAVAPROPERTY_LIST
static final char MODE_UNRESOLVED
static final char TYPE_UNKNOWN
static final char TYPE_FREEFORM
static final char TYPE_TEXT
static final char TYPE_IDENTIFIER
static final char TYPE_IDSTRING
static final char TYPE_PASSWORD
static final char TYPE_DATETIME
static final char TYPE_DATE
static final char TYPE_TIMEOFDAY
static final char TYPE_TRUEFALSE
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
.static final char TYPE_YESORNO
TYPE_TRUEFALSE
instead.static final char TYPE_NUMBER
static final char TYPE_INTEGER
static final char TYPE_DECIMAL
static final char TYPE_DOUBLE
static final char TYPE_AMOUNT
static final char TYPE_TEXTENCRYPTED
static final char TYPE_TOPLEVEL_PAGE
static final char TYPE_INCLUDED_PAGE
static final char TYPE_DISTINCT_PAGE
static final char TYPE_JAVAOBJECT
static final char TYPE_JAVAPROPERTY
static final char TYPE_JAVABEAN
char getMode()
char getType()
int getMaxLength()
java.lang.String getEmbeddedPageClass()
java.lang.String getJavaObjectClass()
boolean hasEditDefined()
true
if this property is defined to have an Input Edit,
false
otherwiseboolean isModeString()
true
if this is a scalar string property
false
otherwiseboolean isModeJavaObject()
true
if this is a Java Object property
false
otherwiseboolean isModeStringList()
true
if this is a string list property
false
otherwiseboolean isModeStringGroup()
true
if this is a string group property
false
otherwiseboolean isModePage()
true
if this is a Page property
false
otherwiseboolean isModeGroup()
true
if this is any type of Group property
false
otherwiseboolean isModeList()
true
if this is any type of List property
false
otherwiseboolean isModeUnknown()
true
if the mode has UNKNOWN / UNRESOLVED in it
false
otherwiseboolean isModePageList()
true
if this is a Page List property
false
otherwiseboolean isModePageGroup()
true
if this is a Page Group property
false
otherwiseboolean hasTypeUnknown()
true
if this has an Unknown Type
false
otherwiseboolean hasTypeFreeform()
true
if this has a Freeform Type
false
otherwiseboolean hasTypeText()
true
if this has a Text Type
false
otherwiseboolean hasTypeIdentifier()
true
if this has an Identifier Type
false
otherwiseboolean hasTypePassword()
true
if this has a Password Type
false
otherwiseboolean hasTypeTextEncrypted()
true
if this has a TextEncrypted Type
false
otherwiseboolean hasTypeDateTime()
true
if this has a DateTime Type
false
otherwiseboolean hasTypeDate()
true
if this has a Date Type
false
otherwiseboolean hasTypeTimeOfDay()
true
if this has a Time-Of-Day Type
false
otherwiseboolean hasTypeTrueFalse()
true
if this has a True-False Type
false
otherwiseboolean hasTypeYesOrNo()
TYPE_TRUEFALSE
instead.true
if this has a Yes-No Type
false
otherwiseboolean hasTypeNumber()
true
if this has a Number Type
false
otherwiseboolean hasTypeInteger()
true
if this has a Integer Type
false
otherwiseboolean hasTypeDecimal()
true
if this has a Decimal Type
false
otherwiseboolean hasTypeDouble()
true
if this has a Double Type
false
otherwiseboolean hasTypeAmount()
true
if this has a Amount Type
false
otherwiseboolean hasTypeTopLevelPage()
true
if this is a Top-Level Page Type
false
otherwiseboolean hasTypeIncludedPage()
true
if this is a Included Page Type
false
otherwiseboolean hasTypeDistinctPage()
true
if this is a Distinct Page Type
false
otherwiseboolean hasAccessStandard()
true
if this has standard access.
false
otherwiseboolean hasAccessSpecial()
true
if this has standard access.
false
otherwiseboolean hasTableEdit()
true
if this has a table edit defined.
false
otherwisejava.lang.String getEntryCode()
boolean validate(ClipboardProperty aProperty, boolean aForceExpand)
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.aProperty
- property to validateaForceExpand
- 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.true
if the proposed property is valid
false
otherwisejava.lang.String getLocalizedText(ClipboardProperty aProp)
aProp
- ClipboardPropertyjava.lang.String getLocalizedText(ClipboardProperty aProp, java.lang.String aString)
aProp
- the property to useaString
- the string to localizejava.lang.String getStandardText(ClipboardProperty aProp, java.lang.String aKey)
aProp
- ClipboardPropertyaKey
- StringCopyright © 2015 Pegasystems Inc. All Rights Reserved.