com.pega.pegarules.pub.clipboard

Interface ClipboardPage

All Superinterfaces:

java.util.Map, StringMap

public interface ClipboardPage
extends StringMap

ClipboardPage provides a common interface to PegaRULES pages. A page represents a collection of ClipboardProperty objects, along with informative messages and other descriptive information. Properties themselves can contain page values, allowing for the nesting of pages.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static java.lang.String	DP_PARAMETER_NAME_NOT_AVAILABLE
static byte	PUTALL_KEEPNEW Potential value of aPutAllOption passed to putAll(Map, byte).
static byte	PUTALL_KEEPOLD Potential value of aPutAllOption passed to putAll(Map, byte).
static byte	PUTALL_MERGE Potential value of aPutAllOption passed to putAll(Map, byte).
static byte	PUTALL_MODEL Potential value of aPutAllOption passed to putAll(Map, byte).
static java.lang.String	VERSION
static byte	XML_CPAXDTD Potential value of aXMLOption passed to getXML(byte).
static byte	XML_JSON Potential value of aXMLOption passed to getXML(byte).
static byte	XML_STANDARD Potential value of aXMLOption passed to getXML(byte).

Method Summary

Modifier and Type	Method and Description
boolean	addLocalizedMessage(java.lang.String aMsgDescr, java.lang.String aFieldName) Associates a message with this page.
boolean	addLocalizedMessageWithKey(java.lang.String aMsgDescr, java.lang.String aFieldName, java.lang.String aPzInsKey) Associates a message and pzInsKey of its originated rule with this page.
boolean	addMessage(java.lang.String aMsgDescr) Associates a message with this page.
boolean	addMessage(java.lang.String aMsgDescr, java.lang.String aReference) Associates a message with a property on this page.
boolean	addMessage(java.lang.String aMsgDescr, java.lang.String aFieldName, java.lang.String aClassName) Deprecated.
boolean	addMessages(ClipboardPage aSourcePage) Copies all of the page messages on aSourcePage and adds them to this page's messages.
boolean	addMessageWithKey(java.lang.String aMsgDescr, java.lang.String aPzInsKey) Associates a message and pzInsKey of its originated rule with this page.
boolean	addMessageWithKey(java.lang.String aMsgDescr, java.lang.String aFieldName, java.lang.String aClassName, java.lang.String aPzInsKey) Deprecated.
void	adoptJSONArray(java.lang.String aJSON, java.lang.String aReference) Imports the contents of a JSON Object onto this page.
void	adoptJSONObject(java.lang.String aJSON) Imports the contents of a JSON Object onto this page.
void	adoptXMLForm(byte[] aXML) Imports the contents of an XML document onto this page.
void	adoptXMLForm(java.io.InputStream aXML) Imports the contents of an XML document onto this page.
void	adoptXMLForm(java.io.Reader aXML) Imports the contents of an XML document onto this page.
void	adoptXMLForm(java.lang.String aXML) Imports the contents of an XML document onto this page.
boolean	attachJavaObject(PRObjectWrapper aJavaObject) Attaches a Java object to this page.
void	clear() Removes all properties from this page.
void	clearMessages() Removes all messages from this page.
void	clearMessages(java.lang.String aReference) Removes all messages from the referenced property.
void	clearValue(java.lang.String aReference) Eliminate the value of the referenced property.
boolean	containsKey(java.lang.Object aName) Query if this page contains a property with this name.
boolean	containsValue(java.lang.Object aValue) Query if this page contains this property.
ClipboardPage	copy() Copies this page and all of its properties to a new page.
ClipboardPage	copy(boolean aReadOnlyCopy, boolean aAvoidChangeTracking) Copies this page and all of its properties to a new page.
void	copyParameterValues(ParameterPage aParmPage) Copies all of the given activity parameter properties onto this page.
java.util.Set	entrySet() Returns the set of all properties contained in this page.
void	expandPropertiesWithMessages() Expands all properties in the page if it is backed by a v6 stream.
java.lang.Object	get(java.lang.Object aReference) Returns the referenced property.
PRObjectWrapper	getAttachedJavaObject() Returns the Java object currently attached to this page.
PRObjectWrapper	getAttachedJavaObject(boolean aCreateIfMissing) Returns the Java object currently attached to this page.
PRObjectWrapper	getAttachedJavaObjectIfPresent() Returns the Java object currently attached to this page.
com.pega.ibm.icu.math.BigDecimal	getBigDecimal(com.pega.pegarules.priv.PegaAPI aPega, java.lang.String aReference) Return value of this property as a IBM BigDecimal value, or if the caller wants, an exception when the property is missing or empty.
com.pega.ibm.icu.math.BigDecimal	getBigDecimal(java.lang.String aReference) Returns the decimal value of the referenced property.
com.pega.ibm.icu.math.BigDecimal	getBigDecimal(java.lang.String aReference, boolean aAvoidAutoChain) Returns the decimal value of the referenced property.
boolean	getBoolean(com.pega.pegarules.priv.PegaAPI aPega, java.lang.String aReference) Return value of this property as a boolean value, or if the caller wants, an exception when the property is missing or empty.
boolean	getBoolean(java.lang.String aReference) Returns the boolean value of the referenced property.
boolean	getBoolean(java.lang.String aReference, boolean aAvoidAutoChain) Returns the boolean value of the referenced property.
java.lang.String	getClassName() Get the name of the class of this page (if any).
java.util.Date	getDate(com.pega.pegarules.priv.PegaAPI aPega, java.lang.String aReference) Return value of this property as a date, or if the caller wants, an exception when the property is missing or empty.
java.util.Date	getDate(java.lang.String aReference) Returns the date value of the referenced property.
java.util.Date	getDate(java.lang.String aReference, boolean aAvoidAutoChain) Returns the date value of the referenced property.
PageDirectory	getDirectory() Get the PageDirectory owner of this page.
double	getDouble(com.pega.pegarules.priv.PegaAPI aPega, java.lang.String aReference) Return value of this property as a double.
double	getDouble(java.lang.String aReference) Returns the double value of the referenced property.
double	getDouble(java.lang.String aReference, boolean aAvoidAutoChain) Returns the double value of the referenced property.
java.lang.String	getEntryHandle(java.lang.String aPropertyReference) Returns a handle to the referenced property that can be used for receiving client input.
ClipboardProperty	getIfPresent(java.lang.String aReference) As getProperty(), but does not create missing pages or properties.
ClipboardProperty	getIfPresent(java.lang.String aReference, boolean aAvoidAutoChain) As getProperty(), but does not create missing pages or properties.
int	getInteger(com.pega.pegarules.priv.PegaAPI aPega, java.lang.String aReference) Return value of the referenced property as a int, or if the caller wants, an exception when the property is missing or empty.
int	getInteger(java.lang.String aReference) Returns the integer value of the referenced property.
int	getInteger(java.lang.String aReference, boolean aAvoidAutoChain) Returns the integer value of the referenced property.
java.lang.String	getJSON(boolean aEncode) Returns a JSON representation of this page which uses property names as JSON identifiers.
java.lang.String	getJSON(java.lang.String aReference, boolean aEncode) Returns a JSON representation of this page which uses property names as JSON identifiers.
java.lang.String	getJSON(java.lang.String aReference, boolean aEncode, boolean aAllowEmptyProperties) Returns a JSON representation of this page which uses property names as JSON identifiers.
ClipboardProperty	getLightweightListProperty(java.lang.String aReference, java.lang.String aDataTransformName) Returns a Virtual ClipboardPage List representation of the referenced property.
int	getMessageCountAll() Get the count of all the messages on a page, including messages on its properties.
java.lang.String	getMessages(java.lang.String aReference) Get messages associated with a referenced property.
java.lang.String	getMessagesAll() Get all messages associated with this page and the properties on this page.
java.util.Map	getMessagesMap() Get all of the messages attached to this page and all embedded pages and properties.
java.util.Map	getMessagesMap(boolean aSeparatePageMessages) Get all of the messages attached to this page and all embedded pages and properties.
java.util.Map	getMessagesMapByEntryHandle() Get all of the messages attached to this page and all embedded pages and properties.
java.lang.String	getMessagesObject() Gets all messages associated with this page itself excluding messages on individual properties.
char	getMode(java.lang.String aReference) Get the mode of the referenced property.
java.lang.String	getName() Get the name of this page.
java.lang.Object	getObject(java.lang.String aReference) Returns the Object value of the referenced property of mode Java Object.
ClipboardPage	getPage(java.lang.String aReference) Returns the page value of the referenced property.
ClipboardPage	getParentPage() Identifies the page which contains this page.
ClipboardProperty	getParentProperty() Identifies the property which contains this page.
ClipboardProperty	getProperty(com.pega.pegarules.priv.PegaAPI aPega, java.lang.String aReference) Returns the referenced property.
ClipboardProperty	getProperty(java.lang.String aReference) Returns the referenced property.
java.lang.String	getReference() Returns an absolute reference to this page if it is embedded.
java.lang.String	getString(com.pega.pegarules.priv.PegaAPI aPega, java.lang.String aReference) Return value of the referenced property as a String.
java.lang.String	getString(java.lang.String aReference) Returns the string value of the referenced property.
java.lang.String	getString(java.lang.String aReference, boolean aAvoidAutoChain) Returns the string value of the referenced property.
java.lang.String	getStringIfPresent(java.lang.String aReference) Returns the string value of the referenced property, or null if the property is not present on the page.
java.lang.String	getStringIfPresent(java.lang.String aReference, boolean aAvoidAutoChain) Returns the string value of the referenced property, or null if the property is not present on the page.
java.lang.String	getSubscript() If this page is an element in a Page Group, returns the name of the element (the property containing this page).
ClipboardPage	getTopLevelPage() Gets the top-level page for this object.
char	getType(java.lang.String aReference) Get the type of the referenced property.
java.lang.String	getXML() Returns an XML representation of this page which uses property names as XML identifiers.
java.lang.String	getXML(byte aXMLOption) Returns an XML representation of this page.
java.lang.String	getXML(byte aXMLOption, boolean aForDisplay) Returns an XML representation of this page.
java.lang.String	getXML(java.lang.String aReference) Returns an XML representation of this page which uses property names as XML identifiers.
boolean	hasMessages() Indicates whether this page or any embedded pages or properties have messages.
boolean	hasMessages(java.lang.String aReference) Indicates whether this referenced property or any of its embedded pages or properties have messages.
boolean	isEmbedded() Indicates whether this page is embedded as a property within another page.
boolean	isEmpty() Indicates whether any properties are contained within this page.
boolean	isEmpty(java.lang.String aReference) Indicates whether the referenced property has a value.
boolean	isJavaPage() Does this page's class extend the Embed-Java- class? If so, this page is a java page that may have a java object wrapper attached to it.
boolean	isLoadOnly()
boolean	isReadOnly() Indicates whether this page is read-only.
boolean	isValid() Reports the results of validation of this page.
java.util.Set	keySet() Returns the set of all the property names on this page.
void	move(ClipboardProperty aSourceProperty) Moves a property into this page.
void	move(java.lang.String aReference, ClipboardProperty aSourceProperty) Moves a property into this page.
void	movePage(java.lang.String aReference, ClipboardPage aSourcePage) Move a page value into a property on this page.
boolean	needsValidation() Returns true only if this page has not been validated.
void	put(ClipboardProperty aProperty) Puts a property onto the clipboard.
java.lang.Object	put(java.lang.Object aReference, java.lang.Object aProperty) Puts a property onto the clipboard.
void	putAll(java.util.Map aSource) Copies the properties from a map onto this page.
void	putAll(java.util.Map aSource, byte aPutAllOption) Copies the properties from another page onto this page.
void	putObject(java.lang.String aReference, java.lang.Object aValue) A shortcut method, essentially the same as calling thisPage.getProperty(aReference).setValue(aValue).
void	putPage(java.lang.String aReference, ClipboardPage aValue) A shortcut method, essentially the same as calling thisPage.getProperty(aReference).setValue(aValue).
void	putString(java.lang.String aReference, java.lang.String aValue) A shortcut method, essentially the same as calling thisPage.getProperty(aReference).setValue(aValue).
void	putString(java.lang.String aName, java.lang.String aValue, boolean aAtomicName) Establishes an association between the specified value and the specified name (optional operation).
java.lang.Object	remove(java.lang.Object aReference) Remove a property from the clipboard.
boolean	removeFromClipboard() Removes this top-level named page from the clipboard.
boolean	rename(java.lang.String aNewPageName) Change the name of this page.
boolean	replace(ClipboardPage aSource) Clear this page and place the entire contents of this page, if any, with a copy of the contents of another page.
boolean	replace(ClipboardPage aSource, boolean aAvoidChangeTracking) Clear this page and place the entire contents of this page, if any, with a copy of the contents of another page.
boolean	retainAll(java.util.Collection aRetainCollection) This method causes all properties but those listed in aRetainCollection to be removed from this page.
int	size() Returns the number of properties embedded in this page.
int	size(java.lang.String aReference) Returns size of the referenced property.
java.util.Collection	values() Returns a collection of all of the properties on this page.
void	writeXML(java.io.OutputStream aTarget) Write a clipboard page to an OutputStream
void	writeXML(java.io.OutputStream aTarget, byte aXMLOption) Write a clipboard page to an OutputStream, using a specific XML representation of this page.

