ImmutablePropertyAliasInfo (PegaRULES Java Engine v07.10)

```
public interface ImmutablePropertyAliasInfo
```
ImmutableAliasPropertyInfo is used as the container for the definition of a particular property alias within a particular class as defined in the data dictionary. Methods exposed here allow you to interrogate these definitions to discover the characteristics of classes defined within the system Data Dictionary.

Version:

$Revision: 69724 $ $Date: 2013-09-24 15:19:02 -0400 (Tue, 24 Sep 2013) $

Author:

MiraT

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT

static java.lang.String VERSION

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT`
`static java.lang.String`	`VERSION`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`comparator()` Get the sort function specified in this Alias instance.
`java.lang.String`	`getClassName()` Get the class name (pyClassName) of this Alias instance.
`java.lang.String`	`getEntryCode()` The EntryCode contains all of the dictionary-related definition information for this property in an encoded form.
`java.lang.String`	`getName()` Get the name (pyPropertyName) of this Alias instance.
`ClipboardProperty`	`getPropertyReferences()` Return a page list of Embed-ChangeDesignation pages that describe the properties that are referenced in this alias.
`java.lang.String`	`getReference()` Get the property reference (if this is a non-expression alias);
`java.lang.String`	`getStreamName()` Get the HTML property definition specified in this Alias instance.
`char`	`getType()`
`boolean`	`hasTypeAmount()`
`boolean`	`hasTypeDate()` contains a date.
`boolean`	`hasTypeDateTime()` contains a datetime type.
`boolean`	`hasTypeDecimal()`
`boolean`	`hasTypeDouble()`
`boolean`	`hasTypeFreeform()` has freeform (String) type.
`boolean`	`hasTypeIdentifier()` contains a valid identifier.
`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 an site specific cipher encrypted text value.
`boolean`	`hasTypeTimeOfDay()` contains a time-of-day.
`boolean`	`hasTypeTrueFalse()` contains 'T', 'F', 'true', 'false'.
`boolean`	`hasTypeUnknown()` has not yet been fully decipherd.
`boolean`	`hasTypeYesOrNo()` Deprecated: use properties with `ImmutablePropertyInfo.TYPE_TRUEFALSE` instead.
`boolean`	`usesExpression()` Does this Rule-Obj-Property-Alias instance use an expression, or is it a literal property reference?

- Field Detail
  - VERSION
```
static final java.lang.String VERSION
```
  - COPYRIGHT
```
static final java.lang.String COPYRIGHT
```
    See Also:
    Constant Field Values
- Method Detail
  - getType
```
char getType()
```
    Returns:
    The Type of this property.
  - 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 an site specific cipher encrypted text value.
    
    Returns:
    true if this has an Encrypt 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 ImmutablePropertyInfo.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
  - getPropertyReferences
```
ClipboardProperty getPropertyReferences()
```
    Return a page list of Embed-ChangeDesignation pages that describe the properties that are referenced in this alias.
    
    Returns:
    ClipboardProperty A page list of Embed-ChangeDesignation pages.
  - 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.
  - usesExpression
```
boolean usesExpression()
```
    Does this Rule-Obj-Property-Alias instance use an expression, or is it a literal property reference?
    
    Returns:
    boolean Is this Alias an expression or literal reference?
  - getReference
```
java.lang.String getReference()
```
    Get the property reference (if this is a non-expression alias);
    
    Returns:
    String The property reference
  - getName
```
java.lang.String getName()
```
    Get the name (pyPropertyName) of this Alias instance.
    
    Returns:
    String The name
  - getClassName
```
java.lang.String getClassName()
```
    Get the class name (pyClassName) of this Alias instance.
    
    Returns:
    String The class name
  - comparator
```
java.lang.String comparator()
```
    Get the sort function specified in this Alias instance.
    
    Returns:
    String The sort function
  - getStreamName
```
java.lang.String getStreamName()
```
    Get the HTML property definition specified in this Alias instance.
    
    Returns:
    String The HTML property info

Interface ImmutablePropertyAliasInfo

Field Summary

Method Summary

Field Detail

VERSION

COPYRIGHT

Method Detail

getType

hasTypeUnknown

hasTypeFreeform

hasTypeText

hasTypeIdentifier

hasTypePassword

hasTypeTextEncrypted

hasTypeDateTime

hasTypeDate

hasTypeTimeOfDay

hasTypeTrueFalse

hasTypeYesOrNo

hasTypeNumber

hasTypeInteger

hasTypeDecimal

hasTypeDouble

hasTypeAmount

getPropertyReferences

getEntryCode

usesExpression

getReference

getName

getClassName

comparator

getStreamName