API de filtre : Android

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 2 minutes de lecture

    • La classe Filter permet de configurer des filtres qui définissent les données à renvoyer dans les résultats d’une requête de point de terminaison REST.

    Tableau 1. Propriétés
    Nom Type Description
    Éléments de requête Map<chaîne, chaîne> Collection d’éléments de requête représentant le filtre.

    Filtre : Filtre(conditions : List<Condition>, mots-clés : String ? = null, sortBy : List<Sort> ? = null)

    Crée un filtre basé sur des mots clés et des conditions spécifiques qui peuvent être associés à un OU à un ET.

    Tableau 2. Paramètres
    Nom Type Description
    conditions Liste<Condition> Conditions simples ou composées à ajouter à la requête.
    Conditions possibles :
    • BooleanSimpleCondition : conditions disponibles pour les champs d’enregistrement booléens.
    • DateSimpleTimeCondition : conditions disponibles pour les champs d’enregistrement de date et heure.
    • EmailSimpleCondition : conditions disponibles pour les champs d’e-mail.
    • IntegerChoiceSimpleCondition : conditions disponibles pour les champs de choix de nombres entiers.
    • NumericSimpleCondition : conditions disponibles pour différents champs numériques.
    • ReferenceSimpleCondition : opérateurs de condition disponibles pour les champs d’enregistrement de référence.
    • StringChoiceSimpleCondition : opérateurs de condition disponibles pour les champs d’enregistrement de choix contenant des chaînes.
    • StringSimpleCondition : opérateurs de condition disponibles pour les champs d’enregistrement de chaîne.
    • CompoundCondition : vous permet de regrouper des SimpleConditions dans une condition composée à l’aide des connecteurs ConditionUtils.CompoundOperator.
    Mots clés Chaîne Facultatif. N’importe quel mot ou expression spécifique à rechercher.

    Par défaut : nil : pas de recherche de mot spécifique.
    trier par Liste<Trier> Facultatif. Liste des noms de champs d’enregistrement et constante d’ordre de tri associée selon laquelle trier les enregistrements renvoyés. Par exemple : val sortBy = listOf(« zipcode », ORDER_DESC)

    Si vous incluez plusieurs champs de tri, chaque champ suivant est un tri supplémentaire du ou des champs précédents.

    Valeurs de tri valides :
    • ORDER_ASC : Trier par ordre croissant
    • ORDER_DESC : Trier par ordre décroissant

    Valeur par défaut : ORDER_ASC
    Tableau 3. Renvoie
    Type Description
    Néant 

    // Where the record is active 

val condition1 = BooleanSimpleCondition.conditionIs("active", true) 

// AND the date value of the SLA due field is on "today" or any date after today. 

val condition2 = DateSimpleTimeCondition.atOrAfter("sla_due", 0, ConditionUtils.DateTimeValueOperator.daysAgoStart) 

val filter = Filter(conditions = listOf(condition1, condition2))

    Filtre : filtre(criteriaList : List<Criteria>, sortBy : List<Sort> ? = null)

    Crée un filtre basé sur un ou plusieurs critères de filtre qui sont OU ensemble.

    Tableau 4. Paramètres
    Nom Type Description
    Liste de critères Liste<Critères> Conditions de critères de niveau supérieur à regrouper avec des connecteurs OR .
    trier par Liste<Trier> Facultatif. Liste des noms de champs d’enregistrement et constante d’ordre de tri associée selon laquelle trier les enregistrements renvoyés. Par exemple : val sortBy = listOf(« zipcode », ORDER_DESC)

    Si vous incluez plusieurs champs de tri, chaque champ suivant est un tri supplémentaire du ou des champs précédents.

    Valeurs de tri valides :
    • ORDER_ASC : Trier par ordre croissant
    • ORDER_DESC : Trier par ordre décroissant

    Valeur par défaut : ORDER_ASC
    Tableau 5. Renvoie
    Type Description
    Néant 

    val activeIncidents = BooleanSimpleCondition.conditionIs("active", true)
val assignedToEmpty = StringSimpleCondition.isEmpty("assigned_to")
val assignedToAbel = StringSimpleCondition.conditionIs("assigned_to", "Abel Tuter")
val assignedToAbelOrEmpty = CompoundCondition(ConditionUtils.CompoundOperator.OR, listOf(assignedToEmpty, assignedToAbel))
val needToReassign = Criteria().addConditions(listOf(activeIncidents, assignedToAbelOrEmpty))
val highEscelations = StringSimpleCondition.conditionIs("escalation", "2")
val overdueEscelations = StringSimpleCondition.conditionIs("escalation", "3")
val highOrOverdueEscelations = CompoundCondition(ConditionUtils.CompoundOperator.OR, listOf(highEscelations, overdueEscelations))
val needToHandleEscalation = Criteria().addCondition(highOrOverdueEscelations)
val myPrioritiesForTodayFilter = Filter(listOf(needToReassign, needToHandleEscalation))