Methods inherited from interface com.pega.pegarules.pub.util.StringMap

toString

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

VERSION

static final java.lang.String VERSION

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

PUTALL_KEEPOLD

static final byte PUTALL_KEEPOLD

Potential value of aPutAllOption passed to putAll(Map, byte).

See Also:

Constant Field Values

PUTALL_KEEPNEW

static final byte PUTALL_KEEPNEW

Potential value of aPutAllOption passed to putAll(Map, byte).

See Also:

Constant Field Values

PUTALL_MODEL

static final byte PUTALL_MODEL

Potential value of aPutAllOption passed to putAll(Map, byte).

See Also:

Constant Field Values

PUTALL_MERGE

static final byte PUTALL_MERGE

Potential value of aPutAllOption passed to putAll(Map, byte).

See Also:

Constant Field Values

XML_STANDARD

static final byte XML_STANDARD

Potential value of aXMLOption passed to getXML(byte).

See Also:

Constant Field Values

XML_CPAXDTD

static final byte XML_CPAXDTD

Potential value of aXMLOption passed to getXML(byte).

See Also:

Constant Field Values

XML_JSON

static final byte XML_JSON

Potential value of aXMLOption passed to getXML(byte). Creates output in JSON rather than XML.

See Also:

Constant Field Values

DP_PARAMETER_NAME_NOT_AVAILABLE

static final java.lang.String DP_PARAMETER_NAME_NOT_AVAILABLE

See Also:

Constant Field Values

Method Detail

getEntryHandle

java.lang.String getEntryHandle(java.lang.String aPropertyReference)

Returns a handle to the referenced property that can be used for receiving client input. An entry handle is a special form of property reference that is used in the context of Streams. The results of this method can differ from ClipboardProperty.getEntryHandle() if there is a Reference Property somewhere within the structure covered by aPropertyReference.

