Oracle Fusion Middleware Java API Reference for Oracle ADF Lifecycle
11g Release 1 (11.1.1.6.0)

E10652-07

oracle.adf.controller.v2.lifecycle
Class PagePhaseListenerManager

java.lang.Object
  extended by oracle.adf.controller.v2.lifecycle.PagePhaseListenerManager
Direct Known Subclasses:
Lifecycle

public abstract class PagePhaseListenerManager
extends java.lang.Object

This abstract class contain the API to manage the list of PagePhaseListener on the ADF Page Lifecycle.

Since:
11.1.1

Constructor Summary
PagePhaseListenerManager()
           
 
Method Summary
abstract  void addPagePhaseListener(PagePhaseListener listener, java.lang.String listenerId, java.util.Set<java.lang.String> beforeIdSet, java.util.Set<java.lang.String> afterIdSet)
          Register a listener at a specific position in the list of listeners to determine which listener will be call first for a particular event.
abstract  PagePhaseListener getPagePhaseListener(java.lang.String listenerId)
          Returns the phase listener given a listener id.
abstract  java.util.List<java.lang.String> getPagePhaseListenerIds()
          Returns the list of listener id for all registered listeners in the order in which they will be executed.
abstract  boolean removePagePhaseListener(java.lang.String listenerId)
          Un-register a listener using its id Return true is the listenerId existed and has been removed successfully.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PagePhaseListenerManager

public PagePhaseListenerManager()
Method Detail

addPagePhaseListener

public abstract void addPagePhaseListener(PagePhaseListener listener,
                                          java.lang.String listenerId,
                                          java.util.Set<java.lang.String> beforeIdSet,
                                          java.util.Set<java.lang.String> afterIdSet)
Register a listener at a specific position in the list of listeners to determine which listener will be call first for a particular event. beforeIdSet and afterIsSet are used to specify when this listener should be invoked.

Parameters:
listener - the instance of the listener to register
listenerId - the id of the listener to register
beforeIdSet - the set of listeners the new listener should be placed before
afterIdSet - the set of listeners the new listener should be placed after

removePagePhaseListener

public abstract boolean removePagePhaseListener(java.lang.String listenerId)
Un-register a listener using its id Return true is the listenerId existed and has been removed successfully.

Parameters:
listenerId - the id of the listener to remove
Returns:
true if the specified listener was registrered.

getPagePhaseListenerIds

public abstract java.util.List<java.lang.String> getPagePhaseListenerIds()
Returns the list of listener id for all registered listeners in the order in which they will be executed.

Returns:
a list of all currently registered listener Id

getPagePhaseListener

public abstract PagePhaseListener getPagePhaseListener(java.lang.String listenerId)
Returns the phase listener given a listener id. If no listener if found with this id, returns null.

Parameters:
listenerId - the id of the listener to retrieve
Returns:
the listener instance

Oracle Fusion Middleware Java API Reference for Oracle ADF Lifecycle
11g Release 1 (11.1.1.6.0)

E10652-07

Copyright © 1997, 2011, Oracle. All rights reserved.