Interface ICommonFilterDescriptor


  • public interface ICommonFilterDescriptor
    Provides information about a commonFilter extension.
    Since:
    3.2
    Restriction:
    This interface is not intended to be implemented by clients.
    Restriction:
    This interface is not intended to be extended by clients.
    • Method Detail

      • getId

        String getId()
        Returns:
        An identifier used to determine whether the filter is visible.
      • getName

        String getName()
        Returns:
        A translated name to identify the filter
      • getDescription

        String getDescription()
        Returns:
        A translated description to explain to the user what the defined filter will hide from the view.
      • isActiveByDefault

        boolean isActiveByDefault()
        Returns:
        Indicates the filter should be in an "Active" state by default.