Parameters:

aPropertyReference - property reference to get the entry handle for. The reference is evaluated relative to this page.

Returns:

the handle. If there is none, an empty string is returned.

getMessagesMap

java.util.Map getMessagesMap()

Get all of the messages attached to this page and all embedded pages and properties.

Returns:

If there are no messages, null. Otherwise, a Map of property references to messages. Messages attached to this page itself are added to the map with a blank key (""). If a property has multiple messages attached, they are separated by newline characters.

getMessagesMap

java.util.Map getMessagesMap(boolean aSeparatePageMessages)

Get all of the messages attached to this page and all embedded pages and properties.

Parameters:

aSeparatePageMessages - If true, separates out each page message into its own map entry.

Returns:

If there are no messages, null. Otherwise, a Map of property references to messages. If aSeparatePageMessages is false, messages attached to this page itself are added to the map with a blank key (""). If aSeparatePageMessages is true, messages attached to this page itself are added to the map using an incrementing integer counter as the key. If a property has multiple messages attached, they are separated by newline characters.

getMessagesMapByEntryHandle

java.util.Map getMessagesMapByEntryHandle()

Get all of the messages attached to this page and all embedded pages and properties.

Returns:

If there are no messages, null. Otherwise, a Map of property entry handles to messages. Messages attached to this page itself are added to the map with a blank key (""). If a property has multiple messages attached, they are separated by newline characters.

addMessage

boolean addMessage(java.lang.String aMsgDescr)

Associates a message with this page. This method also invalidates the page.

Parameters:

aMsgDescr - The message to be added to the page.

Returns:

true

Throws:

InvalidParameterException - aMsgDescr cannot be null

ReadOnlyException - This page is read-only and cannot be modified.

addMessages

boolean addMessages(ClipboardPage aSourcePage)

Copies all of the page messages on aSourcePage and adds them to this page's messages. Existing messages on this target page are not affected. Does not copy property messages.

Parameters:

aSourcePage - page to copy messages from

Returns:

true

Throws:

InvalidParameterException - aSourcePage cannot be null

ReadOnlyException - This page is read-only and cannot be modified.

addMessage

boolean addMessage(java.lang.String aMsgDescr,
                   java.lang.String aReference)

Associates a message with a property on this page. This method also causes the Error attribute to be set on that property.

Parameters:

aMsgDescr - The message to be added to the property.

aReference - Reference to a property that is defined on this page.

Returns:

true if the message is added successfully

Throws:

ReadOnlyException - This page is read-only and cannot be modified.

InvalidParameterException - aMsgDescr cannot be null

InvalidReferenceException - aReference is not a syntactically correct reference

addMessage

@Deprecated
boolean addMessage(java.lang.String aMsgDescr,
                               java.lang.String aFieldName,
                               java.lang.String aClassName)

Deprecated.

Associates a message with this page. This method also invalidates the page. This method is deprecated since it does not honor the param aClassName. To set message using a field value, call addLocalizedMessage(String aMsgDescr, String aFieldName) instead

Parameters:

aMsgDescr - The message to be added to the page.

aFieldName - The name of the 'category property' that this message is under in fieldvalue

aClassName - (optional) The name of the class in FieldValue for the message (defaults to @baseclass)

Returns:

true

Throws:

InvalidParameterException - aMsgDescr cannot be null

ReadOnlyException - This page is read-only and cannot be modified.

addLocalizedMessage

boolean addLocalizedMessage(java.lang.String aMsgDescr,
                            java.lang.String aFieldName)

Associates a message with this page. This method also invalidates the page. This method localizes the message if a matching field value is found in the hierarchy of the page class

Parameters:

aMsgDescr - The message to be added to the page.

aFieldName - The name of the 'category property' that this message is under in fieldvalue

Returns:

true

Throws:

InvalidParameterException - aMsgDescr cannot be null

ReadOnlyException - This page is read-only and cannot be modified.

addMessageWithKey

boolean addMessageWithKey(java.lang.String aMsgDescr,
                          java.lang.String aPzInsKey)

Associates a message and pzInsKey of its originated rule with this page. This method also invalidates the page.

Parameters:

aMsgDescr - The message to be added to the page.

aPzInsKey - (optional) The pzInsKey of the rule where the message originated.

Returns:

true

Throws:

InvalidParameterException - aMsgDescr cannot be null

ReadOnlyException - This page is read-only and cannot be modified.

addMessageWithKey

@Deprecated
boolean addMessageWithKey(java.lang.String aMsgDescr,
                                      java.lang.String aFieldName,
                                      java.lang.String aClassName,
                                      java.lang.String aPzInsKey)

Deprecated.

* Associates a message with this page. This method also invalidates the page. This method is deprecated since it does not honor the param aClassName. To set message using a field value, call addLocalizedMessageWithKey(String aMsgDescr, String aFieldName, String aPzInsKey) instead

Parameters:

aMsgDescr - The message to be added to the page.

aFieldName - The name of the 'category property' that this message is under in fieldvalue

aClassName - (optional) The name of the class in FieldValue for the message (defaults to @baseclass)

aPzInsKey - (optional) The pzInsKey of the rule where the message originated.

Returns:

true

Throws:

InvalidParameterException - aMsgDescr cannot be null

ReadOnlyException - This page is read-only and cannot be modified.

addLocalizedMessageWithKey

boolean addLocalizedMessageWithKey(java.lang.String aMsgDescr,
                                   java.lang.String aFieldName,
                                   java.lang.String aPzInsKey)

Associates a message and pzInsKey of its originated rule with this page. This method also invalidates the page.This method localizes the message if a matching field value is found in the hierarchy of the page class

Parameters:

aMsgDescr - The message to be added to the page.

aFieldName - The name of the 'category property' that this message is under in fieldvalue

aPzInsKey - (optional) The pzInsKey of the rule where the message originated.

Returns:

true

Throws:

InvalidParameterException - aMsgDescr cannot be null

ReadOnlyException - This page is read-only and cannot be modified.

getJSON

java.lang.String getJSON(boolean aEncode)

Returns a JSON representation of this page which uses property names as JSON identifiers.

Parameters:

aEncode - true if values should be XSS encoded

Returns:

the JSON object

getJSON

java.lang.String getJSON(java.lang.String aReference,
                         boolean aEncode)

Returns a JSON representation of this page which uses property names as JSON identifiers.

Parameters:

aReference - property reference relative to this page defining the single property (and its value) that should be output. If it does not exist, it will not be created and a JSON stream containing an empty page will be returned.

aEncode - true if values should be XSS encoded

Returns:

the JSON object

getJSON

java.lang.String getJSON(java.lang.String aReference,
                         boolean aEncode,
                         boolean aAllowEmptyProperties)

Returns a JSON representation of this page which uses property names as JSON identifiers.

Parameters:

aReference - property reference relative to this page defining the single property (and its value) that should be output. If it does not exist, it will not be created and a JSON stream containing an empty page will be returned.

aEncode - true if values should be XSS encoded

aAllowEmptyProperties - true if properties with empty value should also be included

Returns:

the JSON object

adoptJSONObject

void adoptJSONObject(java.lang.String aJSON)
              throws InvalidStreamError

Imports the contents of a JSON Object onto this page.

Parameters:

aJSON - the input JSON Object

Throws:

InvalidParameterException - aJSON cannot be null

InvalidStreamError - the input JSON is not valid

adoptJSONArray

void adoptJSONArray(java.lang.String aJSON,
                    java.lang.String aReference)
             throws InvalidStreamError

