FederatingPortletInvoker - JBOSS Portal 2.6 API 英文版文档

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.portal.federation
Interface FederatingPortletInvoker

All Superinterfaces:: PortletInvoker

All Known Implementing Classes:: FederatingPortletInvokerService

public interface FederatingPortletInvoker
extends PortletInvoker

A portlet invoker that federates other invokers.

Since:: 2.4
Version:: $Revision: 5448 $
Author:: Julien Viet

Method Summary

FederatedPortletInvoker getFederatedInvoker(java.lang.String id)
          Return a portlet invoker registered or null if not found

java.util.Collection getFederatedInvokers()
          Return the registered portlet invokers.

void registerInvoker(PortletInvokerRegistration registration)
          Register an invoker.

void unregisterInvoker(PortletInvokerRegistration registration)
          Unregister an invoker.

Methods inherited from interface org.jboss.portal.portlet.PortletInvoker

createClone, destroyClones, getPortlet, getPortlets, getProperties, getProperties, invoke, setProperties

Method Detail

registerInvoker

public void registerInvoker(PortletInvokerRegistration registration)
                     throws java.lang.IllegalArgumentException

Parameters:: registration - the invoker to register
Throws:: java.lang.IllegalArgumentException - if the invoker is null or already registered

unregisterInvoker

public void unregisterInvoker(PortletInvokerRegistration registration)
                       throws java.lang.IllegalArgumentException

Unregister an invoker.

Parameters:: registration - the invoker to register
Throws:: java.lang.IllegalArgumentException - if the invoker is null or already registered

getFederatedInvoker

public FederatedPortletInvoker getFederatedInvoker(java.lang.String id)
                                            throws java.lang.IllegalArgumentException

Return a portlet invoker registered or null if not found

Parameters:: id - the id
Returns:: the invoker
Throws:: java.lang.IllegalArgumentException - if the id is null

getFederatedInvokers

public java.util.Collection getFederatedInvokers()

Return the registered portlet invokers.

Returns:: a collection that contains the portlet invokers