com.pega.pegarules.pub.runtime

Interface StreamBuilderToolKit

All Superinterfaces:

PublicAPI

public interface StreamBuilderToolKit
extends PublicAPI

The StreamBuilderToolKit interface identifies the functionality available to support the generation of a defined stream, using First-Use Assembled Java.

Version:

$Revision: 116866 $ $Date: 2014-12-16 05:24:12 -0500 (Tue, 16 Dec 2014) $

Author:

John van der Meer

Property Summary

Properties

Type	Property and Description
boolean	includeShowDeclarative Deprecated. use PegaStreamAPI.isShowMeDeclarativeEnabled() instead
boolean	includeShow Deprecated. use PegaStreamAPI.isShowMePropertyEnabled() instead

Field Summary

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
void	appendCSF(java.lang.String aSource) Applies StringUtils.crossScriptingFilter() to aSource and adds the result to the generated stream.
void	appendFormatted(java.lang.String aSource, byte aFormat) Applies indicated formatting to specified string and adds result to generated stream.
void	appendParamCSF(java.lang.String aSource) Applies StringUtils.crossScriptingFilter() to tools.getParamValue(aSource) and adds the result to the generated stream.
void	appendProperty(ClipboardProperty aProperty, java.lang.String aStreamSpec, boolean aWantInput) Adds indicated Rule-HTML-Property display for specified property instance to generated stream.
void	appendStream(StringMap aKeys) Adds specified, separately defined, stream to generated stream.
void	appendStream(StringMap aKeys, ParameterPage aParamPage) Adds specified, separately defined, stream to generated stream.
void	appendString(java.lang.String aSource) Adds specified content to generated stream.
void	appendURL(java.lang.String aURL) Adds specified URL to the stream, possibly modified to support the directed-work security requirements.
void	disableInput() Specifies that input is disabled for the remainder of the stream.
ClipboardProperty	getActive() Identifies the current active property.
java.lang.String	getActiveName() Identifies the entry handle for the current active property.
java.lang.String	getActiveValue() Identifies the value of the current active property.
java.lang.String	getCurrentStream() Returns the value of the stream, and cleans up the builder object
java.lang.String	getEntryHandle(java.lang.String aReference) Get an entry handle for a property reference.
java.lang.String	getOpposite(java.lang.String aValue) Identifies the 'opposite' of a specified String value, used when a CheckBox becomes unchecked.
java.lang.String	getParamValueCSF(java.lang.String aSource) Returns the value the specified parameter after applying the cross-site scripting filter.
java.lang.String	getSaveValue(java.lang.String aName) Identifies the value most recently associated with the specified name (by a SAVE directive).
java.lang.String	getTargetName() Identifies the value to use for the NAME attribute of HTML StartTags: the entry handle for a target property or the name of a target parameter.
java.lang.String	getTargetValue() Identifies the value of the current target reference.
boolean	hasEditableEnabled()
boolean	hasInputEnabled() Indicates whether input is enabled for this HTML stream.
boolean	includeShowDeclarativeProperty() Deprecated. use PegaStreamAPI.isShowMeDeclarativeEnabled() instead
boolean	includeShowMe() Deprecated. use PegaStreamAPI.isShowMeInsertEnabled() instead
boolean	includeShowProperty() Deprecated. use PegaStreamAPI.isShowMePropertyEnabled() instead
ClipboardProperty	putActive(ClipboardProperty aNewActive) Establishes the specified instance as the new active property.
void	putSaveValue(java.lang.String aName, java.lang.String aValue) Establishes an association between the specified value and the specified name.
void	putTarget(java.lang.Object aTarget) Establishes or clears the target reference.
java.lang.String	returnFormatted(java.lang.String aSource, byte aFormat) Used by tag library implementations to format a reference string using the format specified by the input paramter.
void	setEditable(boolean bEditable)
void	setInput(boolean aInput) Sets the input for the remainder of the stream
void	setShowProperty(boolean aValue) Deprecated. use PegaStreamAPI.enableShowMeProperty(boolean) instead
java.lang.String	thisSubscript()
boolean	useModeInput() Indicates whether the input-mode display has been requested for the active property and is appropriate.

Methods inherited from interface com.pega.pegarules.pub.runtime.PublicAPI