Imports the contents of a JSON Object onto this page.

Parameters:

aJSON - the input JSON Object

aReference - If the content of aJSON is an array (rather than an object), then the array will be placed into the property aReference (which must be a atomic name) - will default to "JSONArrayList" if aReference is null. If the content of aJSON is an object, then aReference will be ignored and this method will behave the same as adoptJSONObject.

Throws:

InvalidParameterException - aJSON cannot be null

InvalidStreamError - the input JSON is not valid

adoptXMLForm

void adoptXMLForm(java.lang.String aXML)
           throws InvalidStreamError

Imports the contents of an XML document onto this page.

Parameters:

aXML - the input XML document

Throws:

InvalidParameterException - aXML cannot be null

InvalidStreamError - the input XML is not valid

adoptXMLForm

void adoptXMLForm(byte[] aXML)
           throws InvalidStreamError

Imports the contents of an XML document onto this page.

Parameters:

aXML - a byte array containing the XML document

Throws:

InvalidParameterException - aXML cannot be null

InvalidStreamError - the input XML is not valid

adoptXMLForm

void adoptXMLForm(java.io.InputStream aXML)
           throws InvalidStreamError

Imports the contents of an XML document onto this page.

Parameters:

aXML - an InputStream containing the XML document

Throws:

InvalidParameterException - aXML cannot be null

InvalidStreamError - the input XML is not valid

adoptXMLForm

void adoptXMLForm(java.io.Reader aXML)
           throws InvalidStreamError

Imports the contents of an XML document onto this page.

Parameters:

aXML - a Reader containing the XML document

Throws:

InvalidParameterException - aXML cannot be null

InvalidStreamError - the input XML is not valid

getReference

java.lang.String getReference()

Returns an absolute reference to this page if it is embedded. Top level pages (User Named Pages) will simply return their name. May return a blank string if the page is unnamed and unembedded.

Returns:

a reference to this page

clear

void clear()

Removes all properties from this page. All page attributes (i.e. Status) are re-initialized. Any attached Java object is removed.

Specified by:

clear in interface java.util.Map

Throws:

ReadOnlyException - This page is read-only and cannot be modified.

clearValue

void clearValue(java.lang.String aReference)

Eliminate the value of the referenced property.

Parameters:

aReference - a property reference

Throws:

ReadOnlyException - if this property is embedded on a Read Only page and cannot be modified

copy

ClipboardPage copy()

Copies this page and all of its properties to a new page. The new page will also retain all attributes and properties of the original, along with features such as Read-Only or Synchronized.

Returns:

the new page

copy

ClipboardPage copy(boolean aReadOnlyCopy,
                   boolean aAvoidChangeTracking)

Copies this page and all of its properties to a new page. The new page will also retain all attributes and properties of the original.

Parameters:

aReadOnlyCopy - This setting is reserved for future use. Set the value to false.

aAvoidChangeTracking - true to avoid change tracking on the copy. This is an advanced option; set to false if you are not familiar with this parameters implications.

Returns:

the new page

clearMessages

void clearMessages()

Removes all messages from this page. Also removes messages from all properties embedded on this page.

Throws:

ReadOnlyException - This page is read-only and cannot be modified.

clearMessages

void clearMessages(java.lang.String aReference)

Removes all messages from the referenced property. Also removes messages from all its embedded properties.

Parameters:

aReference - reference to a property

Throws:

ReadOnlyException - This page is read-only and cannot be modified.

containsKey

boolean containsKey(java.lang.Object aName)

Query if this page contains a property with this name.

Specified by:

containsKey in interface java.util.Map

Parameters:

aName - a String object containing a property name (no complex references or qualifiers are allowed).

Returns:

true if the reference resolves to a property on this page only, false otherwise

Throws:

InvalidParameterException - aReference is not an instance of String.

containsValue

boolean containsValue(java.lang.Object aValue)

Query if this page contains this property.

Specified by:

containsValue in interface java.util.Map

Parameters:

aValue - a ClipboardProperty object

Returns:

true if the given property is embedded on this page, false otherwise

Throws:

InvalidParameterException - aValue is not an instance of ClipboardProperty.

copyParameterValues

void copyParameterValues(ParameterPage aParmPage)

Copies all of the given activity parameter properties onto this page. This method resolves references during the process.

Parameters:

aParmPage - The page containing the parameters to be copied.

Throws:

ReadOnlyException - This page is read-only and cannot be modified.

entrySet

java.util.Set entrySet()

Returns the set of all properties contained in this page.

Use the iterator() method of the returned object to perform an operation on each property in turn. Note that this iterator reflects the contents of this page at the time of its creation. Further changes to this page will not be reflected in this iterator.

Specified by:

entrySet in interface java.util.Map

Returns:

the set of all properties contained in this page

get

java.lang.Object get(java.lang.Object aReference)

Returns the referenced property. If the referenced property does not exist, it is created if possible.

Specified by:

get in interface java.util.Map

Parameters:

aReference - String object which contains a reference to a property.

Returns:

the ClipboardProperty

Throws:

InvalidParameterException - aReference is not an instance of String.

InvalidReferenceException - aReference is not a syntactically correct reference

ReadOnlyException - the property does not exist and could not be created on a read-only page

getPage

ClipboardPage getPage(java.lang.String aReference)

Returns the page value of the referenced property.

Parameters:

aReference - a reference to a property.

Returns:

the ClipboardPage value of the property

Throws:

WrongModeException - The value of aReference is not a page

InvalidReferenceException - aReference is not a syntactically correct reference

getProperty

ClipboardProperty getProperty(java.lang.String aReference)

Returns the referenced property.

