Class CaseFilter

    • Method Detail

      • hasAndAll

        public final boolean hasAndAll()
        For responses, this returns true if the service returned a value for the AndAll property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • andAll

        public final List<CaseFilter> andAll()

        Provides "and all" filtering.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAndAll() method.

        Returns:
        Provides "and all" filtering.
      • field

        public final FieldFilter field()

        A list of fields to filter on.

        Returns:
        A list of fields to filter on.
      • not

        public final CaseFilter not()
        Returns the value of the Not property for this object.
        Returns:
        The value of the Not property for this object.
      • hasOrAll

        public final boolean hasOrAll()
        For responses, this returns true if the service returned a value for the OrAll property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • orAll

        public final List<CaseFilter> orAll()

        Provides "or all" filtering.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOrAll() method.

        Returns:
        Provides "or all" filtering.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)
      • fromAndAll

        public static CaseFilter fromAndAll​(List<CaseFilter> andAll)
        Create an instance of this class with andAll() initialized to the given value.

        Provides "and all" filtering.

        Parameters:
        andAll - Provides "and all" filtering.
      • fromField

        public static CaseFilter fromField​(FieldFilter field)
        Create an instance of this class with field() initialized to the given value.

        A list of fields to filter on.

        Parameters:
        field - A list of fields to filter on.
      • fromField

        public static CaseFilter fromField​(Consumer<FieldFilter.Builder> field)
        Create an instance of this class with field() initialized to the given value.

        A list of fields to filter on.

        Parameters:
        field - A list of fields to filter on.
      • fromNot

        public static CaseFilter fromNot​(CaseFilter not)
        Create an instance of this class with not() initialized to the given value. Sets the value of the Not property for this object.
        Parameters:
        not - The new value for the Not property for this object.
      • fromNot

        public static CaseFilter fromNot​(Consumer<CaseFilter.Builder> not)
        Create an instance of this class with not() initialized to the given value. Sets the value of the Not property for this object.
        Parameters:
        not - The new value for the Not property for this object.
      • fromOrAll

        public static CaseFilter fromOrAll​(List<CaseFilter> orAll)
        Create an instance of this class with orAll() initialized to the given value.

        Provides "or all" filtering.

        Parameters:
        orAll - Provides "or all" filtering.
      • type

        public CaseFilter.Type type()
        Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be CaseFilter.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be CaseFilter.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.