Optional: Bereichsbezogen, Global

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 7 Minuten Lesedauer

    • Die Optional Die API interagiert mit einem einzelnen Datensatz, der von zurückgegeben wird GlideQuery , Stream , Oder GlideRecord APIs, auch wenn sie nicht vorhanden sind. Schreiben Sie Skripts, die weniger wahrscheinlich zu einem Fehler führen, indem Sie Null- oder nicht definierte Abfrageergebnisse verarbeiten.

    Sie können einen erhalten Optional Objekt auf folgende Arten:

    Diese Methoden sind statisch und erfordern keine Instanz der Klasse:

    Sie können diese statischen Methoden mit jeder API verwenden, die einen einzelnen Wert zurückgibt, z. B. GlideRecord .

    Verwenden Sie Optional API in bereichsbezogenen oder globalen serverseitigen Skripts. Diese API erfordert das Plugin GlideQuery [com.sn_glidequery].

    Implementierung

    Diese API kann mit funktionieren GlideQuery Und Stream APIs in einem builder-Muster, bei dem die Methode die Kette aufruft, wobei jede Methode auf dem zurückgegebenen Ergebnis der vorherigen Methode aufbaut. Verwenden Sie Methoden, um die Attribute der Abfrage zu definieren. Die Methoden werden erst ausgeführt, wenn Sie eine Terminalmethode aufrufen, eine Methode, die ein Abfrageergebnis zurückgibt, sodass Sie die Anforderungen der Abfrage vor der Ausführung definieren können.

    Wenn die Abfrage einen einzelnen Datensatz zurückgibt, umschließt das System das Ergebnis in ein optionales Objekt. Wenn die Abfrage einen Stream von Datensätzen zurückgibt, umschließt das System das Ergebnis in ein Stream-Objekt. Mit diesen Objekten können Sie das Ergebnis mit einer Reihe von Methoden in jeder API verwalten.

    Zum Beispiel dies Das Skript führt eine Abfrage für die Aufgabentabelle durch, gruppiert die Datensätze nach Priorität und gibt jede Priorität zurück, deren Neuzuweisungen insgesamt größer als vier sind. 

    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");
    });
    Ausgabe:
    Priority 1: 11 reassignments
