com.webmethods.portal.mech.storage.page

Interface IPortletHelper

public interface IPortletHelper

Field Summary

Fields

Modifier and Type	Field and Description
static String	CUSTOM_ERROR_REPORTER_ALIAS_PROPERTY
static String	PORTLET_PROFILE
static String	PORTLET_PSEUDO
static String	PORTLET_PSEUDO_OLD
static String	RELATION_PSEUDO_PORTLET
static String	XTYPE_SHORTCUT

Method Summary

Modifier and Type	Method and Description
IPortletPropertyListFilter	getConfigurableInstancePropertyFilter(IContext ctx, IURI portlet) Filter for determining the wireable properties of a portlet on a per-user, per-portlet basis.
IPortletPropertyListFilter	getConfigurableInstancePropertyFilter(IContext ctx, IURI portlet, boolean checkAccess) Filter for determining the wireable properties of a portlet on a per-user, per-portlet basis.
IPortletBean	getErrorBean(IContext ctx) Gets the error portlet bean.
IPortletBean	getFullyInitializedBean(IContext ctx, PortletData portlet) Instantiates portlet bean and adds all (user, page, wired, and runtime) properties to it.
IPortletBean	getFullyInitializedBean(IContext ctx, PortletData portlet, List<PortletData> circularWiringStack, boolean resolveWiring)
IPortletBean	getInitializedBean(IContext ctx, PortletData portlet) Instantiates portlet bean and adds all (user, page, and wired) properties to it, except for runtime properties.
IPortletBean	getInitializedBean(IContext ctx, PortletData portlet, boolean resolveWiring)
PageData	getPage()
IPortletBean	getPersonalProfileBean(IContext ctx) Gets the bean for the personal profile portlet.
IPortletBean	getPseudoBean(IContext ctx, IURI target) Gets the pseudo portlet bean for the specified item.
IURI	getPseudoId(IContext ctx, IURI target) Gets the pseudo portlet id for the specified item.
IPortletBean	getTitlebar(IContext ctx, PortletData portlet)
IPortletPropertyListFilter	getWireablePropertyFilter(IContext ctx, IURI portlet) Filter for determining the wireable properties of a portlet on a per-user, per-portlet basis.
IPortletPropertyListFilter	getWireablePropertyFilter(IContext ctx, IURI portlet, boolean checkAccess) Filter for determining the wireable properties of a portlet on a per-user, per-portlet basis.
List<Object>	getWiringDestinationGroupsAndProperties(IContext ctx, IURI portlet) Returns a list of IPortletPropertyInfos to which the specified user can wire.
Map<String,Object>	getWiringPreferences(IContext ctx, IURI portlet)
List<Object>	getWiringSourceGroupsAndProperties(IContext ctx, IURI portlet) Returns a list of IPortletPropertyInfos from which the specified user can wire.
void	initializePageProperties(IContext ctx, IURI portlet, IPortletBean bean) Adds just page properties to the previously instantiated portlet bean.
void	initializePageProperties(IContext ctx, PortletData portlet, IPortletBean bean) Adds just page properties to the previously instantiated portlet bean.
void	initializeRuntimeProperties(IContext ctx, IURI portlet, IPortletBean bean) Adds just runtime properties to the previously instantiated portlet bean.
void	initializeRuntimeProperties(IContext ctx, PortletData portlet, IPortletBean bean) Adds just runtime properties to the previously instantiated portlet bean.
void	initializeUserProperties(IContext ctx, IURI portlet, IPortletBean bean) Adds just user properties to the previously instantiated portlet bean.
void	initializeUserProperties(IContext ctx, PortletData portlet, IPortletBean bean) Adds just user properties to the previously instantiated portlet bean.
void	initializeWiredProperties(IContext ctx, IURI portlet, IPortletBean bean, List<PortletData> circularWiringStack) Adds just wired properties to the previously instantiated portlet bean.
void	initializeWiredProperties(IContext ctx, PortletData portlet, IPortletBean bean, List<PortletData> circularWiringStack) Adds just wired properties to the previously instantiated portlet bean.
IPortletBean	instantiateBean(IContext ctx, IURI portlet) Instantiates the bean for the specified portlet without user, page, wired, or runtime properties.
IPortletBean	instantiateBean(IContext ctx, PortletData portlet) Instantiates the bean for the specified portlet without user, page, wired, or runtime properties.
void	printJSON(IContext ctx, IURI portlet, Writer out) Deprecated. use PortalJSONSerializer Print out the JSON for the specified portlet, like the following: name:'Stewie', description:'A folder', type:'folder', uri:'/meta/default/folder/00001234'
void	printMap(IContext ctx, Map<String,Object> propertyMap, Writer out) Deprecated. use JSUtils#jsonProperties(Appendable, Map, Collection, Map) Print out a property map using the JSON property filters, like the following:
Reader	renderContent(IContext ctx, IURI portlet, IPortletBean bean, boolean allowDirectOutput) Renders the specified portlet.
Reader	renderContent(IContext ctx, PortletData portlet, boolean allowDirectOutput) Renders the specified portlet.
void	setPage(PageData page)

Field Detail

