En option : incluse dans le périmètre, globale
L’API facultative interagit avec un enregistrement unique renvoyé par les API GlideQuery, Stream ou GlideRecord , même lorsqu’il n’existe pas. Écrivez des scripts moins susceptibles d’entraîner une erreur en gérant les résultats de requête nuls ou non définis.
Vous pouvez obtenir un objet facultatif de l’une des manières suivantes :
- Renvoyer un objet facultatif de ces méthodes dans la classe GlideQuery . Pour plus d’informations, consultez GlideQuery.
- Renvoie un objet Optional de la méthode find() dans la classe Stream . Pour plus d’informations sur Stream, consultez l’API Stream .
- Utilisez la méthode lazy() pour générer la valeur de l’option facultative si nécessaire.
Ces méthodes sont statiques et ne nécessitent pas d’instance de la classe :
Vous pouvez utiliser ces méthodes statiques avec n’importe quelle API qui renvoie une valeur unique telle que GlideRecord.
Utilisez l’API en option dans les scripts côté serveur inclus dans le périmètre ou globaux. Cette API nécessite le module d’extension GlideQuery [com.sn_glidequery].
Implémentation
Cette API peut fonctionner avec les API GlideQuery et Stream dans un dans lequel la méthode appelle en chaîne, chaque méthode s’appuyant sur le résultat renvoyé de la méthode précédente. Utilisez des méthodes pour définir les attributs de la requête. Les méthodes ne s’exécutent pas tant que vous n’appelez pas une méthode terminale, une méthode qui renvoie un résultat de requête, vous permettant de définir les exigences de la requête avant de l’exécuter.
Si la requête renvoie un seul enregistrement, le système enveloppe le résultat dans un objet facultatif. Si la requête renvoie un flux d’enregistrements, le système enveloppe le résultat dans un objet Stream. Ces objets vous permettent de gérer le résultat à l’aide d’un ensemble de méthodes dans chaque API.
Par exemple, ce script exécute une requête sur la table Tâche, regroupe les enregistrements par priorité et renvoie chaque priorité ayant un nombre total de réaffectations supérieur à quatre.
var query = new global.GlideQuery('task')
.where('active', true) //Returns new GlideQuery object with a "where" clause.
.groupBy('priority') //Returns new GlideQuery object with a "group by" clause.
.aggregate('sum', 'reassignment_count') //Returns new GlideQuery object with a "sum(reassignment_count)" clause.
.having('sum', 'reassignment_count', '>', 4) //Returns new GlideQuery object with a "having reassignment_count > 4" clause.
.select() //Returns a stream of records wrapped in a Stream object.
.forEach(function (priority){ //Terminal method in the Stream class that executes the query and returns the result.
gs.info("Priority " + priority.group.priority + ": " + priority.sum.reassignment_count + " reassignments");
});Priority 1: 11 reassignments
Priority 3: 6 reassignments
Priority 5: 5 reassignmentsMéthodes de terminal
Pour des raisons de performances, une requête extrait uniquement les données lorsque vous appelez une méthode terminale. Voici les méthodes terminales de la classe Optional :
Facultatif : vide (motif de chaîne)
Renvoie un objet facultatif vide. Utilisez cette méthode dans une clause Else pour gérer une requête susceptible de ne pas renvoyer de résultat.
| Nom | Type | Description |
|---|---|---|
| motif | Chaîne | Facultatif. Raison affichée dans le journal lorsque Optional.get() est appelé sur l’objet facultatif vide. |
| Type | Description |
|---|---|
| Facultatif | Objet utilisé pour interagir avec un enregistrement individuel. |
Cet exemple vous montre comment générer un objet facultatif vide lorsqu’une requête ne renvoie pas de résultat.
var now_GR = new GlideRecord('task');
now_GR.addQuery('approval', 'not requested');
now_GR.query();
var optional;
if (now_GR.next()) {
optional = Optional.of(now_GR.getUniqueValue());
} else {
optional = Optional.empty("no results");
}
gs.info(optional.get());
Sortie :
NiceError: [2020-08-26T23:23:37.402Z]: get() called on empty Optional: no results
Facultatif : filter(prédicat de fonction)
Applique une fonction de prédicat, une fonction qui prend une valeur unique et renvoie vrai ou faux, à l’enregistrement à l’intérieur de l’objet facultatif. Si la fonction renvoie la valeur vrai, la méthode renvoie l’enregistrement facultatif inchangé. Si la fonction renvoie false, elle renvoie un objet facultatif vide.
| Nom | Type | Description |
|---|---|---|
| prédicat | Fonction | Fonction de prédicat à appliquer à la valeur à l’intérieur de l’objet facultatif. Doit renvoyer une valeur booléenne. |
| Type | Description |
|---|---|
| Facultatif | Objet utilisé pour interagir avec un enregistrement individuel. |
Cet exemple vous montre comment appliquer une fonction de filtrage à un résultat facultatif.
var filteredQuery = new global.GlideQuery('sys_user')
.getBy({ sys_id: 'f682abf03710200044e0bfc8bcbe5d38' }, ['phone'])
.filter(function (user) {
return phoneRegex.test(user.phone);
}); Facultatif : flatMap(Fonction fn)
Applique une fonction qui renvoie un objet facultatif au résultat d’une requête. Utilisez cette méthode pour effectuer une deuxième requête à l’aide du résultat de la première.
| Nom | Type | Description |
|---|---|---|
| Fn | Fonction | Fonction à appliquer aux résultats de la requête qui a renvoyé l’objet facultatif. |
| Type | Description |
|---|---|
| Facultatif | Objet utilisé pour interagir avec un enregistrement individuel. |
Cet exemple montre comment exécuter une requête de la table User en fonction du résultat d’une requête précédente.
new global.GlideQuery('alm_asset')
.whereNotNull('owned_by')
.selectOne('owned_by')
.flatMap(function (asset) {
return new global.GlideQuery('sys_user')
.getBy({ sys_id: asset.owned_by }, ['first_name', 'last_name', 'company.name'])
})
.ifPresent(GQ.jsonDebug);
Sortie :
{
"sys_id": "46d59205a9fe198101d603f5de37bfa3",
"first_name": "John",
"last_name": "Bohnhamn",
"company": {
"name": "ACME North America"
}
}
Facultatif : get()
Renvoie l’enregistrement à l’intérieur de l’objet facultatif ou génère une erreur si la requête ne renvoie pas d’enregistrement.
| Nom | Type | Description |
|---|---|---|
| Néant |
| Type | Description |
|---|---|
| N'importe lequel | L’enregistrement à l’intérieur de l’objet facultatif. Si la valeur est nulle ou indéfinie, le système génère une erreur. |
Cet exemple montre comment obtenir la valeur d’un seul enregistrement.
var value = new global.GlideQuery('sys_user')
.selectOne('first_name') //Returns the result of the query inside an Optional object
.get(); //Calls Optional.get() on the Optional object
gs.info(JSON.stringify(value));
Sortie :
{
"first_name":"fred",
"sys_id":"005d500b536073005e0addeeff7b12f4"
}
Facultatif : ifPresent(fonction fn)
Applique une fonction à l’enregistrement dans un objet facultatif. Si l’objet Optional ne contient pas d’enregistrement, la fonction ne s’exécute pas.
| Nom | Type | Description |
|---|---|---|
| Fn | Fonction | Fonction à appliquer à l’enregistrement dans l’objet facultatif. |
| Type | Description |
|---|---|
| Néant |
Cet exemple montre comment imprimer une valeur si elle existe.
var user = new global.GlideQuery('sys_user')
.where('sys_id', 'f682abf03710200044e0bfc8bcbe5d38')
.selectOne('zip')
.ifPresent(function (user) {
gs.info('Zip Code: ' + user.zip);
});
Facultatif : isEmpty()
Renvoie la valeur vrai si l’objet facultatif est vide.
| Nom | Type | Description |
|---|---|---|
| Néant |
| Type | Description |
|---|---|
| Booléen | Marqueur indiquant si le résultat d’une requête contient une valeur. Valeurs valides :
|
Cet exemple montre comment vérifier si le résultat d’une requête est vide.
var checkEmpty = new global.GlideQuery('sys_user')
.where('last_name', 'Barker')
.selectOne()
.isEmpty();
gs.info(checkEmpty);
Sortie :
true
Facultatif : isPresent()
Vérifie si un objet en option contient une valeur.
| Nom | Type | Description |
|---|---|---|
| Néant |
| Type | Description |
|---|---|
| Booléen | Marqueur indiquant si le résultat d’une requête contient une valeur. Valeurs valides :
|
Cet exemple montre comment vérifier si une requête renvoie un résultat.
var checkPresent = new global.GlideQuery('sys_user')
.where('last_name', 'Luddy')
.selectOne('first_name')
.isPresent();
gs.info(checkPresent);
Sortie :
true
Facultatif : paresseux (fonction paresseuseGetFn)
Renvoie un nouvel objet facultatif. Au lieu de contenir l’enregistrement, l’objet contient une fonction permettant d’obtenir l’enregistrement qui n’est appelée que si et quand le code le demande.
Utilisez cette méthode pour retarder l’obtention de la valeur jusqu’à ce qu’elle soit nécessaire. Vous pouvez le faire si vous demandez la valeur à une source lente et que vous ne voulez pas ralentir votre code inutilement. Sinon, vous pouvez renvoyer un objet facultatif à l’aide des API GlideQuery et Stream .
| Nom | Type | Description |
|---|---|---|
| lazyGetFn | Fonction | Fonction qui renvoie un seul enregistrement à la suite d’une requête. Par exemple : |
| Type | Description |
|---|---|
| Facultatif | Objet contenant le résultat de la requête au format facultatif<résultat>. |
Cet exemple montre comment obtenir un objet facultatif en fonction d’une requête GlideRecord.
var userOptional = global.Optional.lazy(function () {
var userGr = new GlideRecord('sys_user');
userGr.setLimit(1);
userGr.query();
return userGr.next() ? userGr.getUniqueValue() : null;
});
gs.info(userOptional);
Sortie :
Optional<005d500b536073005e0addeeff7b12f4>
Facultatif : map(fonction fn)
Applique une fonction au résultat d’une requête.
| Nom | Type | Description |
|---|---|---|
| Fn | Fonction | Fonction à appliquer au résultat de la requête. |
| Type | Description |
|---|---|
| Facultatif | Objet contenant les résultats de la requête mis à jour par la fonction au format Facultatif<result>. |
Cet exemple montre comment appliquer une fonction qui transforme une valeur en majuscules en résultat d’une requête.
var value = new global.GlideQuery('sys_user')
.whereNotNull('first_name')
.selectOne('first_name')
.map(function (user) {
return user.first_name.toUpperCase();
});
gs.info(value);
Sortie :
Optional<ABEL>
Facultatif : de (valeur quelconque)
Entoure une valeur donnée dans un objet facultatif. Par exemple, vous pouvez envelopper le résultat d’une requête GlideRecord dans un objet facultatif pour utiliser les méthodes associées.
| Nom | Type | Description |
|---|---|---|
| valide | N'importe lequel | Valeur à l’intérieur de l’objet Facultatif. |
| Type | Description |
|---|---|
| Facultatif | Objet contenant la valeur transmise au format Optional<value>. |
Cet exemple vous montre comment générer un objet facultatif basé sur une requête GlideRecord.
var now_GR = new GlideRecord('task');
now_GR.addQuery('approval', 'not requested');
now_GR.query();
var optional;
if (now_GR.next()) {
optional = Optional.of(now_GR.getUniqueValue());
} else {
optional = Optional.empty("no results");
}
gs.info(optional.get());
Sortie :
00c269162d761010f87708b56757cbb3
Facultatif : ouElse (toute valeur par défaut)
Ajoute une valeur par défaut dans l’objet facultatif si la requête ne renvoie aucun résultat.
| Nom | Type | Description |
|---|---|---|
| defaultValue | N'importe lequel | Valeur dans l’objet facultatif si la requête ne renvoie aucun résultat. |
| Type | Description |
|---|---|
| N'importe lequel | Valeur dans l’objet facultatif si la requête ne renvoie aucun résultat. |
Cet exemple montre comment renvoyer une valeur, même lorsque la requête est incorrecte.
var user = new global.GlideQuery('sys_user')
.get('1234', ['first_name', 'last_name'])
.orElse({ first_name: 'Default', last_name: 'User' });
gs.info(JSON.stringify(user))
Sortie :
{
"first_name":"Default",
"last_name":"User"
}