Priority 3: 6 reassignments
Priority 5: 5 reassignments

    Terminalmethoden

    Aus Leistungsgründen ruft eine Abfrage nur Daten ab, wenn Sie eine Terminalmethode aufrufen. Dies sind die Terminalmethoden aus dem Optional Klasse:

    Optional – leer (Zeichenfolgengrund)

    Gibt ein leeres optionales Objekt zurück. Verwenden Sie diese Methode in einer ELSE-Klausel, um eine Abfrage zu verarbeiten, die möglicherweise kein Ergebnis zurückgibt.

    Hinweis:
    Diese Methode ist statisch. Sie benötigen keine Instanz der Klasse, um diese Methode zu verwenden.
    Tabelle : 1. Parameter
    Name Typ Beschreibung
    reason Zeichenfolge Optional. Grund, der im Protokoll angezeigt wird, wenn Optional.get() Wird für das leere optionale Objekt aufgerufen.
    Tabelle : 2. Rückgaben
    Typ Beschreibung
    Optional Objekt, das zur Interaktion mit einem einzelnen Datensatz verwendet wird.

    Dieses Beispiel zeigt, wie Sie ein leeres optionales Objekt generieren, wenn eine Abfrage kein Ergebnis zurückgibt.

    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());

    Ausgabe:

    NiceError: [2020-08-26T23:23:37.402Z]: get() called on empty Optional: no results

    Optional – Filter(Funktionsprädikat)

    Wendet eine Prädikatfunktion an, eine Funktion, die einen einzelnen Wert verwendet und „wahr“ oder „falsch“ zurückgibt, auf den Datensatz im optionalen Objekt. Wenn die Funktion „wahr“ zurückgibt, gibt die Methode den optionalen Datensatz unverändert zurück. Wenn die Funktion „falsch“ zurückgibt, wird ein leeres optionales Objekt zurückgegeben.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Prädikat Funktion Prädikatfunktion, die auf den Wert im optionalen Objekt angewendet werden soll. Muss einen booleschen Wert zurückgeben.
    Tabelle : 4. Rückgaben
    Typ Beschreibung
    Optional Objekt, das zur Interaktion mit einem einzelnen Datensatz verwendet wird.

    Dieses Beispiel zeigt, wie Sie eine Filterfunktion auf ein optionales Ergebnis anwenden.

    var filteredQuery = new global.GlideQuery('sys_user')
    .getBy({ sys_id: 'f682abf03710200044e0bfc8bcbe5d38' }, ['phone'])
    .filter(function (user) {
        return phoneRegex.test(user.phone);
    });

    Optional – flatMap(Funktion FN)

    Wendet eine Funktion an, die ein optionales Objekt auf das Ergebnis einer Abfrage zurückgibt. Verwenden Sie diese Methode, um eine zweite Abfrage mit dem Ergebnis der ersten durchzuführen.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    fn Funktion Anzuwendende Funktion Zu den Ergebnissen der Abfrage, die das optionale Objekt zurückgegeben hat.
    Tabelle : 6. Rückgaben
    Typ Beschreibung
    Optional Objekt, das zur Interaktion mit einem einzelnen Datensatz verwendet wird.

    Dieses Beispiel zeigt, wie eine Abfrage der Anwendertabelle basierend auf dem Ergebnis einer vorherigen Abfrage ausgeführt wird.

    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);

    Ausgabe:

    {
  "sys_id": "46d59205a9fe198101d603f5de37bfa3",
  "first_name": "John",
  "last_name": "Bohnhamn",
  "company": {
    "name": "ACME North America"
  }
}

    Optional – get()

    Gibt den Datensatz im optionalen Objekt zurück oder löst einen Fehler aus, wenn die Abfrage keinen Datensatz zurückgibt.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    Beliebig Der Datensatz im optionalen Objekt. Wenn der Wert null oder nicht definiert ist, löst das System einen Fehler aus.

    Dieses Beispiel zeigt, wie der Wert eines einzelnen Datensatzes abgerufen wird.

    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));

    Ausgabe:

    {
   "first_name":"fred",
   "sys_id":"005d500b536073005e0addeeff7b12f4"
}

    Optional – ifPresent(function FN)

    Wendet eine Funktion auf den Datensatz in einem optionalen Objekt an. Wenn das optionale Objekt keinen Datensatz enthält, wird die Funktion nicht ausgeführt.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    fn Funktion Die Funktion, die auf den Datensatz im optionalen Objekt angewendet werden soll.
    Tabelle : 10. Rückgaben
    Typ Beschreibung
    Keine

    Dieses Beispiel zeigt, wie ein Wert gedruckt wird, wenn er vorhanden ist.

    var user = new global.GlideQuery('sys_user')
    .where('sys_id', 'f682abf03710200044e0bfc8bcbe5d38')
    .selectOne('zip')
    .ifPresent(function (user) {
      gs.info('Zip Code: ' + user.zip);
    });

    Optional – isEmpty()

    Gibt „wahr“ zurück, wenn das optionale Objekt leer ist.

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 12. Ergebnisse
    Typ Beschreibung
    Boolean

    Kennzeichnung, die angibt, ob das Ergebnis einer Abfrage einen Wert enthält.

    Gültige Werte:
    • Wahr: Die Abfrage gibt null oder nicht definiert zurück.
    • Falsch: Die Abfrage gibt einen Wert zurück.

    Dieses Beispiel zeigt, wie überprüft wird, ob das Ergebnis einer Abfrage leer ist.

    var checkEmpty = new global.GlideQuery('sys_user')
    .where('last_name', 'Barker')
    .selectOne()
    .isEmpty();

gs.info(checkEmpty);

    Ausgabe:

    true

    Optional – isPresent()

    Überprüft, ob ein optionales Objekt einen Wert enthält.

    Tabelle : 13. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 14. Ergebnisse
    Typ Beschreibung
    Boolean

    Kennzeichnung, die angibt, ob das Ergebnis einer Abfrage einen Wert enthält.

    Gültige Werte:
    • Wahr: Die Abfrage gibt einen Wert zurück.
    • Falsch: Die Abfrage gibt null oder nicht definiert zurück.

    Dieses Beispiel zeigt, wie überprüft wird, ob eine Abfrage ein Ergebnis zurückgibt.

    var checkPresent = new global.GlideQuery('sys_user')    
   .where('last_name', 'Luddy')
   .selectOne('first_name')
   .isPresent();