XTYPE_SHORTCUT

static final String XTYPE_SHORTCUT

See Also:

Constant Field Values

PORTLET_PSEUDO_OLD

static final String PORTLET_PSEUDO_OLD

See Also:

Constant Field Values

PORTLET_PSEUDO

static final String PORTLET_PSEUDO

See Also:

Constant Field Values

PORTLET_PROFILE

static final String PORTLET_PROFILE

See Also:

Constant Field Values

RELATION_PSEUDO_PORTLET

static final String RELATION_PSEUDO_PORTLET

See Also:

Constant Field Values

CUSTOM_ERROR_REPORTER_ALIAS_PROPERTY

static final String CUSTOM_ERROR_REPORTER_ALIAS_PROPERTY

See Also:

Constant Field Values

Method Detail

instantiateBean

IPortletBean instantiateBean(IContext ctx,
                             IURI portlet)
                      throws PortalException

Instantiates the bean for the specified portlet without user, page, wired, or runtime properties.

Throws:

PortalException

instantiateBean

IPortletBean instantiateBean(IContext ctx,
                             PortletData portlet)
                      throws PortalException

Instantiates the bean for the specified portlet without user, page, wired, or runtime properties.

Throws:

PortalException

initializeUserProperties

void initializeUserProperties(IContext ctx,
                              IURI portlet,
                              IPortletBean bean)
                       throws PortalException

Adds just user properties to the previously instantiated portlet bean.

Throws:

PortalException

initializeUserProperties

void initializeUserProperties(IContext ctx,
                              PortletData portlet,
                              IPortletBean bean)
                       throws PortalException

Adds just user properties to the previously instantiated portlet bean.

Throws:

PortalException

initializePageProperties

void initializePageProperties(IContext ctx,
                              IURI portlet,
                              IPortletBean bean)
                       throws PortalException

Adds just page properties to the previously instantiated portlet bean.

Throws:

PortalException

initializePageProperties

void initializePageProperties(IContext ctx,
                              PortletData portlet,
                              IPortletBean bean)
                       throws PortalException

Adds just page properties to the previously instantiated portlet bean.

Throws:

PortalException

initializeWiredProperties

void initializeWiredProperties(IContext ctx,
                               IURI portlet,
                               IPortletBean bean,
                               List<PortletData> circularWiringStack)
                        throws PortalException

Adds just wired properties to the previously instantiated portlet bean.

Parameters:

circularWiringStack - An array used internally to catch circular wiring. Simply pass in a blank array.

Throws:

PortalException

initializeWiredProperties

void initializeWiredProperties(IContext ctx,
                               PortletData portlet,
                               IPortletBean bean,
                               List<PortletData> circularWiringStack)
                        throws PortalException

Adds just wired properties to the previously instantiated portlet bean.

Parameters:

circularWiringStack - An array used internally to catch circular wiring. Simply pass in a blank array.

Throws:

PortalException

initializeRuntimeProperties

void initializeRuntimeProperties(IContext ctx,
                                 IURI portlet,
                                 IPortletBean bean)
                          throws PortalException

Adds just runtime properties to the previously instantiated portlet bean.

Throws:

PortalException

getWiringPreferences

Map<String,Object> getWiringPreferences(IContext ctx,
                                        IURI portlet)

initializeRuntimeProperties

void initializeRuntimeProperties(IContext ctx,
                                 PortletData portlet,
                                 IPortletBean bean)
                          throws PortalException

Adds just runtime properties to the previously instantiated portlet bean.

Throws:

PortalException

getInitializedBean

IPortletBean getInitializedBean(IContext ctx,
                                PortletData portlet)
                         throws PortalException

Instantiates portlet bean and adds all (user, page, and wired) properties to it, except for runtime properties. This is useful when you want to initialize the portlet bean and manipulate it before rendering it.

Throws:

PortalException

getInitializedBean

IPortletBean getInitializedBean(IContext ctx,
                                PortletData portlet,
                                boolean resolveWiring)
                         throws PortalException

Throws:

PortalException

getFullyInitializedBean

IPortletBean getFullyInitializedBean(IContext ctx,
                                     PortletData portlet)
                              throws PortalException

Instantiates portlet bean and adds all (user, page, wired, and runtime) properties to it.

Throws:

PortalException

getFullyInitializedBean

IPortletBean getFullyInitializedBean(IContext ctx,
                                     PortletData portlet,
                                     List<PortletData> circularWiringStack,
                                     boolean resolveWiring)
                              throws PortalException

Throws:

PortalException

renderContent

Reader renderContent(IContext ctx,
                     PortletData portlet,
                     boolean allowDirectOutput)
              throws PortalException

Renders the specified portlet.

Parameters:

allowDirectOutput - If true, the portlet may render its content directly to the output stream. If the portlet does render directly to the output stream, the returned Reader will be null. Otherwise, the portlet will not render its content directly, and it will return a non-null Reader containing its content.

Throws:

PortalException

renderContent

Reader renderContent(IContext ctx,
                     IURI portlet,
                     IPortletBean bean,
                     boolean allowDirectOutput)
              throws PortalException

