com.bea.wsrp.consumer.management.book
Interface ProxyBookManager

All Superinterfaces

ProxyResourceManager

public interface ProxyBookManager
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

ProxyBookManager.Factory A ProxyPageManager factory.

Method Summary

int	createProxyBook(ProxyResourceContext proxyResourceContext, String producerHandle, IBookDescription bookDescription, List<IPortletDescription> offeredPortlets, Locale locale, javax.servlet.http.HttpServletRequest httpRequest, String webAppName, String defaultLayout, String defaultMenu) Creates a proxy page.
SortableFilterablePagedResult<ProxyBook>	getProxyBooks(ProxyResourceContext proxyResourceContext, ProxyResourceSearchCriteria proxyResourceSearchCriteria, javax.servlet.http.HttpServletRequest httpRequest, String producerHandle, int pageSize) Returns a SortableFilterablePagedResult of ProxyBooks being used from a given producer, without delegated administration (DA) checks.
SortableFilterablePagedResult<ProxyBook>	getProxyBooksForProducer(ProxyResourceContext proxyResourceContext, ProxyResourceSearchCriteria proxyResourceSearchCriteria, javax.servlet.http.HttpServletRequest httpRequest, String producerHandle, int pageSize) Returns a SortableFilterablePagedResult of ProxyBooks 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

createProxyBook

int createProxyBook(ProxyResourceContext proxyResourceContext,
                    String producerHandle,
                    IBookDescription bookDescription,
                    List<IPortletDescription> offeredPortlets,
                    Locale locale,
                    javax.servlet.http.HttpServletRequest httpRequest,
                    String webAppName,
                    String defaultLayout,
                    String defaultMenu)
                    throws IllegalArgumentException,
                           ProxyBookManagerException

Creates a proxy page.

Parameters

proxyResourceContext -

producerHandle - producer handle

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

ProxyBookManagerException - thrown when a general error is encountered

getProxyBooks

SortableFilterablePagedResult<ProxyBook> getProxyBooks(ProxyResourceContext proxyResourceContext,
                                                       ProxyResourceSearchCriteria proxyResourceSearchCriteria,
                                                       javax.servlet.http.HttpServletRequest httpRequest,
                                                       String producerHandle,
                                                       int pageSize)
                                                       throws ProxyBookManagerException

Returns a SortableFilterablePagedResult of ProxyBooks being used from a given producer, without delegated administration (DA) checks. See the getProxyBooksForProducer() method if DA needs to be applied to the returned list.

Parameters

proxyResourceContext -

proxyResourceSearchCriteria -

httpRequest -

producerHandle - handle of the producer

pageSize -

Returns

List of ProxyBooks

Throws

ProxyBookManagerException - thrown when a general error is encountered

getProxyBooksForProducer

SortableFilterablePagedResult<ProxyBook> getProxyBooksForProducer(ProxyResourceContext proxyResourceContext,
                                                                  ProxyResourceSearchCriteria proxyResourceSearchCriteria,
                                                                  javax.servlet.http.HttpServletRequest httpRequest,
                                                                  String producerHandle,
                                                                  int pageSize)
                                                                  throws ProxyBookManagerException

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

Parameters

proxyResourceContext -

proxyResourceSearchCriteria -

httpRequest -

producerHandle - handle of the producer

pageSize -

Returns

List of ProxyBooks

Throws

ProxyBookManagerException - thrown when a general error is encountered