com.bea.wsrp.consumer.management.page
Interface ProxyPageManager

All Superinterfaces

ProxyResourceManager

public interface ProxyPageManager
extends ProxyResourceManager

Manages proxy portlets for one or more producers.

This interface is intended to be implemented only by BEA Weblogic Portal. BEA Systems reserves the right to add abstract methods to this interface without notice. Implementations of this interface by other parties must not be expected to compile without change in future versions of BEA Weblogic Portal.

Nested Class Summary

static class

ProxyPageManager.Factory A ProxyPageManager factory.

Method Summary

int	createProxyPage(ProxyResourceContext proxyResourceContext, String producerHandle, IPageDescription pageDescription, List<IPortletDescription> offeredPortlets, Locale locale, javax.servlet.http.HttpServletRequest httpRequest, String webAppName, String defaultLayout, String defaultMenu) Creates a proxy page.
SortableFilterablePagedResult<ProxyPage>	getProxyPages(ProxyResourceContext proxyResourceContext, ProxyResourceSearchCriteria proxyResourceSearchCriteria, javax.servlet.http.HttpServletRequest httpRequest, String producerHandle, int pageSize) Returns a SortableFilterablePagedResult of ProxyPages being used from a given producer without delegated administration (DA) checks.
SortableFilterablePagedResult<ProxyPage>	getProxyPagesForProducer(ProxyResourceContext proxyResourceContext, ProxyResourceSearchCriteria proxyResourceSearchCriteria, javax.servlet.http.HttpServletRequest httpRequest, String producerHandle, int pageSize) Returns a SortableFilterablePagedResult of ProxyPages being used from a given producer with delegated administration (DA) checks.

Methods inherited from interface com.bea.wsrp.consumer.management.common.ProxyResourceManager

makePrimary

Method Detail

createProxyPage

int createProxyPage(ProxyResourceContext proxyResourceContext,
                    String producerHandle,
                    IPageDescription pageDescription,
                    List<IPortletDescription> offeredPortlets,
                    Locale locale,
                    javax.servlet.http.HttpServletRequest httpRequest,
                    String webAppName,
                    String defaultLayout,
                    String defaultMenu)
                    throws IllegalArgumentException,
                           ProxyPageManagerException

Creates a proxy page.

Result returned from the combination of ProxyResourceAction and ProxyResourceActionScope in ProxyResourceContext

Parameters

proxyResourceContext -

producerHandle - producer handle

pageDescription - page description

webAppName - name of the webapp in which proxy portlets reside

defaultLayout - layout to be used if the layout specified in pageDescription does not exist

defaultMenu - menu to be used if the menu specified in bookDescription does not exist

Returns

portlet definition ID for the proxy portlet

Throws

IllegalArgumentException - thrown when input arguments are not valid is encountered

ProxyPageManagerException - thrown when a general error is encountered

getProxyPages

SortableFilterablePagedResult<ProxyPage> getProxyPages(ProxyResourceContext proxyResourceContext,
                                                       ProxyResourceSearchCriteria proxyResourceSearchCriteria,
                                                       javax.servlet.http.HttpServletRequest httpRequest,
                                                       String producerHandle,
                                                       int pageSize)
                                                       throws ProxyPageManagerException

Returns a SortableFilterablePagedResult of ProxyPages being used from a given producer without delegated administration (DA) checks. If DA needs to be applied to the returned list, see the getProxyPagesForProducer() method.

Parameters

proxyResourceContext -

proxyResourceSearchCriteria -

httpRequest -

producerHandle - handle of the producer

pageSize -

Returns

List of ProxyPages

Throws

ProxyPageManagerException - thrown when a general error is encountered

getProxyPagesForProducer

SortableFilterablePagedResult<ProxyPage> getProxyPagesForProducer(ProxyResourceContext proxyResourceContext,
                                                                  ProxyResourceSearchCriteria proxyResourceSearchCriteria,
                                                                  javax.servlet.http.HttpServletRequest httpRequest,
                                                                  String producerHandle,
                                                                  int pageSize)
                                                                  throws ProxyPageManagerException

Returns a SortableFilterablePagedResult of ProxyPages being used from a given producer with delegated administration (DA) checks.

Parameters

proxyResourceContext -

proxyResourceSearchCriteria -

httpRequest -

producerHandle - handle of the producer

pageSize -

Returns

List of ProxyPages

Throws

ProxyPageManagerException - thrown when a general error is encountered