Renders the specified portlet.

Parameters:

allowDirectOutput - If true, the portlet may render its content directly to the output stream. If the portlet does render directly to the output stream, the returned Reader will be null. Otherwise, the portlet will not render its content directly, and it will return a non-null Reader containing its content.

Throws:

PortalException

printJSON

void printJSON(IContext ctx,
               IURI portlet,
               Writer out)
        throws PortalException

Deprecated. use PortalJSONSerializer Print out the JSON for the specified portlet, like the following:

 name:'Stewie',
 description:'A folder',
 type:'folder',
 uri:'/meta/default/folder/00001234'
 

Throws:

PortalException

printMap

void printMap(IContext ctx,
              Map<String,Object> propertyMap,
              Writer out)
       throws PortalException

Deprecated. use JSUtils#jsonProperties(Appendable, Map, Collection, Map) Print out a property map using the JSON property filters, like the following:

Throws:

PortalException

getConfigurableInstancePropertyFilter

IPortletPropertyListFilter getConfigurableInstancePropertyFilter(IContext ctx,
                                                                 IURI portlet)
                                                          throws PortalException

Filter for determining the wireable properties of a portlet on a per-user, per-portlet basis. Properties from which the specified user can wire are those that the filter determines aren't hidden; properties to which the specified user can wire are those that the filter determines aren't hidden and aren't read-only.

Throws:

PortalException

getConfigurableInstancePropertyFilter

IPortletPropertyListFilter getConfigurableInstancePropertyFilter(IContext ctx,
                                                                 IURI portlet,
                                                                 boolean checkAccess)
                                                          throws PortalException

Filter for determining the wireable properties of a portlet on a per-user, per-portlet basis. Properties from which the specified user can wire are those that the filter determines aren't hidden; properties to which the specified user can wire are those that the filter determines aren't hidden and aren't read-only.

Throws:

PortalException

getWireablePropertyFilter

IPortletPropertyListFilter getWireablePropertyFilter(IContext ctx,
                                                     IURI portlet)
                                              throws PortalException

Filter for determining the wireable properties of a portlet on a per-user, per-portlet basis. Properties from which the specified user can wire are those that the filter determines aren't hidden; properties to which the specified user can wire are those that the filter determines aren't hidden and aren't read-only.

Throws:

PortalException

getWireablePropertyFilter

IPortletPropertyListFilter getWireablePropertyFilter(IContext ctx,
                                                     IURI portlet,
                                                     boolean checkAccess)
                                              throws PortalException

Filter for determining the wireable properties of a portlet on a per-user, per-portlet basis. Properties from which the specified user can wire are those that the filter determines aren't hidden; properties to which the specified user can wire are those that the filter determines aren't hidden and aren't read-only.

Throws:

PortalException

getWiringSourceGroupsAndProperties

List<Object> getWiringSourceGroupsAndProperties(IContext ctx,
                                                IURI portlet)
                                         throws PortalException

Returns a list of IPortletPropertyInfos from which the specified user can wire. Before each group of IPortletPropertyInfos in the returned list is a IPortletPropertyGroupInfo that contains information about the following IPortletPropertyInfo's group. Empty groups are omitted.

An example of the result list follows:

1. IPortletPropertyGroupInfo: Group 1
2. IPortletPropertyInfo: Property A
3. IPortletPropertyInfo: Property B
4. IPortletPropertyGroupInfo: Group 2
5. IPortletPropertyInfo: Property C

Throws:

PortalException

getWiringDestinationGroupsAndProperties

List<Object> getWiringDestinationGroupsAndProperties(IContext ctx,
                                                     IURI portlet)
                                              throws PortalException

Returns a list of IPortletPropertyInfos to which the specified user can wire. Before each group of IPortletPropertyInfos in the returned list is a IPortletPropertyGroupInfo that contains information about the following IPortletPropertyInfo's group. Empty groups are omitted.

An example of the result list follows:

1. IPortletPropertyGroupInfo: Group 1
2. IPortletPropertyInfo: Property A
3. IPortletPropertyInfo: Property B
4. IPortletPropertyGroupInfo: Group 2
5. IPortletPropertyInfo: Property C

Throws:

PortalException

getPersonalProfileBean

IPortletBean getPersonalProfileBean(IContext ctx)
                             throws PortalException

Gets the bean for the personal profile portlet. Returns null if no personal profile portlet is installed in the portal.

Throws:

PortalException

getErrorBean

IPortletBean getErrorBean(IContext ctx)
                   throws PortalException

Gets the error portlet bean.

Throws:

PortalException

getPseudoId

IURI getPseudoId(IContext ctx,
                 IURI target)
          throws PortalException

Gets the pseudo portlet id for the specified item.

Throws:

PortalException

getPseudoBean

IPortletBean getPseudoBean(IContext ctx,
                           IURI target)
                    throws PortalException

Gets the pseudo portlet bean for the specified item.

Throws:

PortalException

getTitlebar

IPortletBean getTitlebar(IContext ctx,
                         PortletData portlet)
                  throws PortalException

Throws:

PortalException

getPage

PageData getPage()

setPage

void setPage(PageData page)