com.pega.pegarules.pub.context

Interface PageDirectory

All Known Subinterfaces:

PRNode, PRRequestor, PRThread

public interface PageDirectory

The PageDirectory interface provides methods to associate ClipboardPage instances with a name and to sever that association. To maintain consistency with internal data members of ClipboardPage instances, page names should be modified only via methods in the page instance.

Implemented by PRThread and PRReqeustor.

Version:

$Revision: 130399 $ $Date: 2015-04-03 02:22:47 -0400 (Fri, 03 Apr 2015) $

Author:

Kenneth Olson

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static int	SCOPE_NODE constant to indicate Node-scope
static int	SCOPE_REQUESTOR constant to indicate Requestor-scope
static int	SCOPE_THREAD constant to indicate Thread-scope
static java.lang.String	VERSION

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	findName(ClipboardPage aPage) Returns the name of the specified page.
java.util.Set<java.lang.String>	getDeclarativePageNames() Returns all Data pages in the directory.
ClipboardPage	getPage(java.lang.String aName) Returns the page with the specified name.
ClipboardPage	getPage(java.lang.String aName, ParameterPage aParameterPage) Returns the page with the specified name and parameters.
ClipboardPage	getPage(java.lang.String aName, ParameterPage aParameterPage, boolean aCreateIfMissing)
java.util.Set	getPageNames() Returns the set of top-level page names defined in this directory.
int	getScope() Returns the scope of the implementor of PageDirectory
boolean	pageExists(java.lang.String aName) Checks if a page with the given name exists.
boolean	pageExists(java.lang.String aName, ParameterPage aParameterPage) Checks if a page with the given name exists.
boolean	removeDeclarativePage(java.lang.String aPageToBeFlushed) Removes the given data page instance from memory.
boolean	removePage(ClipboardPage aPage) Removes the association between the specified ClipboardPage and any name it has been given.
boolean	removePage(java.lang.String aName) Removes the association between the specified name and the ClipboardPage.
boolean	removePage(java.lang.String aName, ParameterPage aParameterPage) Removes the association between the specified name and the ClipboardPage.
boolean	renamePage(ClipboardPage aPage, java.lang.String aName) Renames the page to the specified new name.

Field Detail

VERSION

static final java.lang.String VERSION

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

SCOPE_NODE

static final int SCOPE_NODE

constant to indicate Node-scope

See Also:

Constant Field Values

SCOPE_REQUESTOR

static final int SCOPE_REQUESTOR

constant to indicate Requestor-scope

See Also:

Constant Field Values

SCOPE_THREAD

static final int SCOPE_THREAD

constant to indicate Thread-scope

See Also:

Constant Field Values

Method Detail

findName

java.lang.String findName(ClipboardPage aPage)

Returns the name of the specified page. aPage ClipboardPage whose name is to be retrieved String specifying page name, or an empty string if no name assigned

Parameters:

aPage -

Returns:

name

getPage

ClipboardPage getPage(java.lang.String aName)

Returns the page with the specified name. If no such page exists, creates a new empty page. The attempt to look up the page is made in circular manner at various scopes. For e.g. If the api is called from Thread scope page would looked up at following scopes thread -->(threadfamily)-->requestor-->node If the api is called from Requestor scope page would looked up at following scopes (threadfamily)-->requestor-->node-->thread. Thread family scope would only be looked up if threadfamily is enabled.

Parameters:

aName - String name of page, if null or blank, a new page is always created.

Returns:

ClipboardPage instance

getPage

ClipboardPage getPage(java.lang.String aName,
                    ParameterPage aParameterPage)

Returns the page with the specified name and parameters. If no such page exists, creates a new empty page. The attempt to look up the page is made in circular manner at various scopes. For e.g. If the api is called from Thread scope page would looked up at following scopes thread -->(threadfamily)-->requestor-->node If the api is called from Requestor scope page would looked up at following scopes (threadfamily)-->requestor-->node-->thread. Thread family scope would only be looked up if threadfamily is enabled.

Parameters:

aName - String name of page, if null or blank, a new page is always created.

aParameterPage - parameters to be passed to page, can be null

Returns:

ClipboardPage instance

getPage

ClipboardPage getPage(java.lang.String aName,
                    ParameterPage aParameterPage,
                    boolean aCreateIfMissing)

getScope

int getScope()

Returns the scope of the implementor of PageDirectory

Returns:

One of SCOPE_NODE, SCOPE_REQUESTOR, SCOPE_THREAD

getPageNames

java.util.Set getPageNames()

Returns the set of top-level page names defined in this directory.

Returns:

set of top-level page names

pageExists

boolean pageExists(java.lang.String aName)

Checks if a page with the given name exists.

Parameters:

aName -

Returns:

true if the page exists, false otherwise

pageExists

boolean pageExists(java.lang.String aName,
                 ParameterPage aParameterPage)

Checks if a page with the given name exists.

Parameters:

aName -

aParameterPage -

Returns:

true if the page exists, false otherwise

removePage

boolean removePage(java.lang.String aName)

Removes the association between the specified name and the ClipboardPage.

Parameters:

aName - String name of page to remove

Returns:

true if successful

removePage

boolean removePage(java.lang.String aName,
                 ParameterPage aParameterPage)

Removes the association between the specified name and the ClipboardPage.

Parameters:

aName - String name of page to remove

aParameterPage - Parameter when the page being removed is a data page.

Returns:

true if successful

removePage

boolean removePage(ClipboardPage aPage)

Removes the association between the specified ClipboardPage and any name it has been given.

Parameters:

aPage - ClipboardPage to remove

Returns:

true if successful

renamePage

boolean renamePage(ClipboardPage aPage,
                 java.lang.String aName)

Renames the page to the specified new name. If the name is in use by another page, that page becomes unnamed.

Parameters:

aPage - ClipboardPage to be renamed

aName - String with new name

Returns:

true if successful

getDeclarativePageNames

java.util.Set<java.lang.String> getDeclarativePageNames()

Returns all Data pages in the directory. This will include both Readonly as well as Editable data pages.

Returns:

A set of datapage names. Will be empty set if there are no data pages in the directory

removeDeclarativePage

boolean removeDeclarativePage(java.lang.String aPageToBeFlushed)

Removes the given data page instance from memory. You can pass a decorated name or definition name. If the definition name is passed then parameters are assumed to be present in the execution stack. If there are no parameters in the stack, then it will assume null parameters.
The page is also removed from async cache.
For Node level pages, a pulse entry is recorded.

Parameters:

aPageToBeFlushed - A decorated page name or just definition name.

Returns:

true if data page instance is found and removed.