gs.info(checkPresent);

    Ausgabe:

    true

    Optional – Lazy(function lazyGetFn)

    Gibt ein neues optionales Objekt zurück. Anstatt den Datensatz zu enthalten, enthält das Objekt eine Funktion zum Abrufen des Datensatzes, der nur aufgerufen wird, wenn und wenn im Code angefordert wird.

    Verwenden Sie diese Methode, um das Abrufen des Werts zu verzögern, bis er benötigt wird. Sie können dies tun, wenn Sie den Wert aus einer langsamen Quelle anfordern und Ihren Code nicht unnötig verlangsamen möchten. Andernfalls können Sie ein optionales Objekt mit zurückgeben GlideQuery Und Stream APIs.

    Hinweis:
    Diese Methode ist statisch. Sie benötigen keine Instanz der Klasse, um diese Methode zu verwenden.
    Tabelle : 15. Parameter
    Name Typ Beschreibung
    LazyGetFn Funktion Funktion, die als Ergebnis einer Abfrage einen einzelnen Datensatz zurückgibt. Zum Beispiel: 
    var userGr = new GlideRecord('sys_user');
    Tabelle : 16. Rückgaben
    Typ Beschreibung
    Optional Objekt, das das Ergebnis der Abfrage im Format enthält Optional<result> .

    Dieses Beispiel zeigt, wie ein optionales Objekt basierend auf einer GlideRecord-Abfrage abgerufen wird.

    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);

    Ausgabe:

    Optional<005d500b536073005e0addeeff7b12f4>

    Optional – Map(function FN)

    Wendet eine Funktion auf das Ergebnis einer Abfrage an.

    Tabelle : 17. Parameter
    Name Typ Beschreibung
    fn Funktion Funktion, die auf das Ergebnis der Abfrage angewendet werden soll.
    Tabelle : 18. Rückgaben
    Typ Beschreibung
    Optional Objekt, das die Ergebnisse der von der Funktion aktualisierten Abfrage im Format enthält Optional<result> .

    Dieses Beispiel zeigt, wie eine Funktion angewendet wird, die einen Wert in Großbuchstaben umwandelt, auf das Ergebnis einer Abfrage.

    var value = new global.GlideQuery('sys_user')
    .whereNotNull('first_name')
    .selectOne('first_name')
    .map(function (user) {
	       return user.first_name.toUpperCase();
    });

gs.info(value);

    Ausgabe:

    Optional<ABEL>

    Optional – of(beliebiger Wert)

    Umschließt einen bestimmten Wert in einem optionalen Objekt. Sie können beispielsweise das Ergebnis einer GlideRecord-Abfrage in ein optionales Objekt umschließen, um die zugehörigen Methoden zu verwenden.

    Hinweis:
    Diese Methode ist statisch. Sie benötigen keine Instanz der Klasse, um diese Methode zu verwenden.
    Tabelle : 19. Parameter
    Name Typ Beschreibung
    Wert Beliebig Wert im optionalen Objekt.
    Tabelle : 20. Rückgaben
    Typ Beschreibung
    Optional Objekt, das den übergebenen Wert im Format enthält Optional<value> .

    Dieses Beispiel zeigt, wie Sie ein optionales Objekt basierend auf einer GlideRecord-Abfrage generieren.

    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());

    Ausgabe:

    00c269162d761010f87708b56757cbb3

    Optional – orElse(any defaultValue)

    Fügt einen Standardwert innerhalb des optionalen Objekts hinzu, wenn die Abfrage keine Ergebnisse zurückgibt.

    Tabelle : 21. Parameter
    Name Typ Beschreibung
    defaultValue Beliebig Wert im optionalen Objekt, wenn die Abfrage keine Ergebnisse zurückgibt.
    Tabelle : 22. Rückgaben
    Typ Beschreibung
    Beliebig Wert im optionalen Objekt, wenn die Abfrage keine Ergebnisse zurückgibt.

    Dieses Beispiel zeigt, wie ein Wert zurückgegeben wird, auch wenn die Abfrage falsch ist.

    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))

    Ausgabe:

    {
   "first_name":"Default",
   "last_name":"User"
}