com.pega.pegarules.pub.simpleurl

Interface SimpleURLAPI

public interface SimpleURLAPI

SimpleURLAPI
This Interface provides API to generate Simple URL as defined in URLMapping.
API differ in criteria they use for choosing URLMapping.
This URLMapping is chosen from a list defined on application's Rule-URLMapppings instance.
Simple URL unless explicitly stated contains only path part of a Absolute URL and leaves out the servlet name as well.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
java.lang.String	getSimpleURLByAlias(java.lang.String aAliasName, ClipboardPage aPage, boolean aAbsolute) Generates Simple URL as described in SimpleURLAPI. Uses aAliasName as criteria to select URLMapping.
java.lang.String	getSimpleURLByClass(ClipboardPage aPage, boolean aAbsolute) Generates Simple URL as described in SimpleURLAPI. Uses pxObjClass of aPage as criteria to select URLMapping.

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

static final java.lang.String VERSION

Method Detail

getSimpleURLByClass

java.lang.String getSimpleURLByClass(ClipboardPage aPage,
                                     boolean aAbsolute)

Generates Simple URL as described in SimpleURLAPI.
Uses pxObjClass of aPage as criteria to select URLMapping.

Parameters:

aPage - should contain properties specified in the URLMapping and properties should have non empty values.

aAbsolute - if equals true, returns absolute form of simple URL.

Returns:

Valid simple URL.
Returns null if

• no URLMapping found for pxObjclass of aPage
• aPage does not contain required properties

getSimpleURLByAlias

java.lang.String getSimpleURLByAlias(java.lang.String aAliasName,
                                     ClipboardPage aPage,
                                     boolean aAbsolute)

Generates Simple URL as described in SimpleURLAPI.
Uses aAliasName as criteria to select URLMapping.

Parameters:

aAliasName -

aPage - should contain properties specified in the URLMapping and properties should have non empty values.

aAbsolute - if equals true, URL will contain all absolute URL components.

Returns:

Valid simple URL.
Returns null if

• no URLMapping found for aAliasName
• aPage does not contain required properties