applyCollection, applyModel, applyModel, checkCachingHeaders, closeHTMLDoc, createPage, doAction, doActivity, editInput, editValidate, entryHandle2Reference, eTagMatches, evaluateWhen, findPage, findPage, findPage, findPage, findPageByHandle, findPageWithException, formatMessage, generateAgentDataPage, getActivityClassName, getActivityStatus, getAgentUtils, getAliasValue, getAliasValue, getAliasValue, getAuthorizationHandle, getCSRFSessionToken, getDatabase, getDateTimeUtils, getDictionary, getEFormUtils, getIfPresent, getImplementation, getInfEngUtils, getLocalizedText, getLocalizedTextForParameterizedString, getLocalizedTextForString, getLocalizedTextForString, getLocalizedTextForString, getLocalizedTextForString, getMetadata, getObfuscationKey, getPAL, getParamAsBigDecimal, getParamAsBoolean, getParamAsDate, getParamAsDouble, getParamAsInteger, getParamCSF, getParameterPage, getParamValue, getParseState, getParseState, getParseUtils, getPDFUtils, getPRCrypto, getPrimaryPage, getProperty, getRequestor, getRuleMessage, getRuleMessage, getRuleSecurityMode, getServiceUtils, getStackFrame, getStepPage, getStepStatus, getStream, getStream, getStructuredUtils, getSystemSettings, getThread, getTracerUserWatchList, getXMLUtils, hasIfNoneMatch, hasImplicitPrivilege, hasImplicitPrivilege, interpretBoolean, isAsciiEncodable, isCSRFMitigationEnabled, isFirstActivity, isNotModifiedSet, isValidDataPage, openHTMLDoc, preventStaleHTTPRequestProcessing, putParamValue, putParamValue, putParamValue, putParamValue, putParamValue, putParamValue, putParamValue, putParamValue, putParamValue, putParamValue, putParamValue, putParamValue, putParamValue, putParamValue, putParamValue, putParamValue, putParamValue, putParamValue, putParamValue, removeDataPage, removeDataPage, resetNotModified, sendFile, sendFile, sendFile, sendFile, sendFile, sendHTTPRedirect, setCachingHeaders, setETag, setNotModified, setNotModified

Property Detail

includeShow

Indicates whether old-style 'Show-Property' mode is currently enabled.

Returns:

true when 'Show-Property' mode is enabled

includeShowDeclarative

Indicates whether the old-style 'Show-DeclarativeProperty' mode is currently enabled.

Returns:

true when 'Show-Property' mode is enabled

Field Detail

VERSION

static final java.lang.String VERSION

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

Method Detail

appendString

void appendString(java.lang.String aSource)

Adds specified content to generated stream.

Parameters:

aSource - content to add to stream

appendFormatted

void appendFormatted(java.lang.String aSource,
                   byte aFormat)

Applies indicated formatting to specified string and adds result to generated stream.

Parameters:

aSource - string to be formatted

aFormat - indicates desired formatting, must be one of:

• StreamBuilder.FMT_LITERAL
• StreamBuilder.FMT_NORMAL
• StreamBuilder.FMT_STREAM
• StreamBuilder.FMT_BLOCK
• StreamBuilder.FMT_TEXT

appendCSF

void appendCSF(java.lang.String aSource)

Applies StringUtils.crossScriptingFilter() to aSource and adds the result to the generated stream.

Parameters:

aSource - string to be filtered

appendParamCSF

void appendParamCSF(java.lang.String aSource)

Applies StringUtils.crossScriptingFilter() to tools.getParamValue(aSource) and adds the result to the generated stream.

Parameters:

aSource - name of parameter whose value is to be filtered

appendStream

void appendStream(StringMap aKeys)

Adds specified, separately defined, stream to generated stream.

Parameters:

aKeys - identifies stream definition to add.

appendStream

void appendStream(StringMap aKeys,
                ParameterPage aParamPage)

Adds specified, separately defined, stream to generated stream.

Parameters:

aKeys - identifies stream definition to add.

aParamPage - new parameter page to use during execution

appendProperty

void appendProperty(ClipboardProperty aProperty,
                  java.lang.String aStreamSpec,
                  boolean aWantInput)

Adds indicated Rule-HTML-Property display for specified property instance to generated stream.

Parameters:

aProperty - property instance to be displayed

aStreamSpec - optional Rule-HTML-Property specification. The instance identified by the corresponding Rule-Obj-Property instance is used if not explicitly overridden here.

aWantInput - identifies whether the $MODE-INPUT form of the display is requested

appendURL

void appendURL(java.lang.String aURL)

Adds specified URL to the stream, possibly modified to support the directed-work security requirements.

Parameters:

aURL - the URL

putActive

ClipboardProperty putActive(ClipboardProperty aNewActive)

