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: 31 $ $Date: 2009-06-24 09:38:04 -0400 (Wed, 24 Jun 2009) $

Author:

Kenneth Olson

Field Summary

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

java.lang.String	findName(ClipboardPage aPage) Returns the name of the specified page.
ClipboardPage	getPage(java.lang.String aName) Returns the page with the specified name.
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	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	renamePage(ClipboardPage aPage, java.lang.String aName) Renames the page to the specified new name.

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

static final java.lang.String VERSION

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.

Parameters:

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

Returns:

ClipboardPage instance

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

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(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