ariba.ui.aribaweb.core
Enum AWComponent.RenderingListener.InterestLevel

java.lang.Object
  extended by java.lang.Enum<AWComponent.RenderingListener.InterestLevel>
      extended by ariba.ui.aribaweb.core.AWComponent.RenderingListener.InterestLevel
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<AWComponent.RenderingListener.InterestLevel>
Enclosing interface:
AWComponent.RenderingListener

public static enum AWComponent.RenderingListener.InterestLevel
extends java.lang.Enum<AWComponent.RenderingListener.InterestLevel>

The APIs return this enum to indicate whether further calls should be made. The common case is that during render we will call componentWillRender which might return NeverInterested if there was no community context for this component. This value should be cached in platform and further calls will not be made for this component. For another component the call might return NotInterested in which case there is not reason to call any later APIS (componentClosingTag or componentFinishedRender) in the context of the rendering of this particular component. Next time this same component is rendered the result might be different. If Interested is returned, then later calls will be made


Enum Constant Summary
Interested
           
NeverInterested
           
NotInterested
           
 
Method Summary
static AWComponent.RenderingListener.InterestLevel valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static AWComponent.RenderingListener.InterestLevel[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NeverInterested

public static final AWComponent.RenderingListener.InterestLevel NeverInterested

NotInterested

public static final AWComponent.RenderingListener.InterestLevel NotInterested

Interested

public static final AWComponent.RenderingListener.InterestLevel Interested
Method Detail

values

public static AWComponent.RenderingListener.InterestLevel[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (AWComponent.RenderingListener.InterestLevel c : AWComponent.RenderingListener.InterestLevel.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static AWComponent.RenderingListener.InterestLevel valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null


AribaWeb User Interface Development Framework
Copyright © 2000-2014 Ariba, Inc. All Rights Reserved.