Establishes the specified instance as the new active property.

Parameters:

aNewActive - new active property

Returns:

previous active property

getActive

ClipboardProperty getActive()

Identifies the current active property.

Returns:

current active property

getActiveName

java.lang.String getActiveName()

Identifies the entry handle for the current active property.

Returns:

entry handle for the current active property

getActiveValue

java.lang.String getActiveValue()

Identifies the value of the current active property.

Returns:

the value of the current active property

getCurrentStream

java.lang.String getCurrentStream()

Returns the value of the stream, and cleans up the builder object

Returns:

current value of stream

getParamValueCSF

java.lang.String getParamValueCSF(java.lang.String aSource)

Returns the value the specified parameter after applying the cross-site scripting filter.

Parameters:

aSource - name of parameter to return

Returns:

cross-site filtered value

putTarget

void putTarget(java.lang.Object aTarget)

Establishes or clears the target reference. A non-null target may not be specified when the current target is non-null.

Parameters:

aTarget - target reference; must be one of:

• ClipboardProperty instance -- the target property; must be scalar
• String instance -- name of the target parameter
• null -- clear the target reference

getTargetName

java.lang.String getTargetName()

Identifies the value to use for the NAME attribute of HTML StartTags: the entry handle for a target property or the name of a target parameter.

Returns:

HTML name-attribute value for current target

getTargetValue

java.lang.String getTargetValue()

Identifies the value of the current target reference.

Returns:

the value of the current target reference

putSaveValue

void putSaveValue(java.lang.String aName,
                java.lang.String aValue)

Establishes an association between the specified value and the specified name. 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

hasEditableEnabled

boolean hasEditableEnabled()

setEditable

void setEditable(boolean bEditable)

getSaveValue

java.lang.String getSaveValue(java.lang.String aName)

Identifies the value most recently associated with the specified name (by a SAVE directive).

Parameters:

aName - name whose associated value is desired

Returns:

the value associated with this name, or an empty String if no association has been made for this name

hasInputEnabled

boolean hasInputEnabled()

Indicates whether input is enabled for this HTML stream. Input is never enabled for Corr or XML streams.

Returns:

true when input is enabled for this stream

disableInput

void disableInput()

Specifies that input is disabled for the remainder of the stream.

setInput

void setInput(boolean aInput)

Sets the input for the remainder of the stream

Parameters:

aInput -

useModeInput

boolean useModeInput()

Indicates whether the input-mode display has been requested for the active property and is appropriate.

Returns:

true when the input-mode display has been requested

includeShowMe

boolean includeShowMe()

Deprecated. use PegaStreamAPI.isShowMeInsertEnabled() instead

Indicates whether old-style 'Show-Me' mode is currently enabled.

Returns:

true when 'Show-Me' mode is enabled

includeShowProperty

boolean includeShowProperty()

Deprecated. use PegaStreamAPI.isShowMePropertyEnabled() instead

Indicates whether old-style 'Show-Property' mode is currently enabled.

Returns:

true when 'Show-Property' mode is enabled

setShowProperty

void setShowProperty(boolean aValue)

Deprecated. use PegaStreamAPI.enableShowMeProperty(boolean) instead

Toggles the old-style 'Show-Property' mode flag to desired value

Parameters:

aValue - true or false value of the 'Show-Property' flag.

includeShowDeclarativeProperty

boolean includeShowDeclarativeProperty()

Deprecated. use PegaStreamAPI.isShowMeDeclarativeEnabled() instead

Indicates whether the old-style 'Show-DeclarativeProperty' mode is currently enabled.

Returns:

true when 'Show-Property' mode is enabled

getOpposite

java.lang.String getOpposite(java.lang.String aValue)

Identifies the 'opposite' of a specified String value, used when a CheckBox becomes unchecked.

Parameters:

aValue - value of a type=checkbox input tag

Returns:

suggested value to represent an unchecked box

returnFormatted

java.lang.String returnFormatted(java.lang.String aSource,
                               byte aFormat)

Used by tag library implementations to format a reference string using the format specified by the input paramter. This should not modify the current stream as tag libraries do not modify the stream directly *

Parameters:

aSource - the string to format

aFormat - the format

Returns:

the formatted string

thisSubscript

java.lang.String thisSubscript()

getEntryHandle

java.lang.String getEntryHandle(java.lang.String aReference)

Get an entry handle for a property reference. Symbolic subscripts like will be converted to [append].

Parameters:

aReference -

Returns:

String The entry handle