Package org.exoplatform.webui.ext.filter

Enum Class UIExtensionFilterType

java.lang.Object
java.lang.Enum<UIExtensionFilterType>
org.exoplatform.webui.ext.filter.UIExtensionFilterType
All Implemented Interfaces:
Serializable, Comparable<UIExtensionFilterType>, Constable
public enum UIExtensionFilterType extends Enum<UIExtensionFilterType>
All the existing types of filters Created by The eXo Platform SAS Author : eXoPlatform nicolas.filotto@exoplatform.com 14 mai 2009

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    MANDATORY
    This type of filter will be used to know if the action related to the extension can be launched and to know if the component related to the extension can be added to the webui tree The filter is required to launch the action and to add the component related to the extension to the webui tree.
    OPTIONAL
    This type of filter will only be used to know if the action related to the extension can be launched.
    REQUIRED
    This type of filter will only be used to know if the action related to the extension can be launched.
    REQUISITE
    This type of filter will be used to know if the action related to the extension can be launched.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    acceptOnlyIfOK()
    Indicates if the filter allows to continue if it fails
    boolean
    checkOtherFiltersOnlyIfOK()
    Indicates if the other filters can be checked if it fails
    boolean
    showExtensionOnlyIfOK()
    Indicates if the filter allows to display the extension if it fails
    static UIExtensionFilterType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static UIExtensionFilterType[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • MANDATORY

      public static final UIExtensionFilterType MANDATORY
      This type of filter will be used to know if the action related to the extension can be launched and to know if the component related to the extension can be added to the webui tree The filter is required to launch the action and to add the component related to the extension to the webui tree. If it succeeds, we will check the other filters. If it fails, we will stop.

    • REQUISITE

      public static final UIExtensionFilterType REQUISITE
      This type of filter will be used to know if the action related to the extension can be launched. The filter is required to launch the action. to the webui tree. If it succeeds, we will check the other filters. If it fails, we will stop.

    • REQUIRED

      public static final UIExtensionFilterType REQUIRED
      This type of filter will only be used to know if the action related to the extension can be launched. The filter is required to launch the action. If it succeeds or fails, we will check the other filters. It can be used to add warnings

    • OPTIONAL

      public static final UIExtensionFilterType OPTIONAL
      This type of filter will only be used to know if the action related to the extension can be launched. The filter is not required to launch the action. If it succeeds or fails, we will check the other filters. It can be used for auditing purpose

  • Method Details

    • values

      public static UIExtensionFilterType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static UIExtensionFilterType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • showExtensionOnlyIfOK

      public boolean showExtensionOnlyIfOK()
      Indicates if the filter allows to display the extension if it fails

    • checkOtherFiltersOnlyIfOK

      public boolean checkOtherFiltersOnlyIfOK()
      Indicates if the other filters can be checked if it fails

    • acceptOnlyIfOK

      public boolean acceptOnlyIfOK()
      Indicates if the filter allows to continue if it fails