Package com.uc4.api.objects

Class CustomAttributeFilter

  • public class CustomAttributeFilter
extends java.lang.Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addSelectedValue​(java.lang.String value)
      Adds a selected value to the Filter.
      CustomAttribute getCustomAttribute()
      Returns the Custom Attribute.
      java.lang.String getFilter()
      Returns specified filter.
      boolean isExclude()
      Returns true if exclude is set, false otherwise.
      void removeAllSelectedValues()
      Removes all selected Custom Attributes values.
      boolean removeSelectedValue​(java.lang.String value)
      Removes a selected Custom Attribute value.
      java.util.Iterator<java.lang.String> selectedValuesIterator()
      Returns an java.util.Iterator of selected Custom Attributes values.
      void setExclude​(boolean exclude)
      If set to true the filter values are excluded from the selection.
      void setFilter​(java.lang.String filter)
      Sets filter for the Custom Attribute.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • CustomAttributeFilter

        public CustomAttributeFilter​(CustomAttribute customAttribute)
        Creates a new filter for a specific custom attribute.
        Parameters:
        customAttribute - Custom Attribute

    • Method Detail

      • getCustomAttribute

        public CustomAttribute getCustomAttribute()
        Returns the Custom Attribute.
        Returns:
        Custom Attribute

      • addSelectedValue

        public void addSelectedValue​(java.lang.String value)
        Adds a selected value to the Filter.
        Parameters:
        value - selected value of the Custom Attribute

      • selectedValuesIterator

        public java.util.Iterator<java.lang.String> selectedValuesIterator()
        Returns an java.util.Iterator of selected Custom Attributes values.
        Returns:
        Iterator

      • removeAllSelectedValues

        public void removeAllSelectedValues()
        Removes all selected Custom Attributes values.

      • removeSelectedValue

        public boolean removeSelectedValue​(java.lang.String value)
        Removes a selected Custom Attribute value.
        Parameters:
        value - selected value
        Returns:
        true if the selected value was removed

      • getFilter

        public java.lang.String getFilter()
        Returns specified filter.
        Returns:
        filter

      • setFilter

        public void setFilter​(java.lang.String filter)
        Sets filter for the Custom Attribute.
        Parameters:
        filter - Filter for the Custom Attribute

      • isExclude

        public boolean isExclude()
        Returns true if exclude is set, false otherwise.
        Returns:
        true if exclude is set

      • setExclude

        public void setExclude​(boolean exclude)
        If set to true the filter values are excluded from the selection.
        Parameters:
        exclude - Boolean value to exclude or include the filter values for the selection