URL für direkten Zugriff auf JobArchive-Ergebnisliste (getJobArchiveResultListUrlBuilder) |
Scroll Zurück Oben Weiter Mehr |
Diese Funktion ermöglicht es Ihnen, die URL für den direkten Zugriff auf eine bestimmte JobArchive-Ergebnisliste aus Drittanwendungen zu erzeugen. Standardmäßig wird immer die aktuelle Revision eines Dokumentes ermittelt.
Parameter |
Typ |
Beschreibung |
---|---|---|
$resultListId |
int |
Id der JobArchive-Ergebnisliste |
Die Funktion liefert ein Objekt vom Typ JobArchive_ResultListUrlBuilder zurück. Dieses Objekt stellt folgende Methoden bereit, um die Parameter für die URL zum direkten Zugriff auf die Ergebnisliste zu setzen und schließlich die URL zurückzuliefern:
Methode setUsername
Setzt den Namen des JobRouter-Benutzers, für den die URL erzeugt werden soll. Der Aufruf ist zwingend erforderlich.
Parameter |
Typ |
Beschreibung |
---|---|---|
$username |
string |
Name des Benutzers, für den die URL gültig sein soll |
Methode setValidFrom
Setzt den Zeitpunkt, ab dem die URL gültig sein soll. Der Aufruf ist optional (d.h. die URL ist sofort gültig).
Parameter |
Typ |
Beschreibung |
---|---|---|
$validFrom |
DateTime | string |
Zeitpunkt, ab dem die URL gültig sein soll |
Methode setValidUntil
Setzt den Zeitpunkt, bis zu dem die URL gültig sein soll. Der Aufruf ist optional (d.h. die URL ist zeitlich unbegrenzt gültig).
Parameter |
Typ |
Beschreibung |
---|---|---|
$validUntil |
DateTime | string |
Zeitpunkt, bis zu dem die URL gültig sein soll |
Methode addCompareFilter
Fügt einen Vergleichsfilter auf ein Indexfeld hinzu. Der Aufruf ist optional.
Parameter |
Typ |
Beschreibung |
---|---|---|
$fieldName |
string |
Name des Indexfeldes, auf das gefiltert werden soll |
$fieldValue |
string |
Wert, der zur Filterung verwendet werden soll |
$operator |
string |
Operator (<, <=, >, >=) |
Methode addExactFilter
Fügt einen Übereinstimmungsfilter auf ein Indexfeld hinzu. Der Aufruf ist optional.
Parameter |
Typ |
Beschreibung |
---|---|---|
$fieldName |
string |
Name des Indexfeldes, auf das gefiltert werden soll |
$fieldValue |
string |
Wert, der zur Filterung verwendet werden soll |
Methode addLikeFilter
Fügt einen Ähnlichkeitsfilter auf ein Indexfeld hinzu. Der Aufruf ist optional.
Parameter |
Typ |
Beschreibung |
---|---|---|
$fieldName |
string |
Name des Indexfeldes, auf das gefiltert werden soll |
$fieldValue |
string |
Wert, der zur Filterung verwendet werden soll |
Methode addRangeFilter
Fügt einen Bereichsfilter auf ein Indexfeld hinzu. Der Aufruf ist optional.
Parameter |
Typ |
Beschreibung |
---|---|---|
$fieldName |
string |
Name des Indexfeldes, auf das gefiltert werden soll |
$fromValue |
string |
Startwert, der zur Filterung verwendet werden soll |
$fromOperator |
string |
Operator (>, <=) |
$toValue |
string |
Endwert, der zur Filterung verwendet werden soll |
$toOperator |
string |
Operator (>, >=) |
Methode setDownloadAllowed
Aktiviert oder deaktiviert die Möglichkeit zum Download von Dokumenten aus der Ergebnisliste. Der Aufruf ist optional. Standardmäßig ist die Möglichkeit zum Download deaktiviert.
Parameter |
Typ |
Beschreibung |
---|---|---|
$downloadAllowed |
bool |
true = Download ermöglichen |
Methode setUseExactRevision
Aktiviert oder deaktiviert das Ermitteln der exakten Revision eines Dokumentes. Der Standardwert ist hier false.
Ist dieser Flag aktiviert, liefert die Methode getUrl den Link für die exakte Dokumentrevision zurück, ansonsten wird ein Link mit der aktuellen Dokumentrevision generiert.
Parameter |
Typ |
Beschreibung |
---|---|---|
$useExactRevision |
bool |
true = Exakte Revision für das Ermitteln des Dokumentes aktiviert |
Methode setViewer
Setzt den Viewer, der bei der Anzeige von Dokumenten aus der Ergebnisliste heraus verwendet werden soll. Der Aufruf ist optional. Standardmäßig wird der globale Standardviewer verwendet.
Parameter |
Typ |
Beschreibung |
---|---|---|
$viewer |
string |
default = Globaler Standardviewer download = Datei herunterladen |
Methode setViewMode
Setzt den Modus, der bei der Anzeige von Dokumenten aus der Ergebnisliste heraus verwendet werden soll. Der Aufruf ist optional. Standardmäßig wird der Anzeigemodus „auto“ verwendet.
Parameter |
Typ |
Beschreibung |
---|---|---|
$viewMode |
string |
auto = bei mehr als einem Treffer wird die Ergebnisliste angezeigt, anderenfalls das Dokument im Viewer geöffnet viewer = Viewer öffnen |
Methode getUrl
Liefert die URL für den direkten Zugriff auf die Ergebnisliste zurück.
Beispiel:
…
$urlBuilder->setUsername('mmustermann');
$urlBuilder->setValidFrom(new DateTime('2013-10-01'));
$urlBuilder->setValidUntil(new DateTime('2013-12-31'));
$urlBuilder->addExactFilter('kundennummer', '005983');
$urlBuilder->setUseExactRevision(true);
$urlBuilder->addCompareFilter('rechnungsdatum', '2013-01-01', '>');
$urlBuilder->addRangeFilter('rechnungsbetrag', 1000, '>=', 10000, '<=');
$url = $urlBuilder->getUrl();
…