com.pega.pegarules.pub.generator

Interface PageDescriptor

public interface PageDescriptor

The PageDescriptor interface identifies the information that is known about a ClipboardPage during First-Use Assembly processing.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PageDescriptor.PrimaryAssemblyPageReliability

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static char	MATCH_EXACT Useful constant to indicate that a given page name EXACTLY matched an entry in pages and classes.
static char	MATCH_NOT_FOUND Useful constant to indicate that no match was found in pages and classes for the page name.
static char	MATCH_PREFIX Useful constant to indicate that an entry in pages and classes STARTS with the given page name.
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClassName() Returns the best information about the class of this page that is known during First-Use Assembly.
int	getMatchSegments() Returns the number of segments of a reference that were matched during Pages and Classes lookup
char	getMatchType() Returns the match type of the page name found in the Page and Classes tab.
java.lang.String	getPageName() Returns the name if this page, if it is known during First-Use Assembly.
PageDescriptor.PrimaryAssemblyPageReliability	getPrimaryPageValueReliability()
java.lang.String	getScopeName()
boolean	isExactClass() Indicates whether the value returned by getClassName() is the actual class of this page, or only a defined constraint on its class.
boolean	isParameter() Indicates whether the page is defined as a "parameter" to the Rule rather than being an explicit page reference.
boolean	isPrimaryPageForAssembly()
boolean	isScopedStep()
boolean	setClass(java.lang.String aClassName, boolean aIsExact)
void	setIsExactClass(boolean aIsExact)
void	setMatchData(char aMatchType, int aMatchSegments)
void	setPrimaryPageForAssembly(boolean aIsPrimaryStepPageForAssembly, PageDescriptor.PrimaryAssemblyPageReliability aReliability)

Field Detail

VERSION

static final java.lang.String VERSION

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

MATCH_NOT_FOUND

static final char MATCH_NOT_FOUND

Useful constant to indicate that no match was found in pages and classes for the page name.

See Also:

Constant Field Values

MATCH_PREFIX

static final char MATCH_PREFIX

Useful constant to indicate that an entry in pages and classes STARTS with the given page name.

See Also:

Constant Field Values

MATCH_EXACT

static final char MATCH_EXACT

Useful constant to indicate that a given page name EXACTLY matched an entry in pages and classes.

See Also:

Constant Field Values

Method Detail

getPageName

java.lang.String getPageName()

Returns the name if this page, if it is known during First-Use Assembly.

Returns:

name of this page, if it is known, or an empty String if this page is anonymous (including embedded pages), or null if no information about the class of this page is available.

getClassName

java.lang.String getClassName()

Returns the best information about the class of this page that is known during First-Use Assembly.

Returns:

actual or declared class of this page, or an empty String if this page is classless, or null if no information about the class of this page is available.

isExactClass

boolean isExactClass()

Indicates whether the value returned by getClassName() is the actual class of this page, or only a defined constraint on its class.

Returns:

true if the class of this page should match the value returned by getClassName; false if the class of this page should derive from, but might not match, the value returned by getClassName, or if getClassName returns null.

isParameter

boolean isParameter()

Indicates whether the page is defined as a "parameter" to the Rule rather than being an explicit page reference.

Returns:

true if page is referenced in the Rule's parameter list.

getMatchType

char getMatchType()

Returns the match type of the page name found in the Page and Classes tab.

Returns:

char Allowed values are: FUAPagesAndClassesHelper.MATCH_NOT_FOUND FUAPagesAndClassesHelper.MATCH_EXACT FUAPagesAndClassesHelper.MATCH_PREFIX

getMatchSegments

int getMatchSegments()

Returns the number of segments of a reference that were matched during Pages and Classes lookup

Returns:

number of segments

getScopeName

java.lang.String getScopeName()

isScopedStep

boolean isScopedStep()

setClass

boolean setClass(java.lang.String aClassName,
                 boolean aIsExact)

setIsExactClass

void setIsExactClass(boolean aIsExact)

setMatchData

void setMatchData(char aMatchType,
                  int aMatchSegments)

isPrimaryPageForAssembly

boolean isPrimaryPageForAssembly()

getPrimaryPageValueReliability

PageDescriptor.PrimaryAssemblyPageReliability getPrimaryPageValueReliability()

setPrimaryPageForAssembly

void setPrimaryPageForAssembly(boolean aIsPrimaryStepPageForAssembly,
                               PageDescriptor.PrimaryAssemblyPageReliability aReliability)