Use this method if the caller may want to know whether this property is empty or not present on the clipboard (creates the property if it doesn't exist).

Parameters:

aReference - String object which contains a reference to a property.

Returns:

the ClipboardProperty

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

ReadOnlyException - the property does not exist and could not be created on a read-only page

getLightweightListProperty

ClipboardProperty getLightweightListProperty(java.lang.String aReference,
                                             java.lang.String aDataTransformName)

Returns a Virtual ClipboardPage List representation of the referenced property. For properties which are not page list mode it fails with a WrongModeException.

Parameters:

aReference - String object which contains a reference to a property.

aDataTransformName - name of the data transform to populate pyMapping. The Data transform should be defined in Code-Pega-List and should specify the properties the page list will hold virtual in nature

Returns:

the Virtual Clipboard Page List property

Throws:

WrongModeException - this property is not a pagelist

InvalidParameterException - the pagelist property is non empty

getProperty

ClipboardProperty getProperty(com.pega.pegarules.priv.PegaAPI aPega,
                              java.lang.String aReference)

Returns the referenced property. Identical to get(java.lang.Object).

Use this method if the caller may want to know whether this property is empty or not present on the clipboard (instead of the default empty value). If the property is missing or empty, and isBackwardChaining() is set to true, a MissingPropertyException is thrown.

Parameters:

aPega - The current PegaAPI, used to determine if backward chaining is enabled.

aReference - String object which contains a reference to a property.

Returns:

the ClipboardProperty

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

ReadOnlyException - the property does not exist and could not be created on a read-only page

getObject

java.lang.Object getObject(java.lang.String aReference)

Returns the Object value of the referenced property of mode Java Object.

Parameters:

aReference - a reference to a property.

Returns:

the Object value of the property

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

WrongModeException - The value of aReference is not a Java Object

getString

java.lang.String getString(java.lang.String aReference)

Returns the string value of the referenced property.

Specified by:

getString in interface StringMap

Parameters:

aReference - a reference to a property.

Returns:

the String value of the property. If the property is not present, this method returns "".

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

WrongModeException - The value of aReference is not a string

getString

java.lang.String getString(java.lang.String aReference,
                           boolean aAvoidAutoChain)

Returns the string value of the referenced property.

Parameters:

aReference - a reference to a property.

aAvoidAutoChain - avoid any automatic backward chaining while retrieving the property value. This parameter should almost always be set to false (use getString(String)).

Returns:

the String value of the property. If the property is not present, this method returns "".

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

WrongModeException - The value of aReference is not a string

getStringIfPresent

java.lang.String getStringIfPresent(java.lang.String aReference,
                                    boolean aAvoidAutoChain)

Returns the string value of the referenced property, or null if the property is not present on the page.

Parameters:

aReference - a reference to a property.

aAvoidAutoChain - avoid any automatic backward chaining while retrieving the property value. This parameter should almost always be set to false (use getStringIfPresent(String)).

Returns:

the String value of the property or null

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

WrongModeException - The value of aReference is not a string

getIfPresent

ClipboardProperty getIfPresent(java.lang.String aReference,
                               boolean aAvoidAutoChain)

As getProperty(), but does not create missing pages or properties.

Parameters:

aReference - a reference to a property

aAvoidAutoChain - avoid any automatic backward chaining while retrieving the property. This parameter should almost always be set to false (use getIfPresent(String)).

Returns:

the referenced ClipboardProperty, or null if no such property exists

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

getInteger

int getInteger(java.lang.String aReference,
               boolean aAvoidAutoChain)

Returns the integer value of the referenced property.

Parameters:

aReference - a reference to an integer property.

aAvoidAutoChain - avoid any automatic backward chaining while retrieving the property value. This parameter should almost always be set to false (use getInteger(String)).

Returns:

the int value of the property

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

WrongModeException - The value of aReference is not an integer

getBoolean

boolean getBoolean(java.lang.String aReference,
                   boolean aAvoidAutoChain)

Returns the boolean value of the referenced property.

Parameters:

aReference - a reference to an boolean property.

aAvoidAutoChain - avoid any automatic backward chaining while retrieving the property value. This parameter should almost always be set to false (use getBoolean(String)).

Returns:

the boolean value of the property

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

WrongModeException - The value of aReference is not an boolean

getString

java.lang.String getString(com.pega.pegarules.priv.PegaAPI aPega,
                           java.lang.String aReference)

Return value of the referenced property as a String. In the process, this property's definition is retrieved from the dictionary if it is not already known. This method will attempt to return a String even if the property's type does not match.

Use this method if the caller may want to know whether this property is empty or not present on the clipboard (instead of the default empty value). If the property is missing or empty, and isBackwardChaining() is set to true, a MissingPropertyException is thrown.

Parameters:

aPega - The current PegaAPI, used to determine if backward chaining is enabled.

aReference - a reference to an String property

Returns:

value of this property, or "" if the property is empty.

Throws:

InvalidValueException - if this property is not empty and it cannot be converted to a String.

MissingPropertyException - if this property is empty or missing, and PegaAPI.isBackwardChaining() is set to true.

getStringIfPresent

java.lang.String getStringIfPresent(java.lang.String aReference)

Returns the string value of the referenced property, or null if the property is not present on the page.

Parameters:

aReference - a reference to a property.

Returns:

the String value of the property or null

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

WrongModeException - The value of aReference is not a string

getSubscript

java.lang.String getSubscript()

If this page is an element in a Page Group, returns the name of the element (the property containing this page).

Returns:

the element name

Throws:

WrongModeException - this page is not an element in a Page Group

getClassName

java.lang.String getClassName()

Get the name of the class of this page (if any).

Returns:

name of the class or an empty string ("") if there is no class

getIfPresent

ClipboardProperty getIfPresent(java.lang.String aReference)

As getProperty(), but does not create missing pages or properties.

Parameters:

aReference - a reference to a property

Returns:

the referenced ClipboardProperty, or null if no such property exists

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

getMessages

java.lang.String getMessages(java.lang.String aReference)

Get messages associated with a referenced property. The messages will have been formatted for display and multiple messages will be separated by newline ('\n') characters.

Parameters:

aReference - Reference to a property.

Returns:

text of messages

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

getMessagesAll

java.lang.String getMessagesAll()

Get all messages associated with this page and the properties on this page. The messages will have been formatted for display and multiple messages will be separated by newline ('\n') characters.

Returns:

text of messages

getMessagesObject

java.lang.String getMessagesObject()

Gets all messages associated with this page itself excluding messages on individual properties. The messages will have been formatted for display and multiple messages will be separated by newline ('\n') characters.

Returns:

text of messages

getMessageCountAll

int getMessageCountAll()

Get the count of all the messages on a page, including messages on its properties.

Returns:

count of all messages on page.

getName

java.lang.String getName()

Get the name of this page. Blank ("") names are valid for embedded pages.

Returns:

name of page

getParentPage

ClipboardPage getParentPage()

Identifies the page which contains this page. If the immediate parent isn't a page (i.e., this page is in a list), go up the chain until the first page is found.

Returns:

the containing page. If there is none (i.e., this is a top-level page), null.

getParentProperty

ClipboardProperty getParentProperty()

Identifies the property which contains this page.

Returns:

the containing property. If there is none (i.e., this is a top-level page), null.

getDirectory

PageDirectory getDirectory()

Get the PageDirectory owner of this page.

Returns:

Instance of PageDirectory or null if this object is not owned by any PageDirectory.

writeXML

void writeXML(java.io.OutputStream aTarget)
       throws java.io.IOException

Write a clipboard page to an OutputStream

Parameters:

aTarget - The outputstream to write the XML to

Throws:

java.io.IOException

writeXML

void writeXML(java.io.OutputStream aTarget,
              byte aXMLOption)
       throws java.io.IOException

Write a clipboard page to an OutputStream, using a specific XML representation of this page.

Parameters:

aTarget -

aXMLOption - Used to determine XML formatting method. Only the following options are valid:

• XML_STANDARD: Use property names as XML identifiers. Identical to calling getXML().
• XML_CPAXDTD: Use a Pegasystems DTD tailored for CPAX requirements.

Throws:

java.io.IOException - when there is a problem writing to the given stream

getXML

java.lang.String getXML()

Returns an XML representation of this page which uses property names as XML identifiers.

Returns:

the XML document

getXML

java.lang.String getXML(java.lang.String aReference)

Returns an XML representation of this page which uses property names as XML identifiers. The only property output in the XML document will be that referenced by aReference. The top level page will not contain any page messages or pzStatus property.

This method is useful when only a single property of a page is relevant and one wishes to leave out all other properties (eg, "pxResults" on a Code-Pega-List page).

Parameters:

aReference - property reference relative to this page defining the single property (and its value) that should be output. If it does not exist, it will not be created and an XML stream containing an empty page will be returned.

Returns:

the XML document

getXML

java.lang.String getXML(byte aXMLOption)

Returns an XML representation of this page.

Parameters:

aXMLOption - Used to determine XML formatting method. Only the following options are valid:

• XML_STANDARD: Use property names as XML identifiers. Identical to calling getXML().
• XML_CPAXDTD: Use a Pegasystems DTD tailored for CPAX requirements.

Returns:

the XML document

getXML

java.lang.String getXML(byte aXMLOption,
                        boolean aForDisplay)

Returns an XML representation of this page.

Parameters:

aXMLOption - Used to determine XML formatting method. Only the following options are valid:

• XML_STANDARD: Use property names as XML identifiers. Identical to calling getXML().
• XML_CPAXDTD: Use a Pegasystems DTD tailored for CPAX requirements.

aForDisplay - If true, extracts all Java Property values for display. Do NOT use this option for transporting data between systems. The generated XML is for debugging and display purposes ONLY.

Returns:

the XML document

hasMessages

boolean hasMessages()

Indicates whether this page or any embedded pages or properties have messages. All levels of the structure are searched.

Returns:

true if any page or property embedded in this page has a message, false otherwise

hasMessages

boolean hasMessages(java.lang.String aReference)

Indicates whether this referenced property or any of its embedded pages or properties have messages. All levels of the structure are searched.

Parameters:

aReference - reference to a property

Returns:

true if any page or property embedded in the referenced property has a message, false otherwise

isEmbedded

boolean isEmbedded()

Indicates whether this page is embedded as a property within another page.

Returns:

true if the page is embedded, false otherwise

isEmpty

boolean isEmpty()

Indicates whether any properties are contained within this page.

Specified by:

isEmpty in interface java.util.Map

Returns:

true if there are any properties in this page, false otherwise

isEmpty

boolean isEmpty(java.lang.String aReference)

Indicates whether the referenced property has a value.

Parameters:

aReference - a property reference

Returns:

true if the reference property has a value, false otherwise

isReadOnly

boolean isReadOnly()

Indicates whether this page is read-only.

Returns:

true if the page is read-only, false otherwise

isValid

boolean isValid()

Reports the results of validation of this page. The page must be validated in the dictionary before using this method. needsValidation can be employed to determine if validation is required. The Page-Validate Activity method or (from a java step) validate can be used to validate the contents of the page. isValid - returns true only if no properties on this page, or any included page, have the Error or External attribute set. isValid returns fal42se only if no properties on this page, or any included page, have the Error or External attribute set.

Returns:

true if the page is valid, false otherwise

needsValidation

boolean needsValidation()

Returns true only if this page has not been validated.

Returns:

true if the page has not been validated, false otherwise

keySet

java.util.Set keySet()

Returns the set of all the property names on this page.

Use the iterator() method of the returned object to perform an operation on each property in turn. Note that this iterator reflects the contents of this page at the time of its creation. Further changes to this page will not be reflected in this iterator.

Specified by:

keySet in interface java.util.Map

Returns:

set of the names of all properties embedded on this page

put

java.lang.Object put(java.lang.Object aReference,
                     java.lang.Object aProperty)

Puts a property onto the clipboard. The property name part of aReference overrides the property name in aProperty. If aProperty is embedded, a copy of it will be used. Use move(String, ClipboardProperty) to avoid copying the source property.

Specified by:

put in interface java.util.Map

Parameters:

aReference - A String that contains the reference to the new property.

aProperty - A ClipboardProperty to be put onto this page.

Returns:

null

Throws:

InvalidParameterException - aReference is not an instance of String or aProperty is not an instance of ClipboardProperty.

InvalidReferenceException - aReference is not a syntactically correct reference

ReadOnlyException - This page is read-only and cannot be modified.

UnmodifiablePropertyException - input property would replace an unmodifiable property

WrongModeException - target page is a Page or String Group and cannot accept this property

put

void put(ClipboardProperty aProperty)

Puts a property onto the clipboard. Replaces any existing property of the same name. If aProperty is already embedded in another page or list, a copy of aProperty (and its contents) will be embedded in this page instead. Use move(ClipboardProperty) to avoid copying the source property.

Parameters:

aProperty - A ClipboardProperty to be put onto this page.

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

ReadOnlyException - This page is read-only and cannot be modified.

UnmodifiablePropertyException - input property would replace an unmodifiable property

WrongModeException - target page is a Page or String Group and cannot accept this property

putString

void putString(java.lang.String aReference,
               java.lang.String aValue)

A shortcut method, essentially the same as calling thisPage.getProperty(aReference).setValue(aValue). This shortcut is more efficient and should be used whenever possible.

Specified by:

putString in interface StringMap

Parameters:

aReference - A reference to the new property.

aValue - Used as the value of the new property. Note that properties with blank ("") values may be stripped from the page during serialization.

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

ReadOnlyException - This page is read-only and cannot be modified.

UnmodifiablePropertyException - input property would replace an unmodifiable property

WrongModeException - target page is a Page Group and cannot accept String properties Note: setting the value of a property clears any messages associated with that property as well!

putString

void putString(java.lang.String aName,
               java.lang.String aValue,
               boolean aAtomicName)

Establishes an association between the specified value and the specified name (optional operation). Any previous association for this name is replaced.

Parameters:

aName - name with which the specified value is to be associated

aValue - value to be associated with the specified name

aAtomicName - is the name property an atomic property

Throws:

java.lang.IllegalArgumentException - if some aspect of this name or value prevents it from being stored in this instance

java.lang.NullPointerException - if either the name or the value is null and is not allowed to be by the implementation

java.lang.UnsupportedOperationException - if putString is not supported by this implementation

putObject

void putObject(java.lang.String aReference,
               java.lang.Object aValue)

A shortcut method, essentially the same as calling thisPage.getProperty(aReference).setValue(aValue). This shortcut is more efficient and should be used whenever possible.

Parameters:

aReference - A reference to the new property.

aValue - Used as the value of the new property.

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

ReadOnlyException - This page is read-only and cannot be modified.

UnmodifiablePropertyException - input property would replace an unmodifiable property

WrongModeException - target page is a String or Page Group and cannot accept Java Object properties Note: setting the value of a property clears any messages associated with that property as well!

putPage

void putPage(java.lang.String aReference,
             ClipboardPage aValue)

A shortcut method, essentially the same as calling thisPage.getProperty(aReference).setValue(aValue). This shortcut is more efficient and should be used whenever possible. Use movePage(java.lang.String, com.pega.pegarules.pub.clipboard.ClipboardPage) to avoid copying the source page.

Parameters:

aReference - A reference to the new property.

aValue - Used as the value of the new property.

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

ReadOnlyException - This page is read-only and cannot be modified.

UnmodifiablePropertyException - input property would replace an unmodifiable property

WrongModeException - target page is a String Group and cannot accept Page properties

putAll

void putAll(java.util.Map aSource)

Copies the properties from a map onto this page. The copied properties are new instances containing copied values (pages, strings and properties). Existing properties on this page are overwritten by new properties of the same name.

Specified by:

putAll in interface java.util.Map

Parameters:

aSource - map to be merged into this one. Map keys must be strings containing valid references. Map values must be instances of ClipboardProperty, ClipboardPage, or String.

Throws:

InvalidReferenceException - one of the input map's references is not syntactically correct

ReadOnlyException - This page is read-only and cannot be modified.

UnmodifiablePropertyException - an input property would replace an unmodifiable property

WrongModeException - target page is a String Group and cannot accept Page properties

putAll

void putAll(java.util.Map aSource,
            byte aPutAllOption)

Copies the properties from another page onto this page. The copied properties are new instances containing copied values (pages, strings and properties).

Parameters:

aSource - map to be merged into this one. Map keys must be strings containing valid references. Map values must be instances of ClipboardProperty, ClipboardPage, or String.

aPutAllOption - Used to determine what happens when like-named properties are present on both the source and target pages. Only the following options are valid:

• PUTALL_KEEPOLD: Properties are copied from the source page only when there is no like-named property on the target page.
• PUTALL_KEEPNEW: All properties on the source page are copied to the target page.
• PUTALL_MODEL: Like PUTALL_KEEPOLD, except that the first item of a PageList provides the source for each corresponding item of that PageList in the target.

Throws:

InvalidParameterException - invalid option passed to aPutAllOption

InvalidReferenceException - one of the input map's references is not syntactically correct

ReadOnlyException - This page is read-only and cannot be modified.

UnmodifiablePropertyException - an input property would replace an unmodifiable property

WrongModeException - target page is a String Group and cannot accept Page properties

remove

java.lang.Object remove(java.lang.Object aReference)

Remove a property from the clipboard.

Specified by:

remove in interface java.util.Map

Parameters:

aReference - A String containing the reference to the property to be removed.

Returns:

null

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

ReadOnlyException - This page is read-only and cannot be modified.

UnmodifiablePropertyException - target property is unmodifiable

removeFromClipboard

boolean removeFromClipboard()

Removes this top-level named page from the clipboard. This page and its contents will remain intact. Embedded pages are not affected by this method. Pages with reserved names (starting with "px", "pz", etc.) cannot be removed.

Returns:

true if the page is removed, false otherwise

rename

boolean rename(java.lang.String aNewPageName)

Change the name of this page. If another page in the directory containing this page has the new name, the existing page will be removed from the directory. If this page is not embedded, it will be embedded in the local Thread as a side effect. Emebedded pages cannot be renamed. Pages with reserved names (starting with "px", "pz", etc.) cannot be renamed. The new page name cannot be reserved either.

Parameters:

aNewPageName - New page name.

Returns:

true if the page name was changed, false otherwise

Throws:

ReadOnlyException - This page is read-only and cannot be modified.

replace

boolean replace(ClipboardPage aSource)

Clear this page and place the entire contents of this page, if any, with a copy of the contents of another page.

Parameters:

aSource - Source page to copy from.

Returns:

true if the page contents were replaced, false otherwise

replace

boolean replace(ClipboardPage aSource,
                boolean aAvoidChangeTracking)

Clear this page and place the entire contents of this page, if any, with a copy of the contents of another page.

Parameters:

aSource - Source page to copy from.

aAvoidChangeTracking - if true, the changes to this page will not be noted by change tracking, thus no declarative activities will be triggered by this method. This option should only be used in special situations. Use replace(ClipboardPage) instead.

Returns:

true if the page contents were replaced, false otherwise

retainAll

boolean retainAll(java.util.Collection aRetainCollection)

This method causes all properties but those listed in aRetainCollection to be removed from this page.

aRetainCollection can contain two kinds of objects: string references or ClipboardProperty objects. The collection must be homogenous.

• When passed string references, properties on this page that match one of the input property names are retained. All others are removed. Wildcard subscripts (empty parenthesis) are allowed. If two references would seem to result in conflicting results, the looser of the references are enforced. For instance, given the references ".pxResults(1).aName" and ".pxResults().aCity", all of the elements in the Page List pxResults would be retained. Each element would retain the aCity property. Only the first element would retain aName.
• When passed ClipboardProperty objects, properties on this page that match one of the input property names are retained. All others are removed. In addition, pages embedded on this page recursively have retainAll called on each of them. The input collection used for these recursive calls comes from the embedded page passed through the original input collection. Pages in a list are not recursively pruned. The end result of this is that each embedded page's properties will be pruned such that they match the input page's embedded pages. You can easily generate a collection of properties from a page using values().

Parameters:

aRetainCollection - a Collection of String objects that contain property references ("name", ".name", ".myList(1)", ".myList()", etc.) or a Collection of ClipboardProperty objects which will be used to recursively trim each embedded page

Returns:

true if the page was changed, false otherwise.

size

int size()

Returns the number of properties embedded in this page. Only the first level of properties are counted.

Specified by:

size in interface java.util.Map

Returns:

the number of top level properties contained in this page

size

int size(java.lang.String aReference)

Returns size of the referenced property. See size().

Parameters:

aReference -

Returns:

size of the referenced property, 0 if the property does not exist

values

java.util.Collection values()

Returns a collection of all of the properties on this page.

Use the iterator() method of the returned object to perform an operation on each property in turn. Note that this iterator reflects the contents of this page at the time of its creation. Further changes to this page will not be reflected in this iterator.

Specified by:

values in interface java.util.Map

Returns:

collection of all values on this page

getTopLevelPage

ClipboardPage getTopLevelPage()

Gets the top-level page for this object. The top-level page is either embedded in a directory or has no parent.

Returns:

The top-level page as defined above. Note that if this instance is the top-level page, the method will return this

attachJavaObject

boolean attachJavaObject(PRObjectWrapper aJavaObject)

Attaches a Java object to this page.

To remove a Java object once it has been attached, use clear().

Parameters:

aJavaObject - the object to attach to this page. Must not be null.

Returns:

true if the object is attached, false if it is not, probably because it already has an object attached.

Throws:

ReadOnlyException - This page is read-only and cannot be modified.

getAttachedJavaObject

PRObjectWrapper getAttachedJavaObject()

Returns the Java object currently attached to this page. If no object is currently attached and this page's class has a Java Object Wrapper class defined, a new instance is constructed, attached, and returned by this method.

Returns:

the Java object attached to this page. May return null

getAttachedJavaObject

PRObjectWrapper getAttachedJavaObject(boolean aCreateIfMissing)

Returns the Java object currently attached to this page.

Parameters:

aCreateIfMissing - If true, if no object is currently attached and this page's class has a Java Object Wrapper class defined (currently possible only for class extending from Embed-Java-), a new instance is constructed, attached, and returned by this method. Otherwise, if no object is attached, the method returns null.

Returns:

the Java object attached to this page. May return null

getAttachedJavaObjectIfPresent

PRObjectWrapper getAttachedJavaObjectIfPresent()

Returns the Java object currently attached to this page.

Returns:

the Java object attached to this page. May return null

getInteger

int getInteger(java.lang.String aReference)

Returns the integer value of the referenced property.

Parameters:

aReference - a reference to an integer property.

Returns:

the int value of the property

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

WrongModeException - The value of aReference is not an integer

getInteger

int getInteger(com.pega.pegarules.priv.PegaAPI aPega,
               java.lang.String aReference)

Return value of the referenced property as a int, or if the caller wants, an exception when the property is missing or empty. In the process, this property's definition is retrieved from the dictionary if it is not already known. This method will attempt to return a int even if the property's type does not match.

Use this method if the caller may want to know whether this property is empty or not present on the clipboard (instead of returning the default empty value). If the property is missing or empty, and PegaAPI.isBackwardChaining() is set to true, a MissingPropertyException is thrown.

Parameters:

aPega - The current PegaAPI, used to determine if backward chaining is enabled.

aReference - a reference to an integer property

Returns:

value of this property, or 0 if the property is empty.

Throws:

InvalidValueException - if this property is not empty and it cannot be converted to a double.

MissingPropertyException - if this property is empty or missing, and PegaAPI.isBackwardChaining() is set to true.

getDouble

double getDouble(java.lang.String aReference)

Returns the double value of the referenced property.

Parameters:

aReference - a reference to an double property.

Returns:

the double value of the property

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

WrongModeException - The value of aReference is not an double

getDouble

double getDouble(com.pega.pegarules.priv.PegaAPI aPega,
                 java.lang.String aReference)

Return value of this property as a double. In the process, this property's definition is retrieved from the dictionary if it is not already known. This method will attempt to return a double even if the property's type does not match.

Use this method if the caller may want to know whether this property is empty or not present on the clipboard (instead of the default empty value). If the property is missing or empty, and isBackwardChaining() is set to true, a MissingPropertyException is thrown.

Parameters:

aPega - The current PegaAPI, used to determine if backward chaining is enabled.

aReference - a reference to an double property

Returns:

value of this property, or 0.0 if the property is empty.

Throws:

InvalidValueException - if this property is not empty and it cannot be converted to a double.

MissingPropertyException - if this property is empty or missing, and PegaAPI.isBackwardChaining() is set to true.

getDate

java.util.Date getDate(java.lang.String aReference)

Returns the date value of the referenced property.

Parameters:

aReference - a reference to an date property.

Returns:

the date value of the property

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

WrongModeException - The value of aReference is not an date

getDate

java.util.Date getDate(com.pega.pegarules.priv.PegaAPI aPega,
                       java.lang.String aReference)

Return value of this property as a date, or if the caller wants, an exception when the property is missing or empty. In the process, this property's definition is retrieved from the dictionary if it is not already known. This method will attempt to return a Date even if the property's type does not match.

Use this method if the caller may want to know whether this property is empty or not present on the clipboard (instead of returning the default empty value). If the property is missing or empty, and PegaAPI.isBackwardChaining() is set to true, a MissingPropertyException is thrown.

Parameters:

aPega - The current PegaAPI, used to determine if backward chaining is enabled.

aReference - a reference to a date property.

Returns:

value of this property, or 1970-Jan-01 if the property is empty.

Throws:

InvalidValueException - if this property is not empty and it cannot be converted to a Date.

MissingPropertyException - if this property is empty or missing, and PegaAPI.isBackwardChaining() is set to true.

getBoolean

boolean getBoolean(java.lang.String aReference)

Returns the boolean value of the referenced property.

Parameters:

aReference - a reference to an boolean property.

Returns:

the boolean value of the property

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

WrongModeException - The value of aReference is not an boolean

getBoolean

boolean getBoolean(com.pega.pegarules.priv.PegaAPI aPega,
                   java.lang.String aReference)

Return value of this property as a boolean value, or if the caller wants, an exception when the property is missing or empty. In the process, this property's definition is retrieved from the dictionary if it is not already known. This method will attempt to return a boolean even if the property's type does not match.

Use this method if the caller may want to know whether this property is empty or not present on the clipboard (instead of returning the default empty value).

Parameters:

aPega - The current PegaAPI, used to determine if backward chaining is enabled.

aReference - a reference to a boolean property.

Returns:

value of this property, or false if the property is empty.

Throws:

InvalidValueException - if this property is not empty and it cannot be converted to a boolean.

MissingPropertyException - if this property is empty or missing, and PegaAPI.isBackwardChaining() is set to true.

getBigDecimal

com.pega.ibm.icu.math.BigDecimal getBigDecimal(java.lang.String aReference)

Returns the decimal value of the referenced property.

Parameters:

aReference - a reference to an decimal property.

Returns:

the decimal value of the property

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

WrongModeException - The value of aReference is not an decimal

getBigDecimal

com.pega.ibm.icu.math.BigDecimal getBigDecimal(com.pega.pegarules.priv.PegaAPI aPega,
                                               java.lang.String aReference)

Return value of this property as a IBM BigDecimal value, or if the caller wants, an exception when the property is missing or empty. In the process, this property's definition is retrieved from the dictionary if it is not already known. This method will attempt to return a BigDecimal even if the property's type does not match.

Use this method if the caller may want to know whether this property is empty or not present on the clipboard (instead of returning the default empty value). If the property is missing or empty, and PegaAPI.isBackwardChaining() is set to true, a MissingPropertyException is thrown.

Parameters:

aPega - The current PegaAPI, used to determine if backward chaining is enabled.

aReference - a reference to a decimal property

Returns:

value of this property, or BigDecimal.ZERO if the property is empty.

Throws:

InvalidValueException - if this property is not empty and it cannot be converted to a BigDecimal.

MissingPropertyException - if this property is empty or missing, and PegaAPI.isBackwardChaining() is set to true.

getMode

char getMode(java.lang.String aReference)

Get the mode of the referenced property.

Parameters:

aReference - reference to a property

Returns:

mode of the property. If the property does not exist on this page and has no Rule-Obj-Property definition, returns ImmutablePropertyInfo.MODE_UNRESOLVED.

getType

char getType(java.lang.String aReference)

Get the type of the referenced property.

Parameters:

aReference - reference to a property

Returns:

type of the property. If the property does not exist on this page and has no Rule-Obj-Property definition, returns ImmutablePropertyInfo.TYPE_UNKNOWN.

move

void move(java.lang.String aReference,
          ClipboardProperty aSourceProperty)

Moves a property into this page. The source property is removed from any page or list it is embedded in. This method is more efficient than put(Object, Object) if the source property is destined to be discarded (e.g., coming from a temporary list).

Parameters:

aReference - reference to the new location for the property

aSourceProperty - the property to be moved. This property is guaranteed to be removed from its parent page or list, but is not guaranteed to be the actual object embedded in this page. Use getProperty(String) to get the new property.

move

void move(ClipboardProperty aSourceProperty)

Moves a property into this page. The source property is removed from any page or list it is embedded in. This method is more efficient than put(ClipboardProperty) if the source property is destined to be discarded (e.g., coming from a temporary list).

Parameters:

aSourceProperty - the property to be moved. This property is guaranteed to be removed from its parent page or list, but is not guaranteed to be the actual object embedded in this page. Use getProperty(String) to get the new property.

movePage

void movePage(java.lang.String aReference,
              ClipboardPage aSourcePage)

Move a page value into a property on this page. The source page is removed from its owning property or removed from the list of named pages if applicable. This method is more efficient than putPage(java.lang.String, com.pega.pegarules.pub.clipboard.ClipboardPage) if the source page is destined to be discarded (e.g., coming from a temporary list).

Parameters:

aReference - reference to the new location for the page

aSourcePage - the page to be moved. This page is guaranteed to be removed from its parent property, but is not guaranteed to be the actual object embedded in this page. Use getPage(java.lang.String) to get the new page.

isJavaPage

boolean isJavaPage()

Does this page's class extend the Embed-Java- class? If so, this page is a java page that may have a java object wrapper attached to it.

Returns:

boolean True if page's class extends Embed-Java-, false otherwise

isLoadOnly

boolean isLoadOnly()

Returns:

boolean true if it is an editable data page else false

getDouble

double getDouble(java.lang.String aReference,
                 boolean aAvoidAutoChain)

Returns the double value of the referenced property.

Parameters:

aReference - a reference to an double property.

aAvoidAutoChain - avoid any automatic backward chaining while retrieving the property value. This parameter should almost always be set to false (use getDouble(String)).

Returns:

the double value of the property

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

WrongModeException - The value of aReference is not an double

getDate

java.util.Date getDate(java.lang.String aReference,
                       boolean aAvoidAutoChain)

Returns the date value of the referenced property.

Parameters:

aReference - a reference to an date property.

aAvoidAutoChain - avoid any automatic backward chaining while retrieving the property value. This parameter should almost always be set to false (use getDate(String)).

Returns:

the date value of the property

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

WrongModeException - The value of aReference is not an date

getBigDecimal

com.pega.ibm.icu.math.BigDecimal getBigDecimal(java.lang.String aReference,
                                               boolean aAvoidAutoChain)

Returns the decimal value of the referenced property.

Parameters:

aReference - a reference to an decimal property.

aAvoidAutoChain - avoid any automatic backward chaining while retrieving the property value. This parameter should almost always be set to false (use getBigDecimal(String)).

Returns:

the decimal value of the property

Throws:

InvalidReferenceException - aReference is not a syntactically correct reference

WrongModeException - The value of aReference is not an decimal

expandPropertiesWithMessages

void expandPropertiesWithMessages()

Expands all properties in the page if it is backed by a v6 stream. For v7 it does nothing as the properties with messages are already expanded