Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

@@ Zeile 1: / Zeile 1: @@
+===== do_GetSortOrderForResultSet_Ad =====
+Diese Prozedur ermittelt, wie eine Ergebnismenge einer Prozedur sortiert wird.\\
+Anmerkung :\\ Ähnlich wie die Rückgabemenge einer Prozedur von bestimmten Parametern abhängig sein kann (siehe [[dstoreproc>do_GetProcedureResultSets_Ad]]), so wird die Sortierung einer Rückgabemenge manchmal von Parameter-Einstellungen bestimmt.\\
+Anmerkung zur Rückgabespalte "SortConditionID", "ParameterName" und "Condition" :\\
+Eine Sortierung einer Ergebnismenge ist oftmals an Bedingungen gebunden, die sich dadurch ausdrücken lassen, daß beim Aufruf der Prozedur die Werte einiger Parameter ein gewisses Format haben oder bestimmten Wertebereichen entstammen müssen o.ä. Es kann sein, daß die Rückgabemenge dieser Prozedur also mehrere Datensätze bei gleicher "SortConditionID" und gleichem "ResultColumnName" hat, was bedeutet, daß mehrere Bedingungen gleichzeitig erfüllt sein müssen. Beispiel :\\
+. Datensatz :\\ SortConditionID : 1\\ ParameterName : "Param1"\\ Condition : "is NULL"\\ ResultColumnName : "col1"\\ SortNo : 1\\ ...\\
+. Datensatz :\\ SortConditionID : 1\\ ParameterName : "Param3"\\ Condition : "= 59"\\ ResultColumnName : "col1"\\ SortNo : 1\\ ...\\
+. Datensatz :\\ SortConditionID : 1\\ ParameterName : "Param1"\\ Condition : "is NULL"\\ ResultColumnName : "col2"\\ SortNo : 2\\ ...\\
+Das bedeutet, daß nur nach "col1", "col2", ... sortiert wird, wenn die Bedingung\\ "Parm1 is NULL" AND "Param3 = 59"\\ erfüllt ist !\\
+|HTTP-Method|GET |
+|HTTP-Auth|Optional |
+|Alias|do_GetSortOrderForProcedureResultSet_Ad |
+|Tags|{{tag>[do Get Sort Order For Procedure Result Set Ad]}}|
+|Engine-Kategorie|documentation |
+|Engine-Typ|Daten-Ermittlung |
+|Letzte Aktualisierung|7.0.7 (2015-01-29)|
+==== Parameter ====
+^Name ((Pflichtparameter sind unterstrichen)) ^Standard-Wert ^Beschreibung ((siehe [[webservice:engine_parameterconventions|Parameter-Konventionen engine/<Prozedur-Name>]])) ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^
+|__ProcedureName__| |Name einer Prozedur\\ |varchar(50)|4.0.0|
+|__ProcedureResultConditionID__| |ID einer Bedingung, die eindeutig eine bestimmte Rückgabemenge der Prozedur "ProcedureName" kennzeichnet. Mögliche Werte erhält man durch den Aufruf von [[dstoreproc>do_GetProcedureResultSets_Ad ProcedureName]].\\ |integer|4.0.0|
+|SortConditionID|NULL |ID einer Sortierungs-Bedingung. Falls angegeben, wird nur die hierdurch bestimmte Sortierung (der Rückgabemenge "ProcedureName"-"ProcedureResultConditionID") ermittelt\\ |integer|7.0.3|
+==== Rückgabe ====
+=== (parameterunabhängig) ===
+^Spaltenname  ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^
+|SortConditionID|ID einer Bedingung, unter der die durch "ProcedureResultConditionID" bezeichnete Rückgabemenge nach den "ResultColumnName"s sortiert wird. "0" bedeutet, daß die Rückgabemenge an keine Bedingung gebunden ist. (siehe Beschreibung !)\\ |integer|4.0.0 |
+|SortConditionDescription|Bezeichnung der Sortierungs-Bedingung "SortConditionID". Derzeit entweder "Parameterunabhängige Sortierung" oder aber <Bezeichnung der Rückgabemenge "ProcedureResultConditionID">_<fortlaufende Nummer>.\\ |varchar(100)|7.0.3 |
+|ParameterName|Name eines Parameters der Prozedur "ProcedureName". Die Art der Sortierung hängt vom Wert, der für diesen Parameter angegeben ist, ab. Der Wert muß der Bedingung "Condition" genügen. ("NULL" bei der speziellen Bedingung "ProcedureResultConditionID = 0".)\\ |varchar(50)|4.0.0 |
+|Condition|Die Rückgabemenge wird nur geliefert, wenn der für "ParameterName" übergebene Wert dieser Bedingung genügt. Fast immer handelt es sich hier um eine Bedingung, die in SQL ausgewertet werden kann, zumindest aber mit Hilfe von regulären Ausdrücken.\\ |varchar(255)|4.0.0 |
+|ResultColumnName|Name einer Rückgabespalte der durch "ProcedureResultConditionID" gekennzeichneten Ergebnismenge, nach der sortiert wird\\ |varchar(50)|4.0.0 |
+|SortNo|Bestimmt die Reihenfolge von "ResultColumnName" innerhalb aller Spalten, nach denen sortiert wird\\ |tinyint|4.0.0 |
+|AscendingSortOrder|"0" : Absteigende Sortierung nach "ResultColumnName"\\ "1" : Aufsteigende Sortierung nach "ResultColumnName"\\ |bit|4.0.0 |
+== Sortierung der Rückgabe ==
+(parameterunabängige Sortierung)
+  * SortConditionID (aufsteigend)
+  * SortNo (aufsteigend)
+==== Output-Parameter ====
+Die Prozedur hat keine Output-Parameter.==== Mögliche Return-Codes ====
+^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber" und indirekt meint "von intern aufgerufenen Unterprozeduren")) ^
+|-569|Der Benutzer hat kein Ausführungsrecht für die Prozedur|nur indirekt|
+|-567|Die Prozedur darf z. Zt. nicht ausgeführt werden|nur indirekt|
+|-566|Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werden|nur indirekt|
+|-535|Das Datum liegt nicht in der Vergangenheit|nur indirekt|
+|-530|Der Wert ist nicht konvertierbar|nur indirekt|
+|-510|Der Benutzer ist nicht registriert|nur indirekt|
+|-504|Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochen|nur indirekt|
+|-502|Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)|nur indirekt|
+|-500|Falsche Parameter|direkt und indirekt|
+==== XML-Schema ====
+Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema [[http://resources.dstore.de/xsd/webservice_SmartGate/Response/EngineProcedure_v1_0.xsd|Response/EngineProcedure_v1_0.xsd]] validiert.
+==== Historie ====
+|7.0.7 |2015-01-29|Interne Änderung : Datentyp-Erweiterung des "ReferenceKey" [für "_mi_StartProcedure"-Aufruf]\\  |
+|7.0.3 |2013-12-13|1. Neue Rückgabespalte "SortConditionDescription"\\ 2. Neuer Parameter "SortConditionID"\\  |
+|6.5.4 |2013-04-29|Anpassungen an aktuellen Code-Standard\\  |
+|6.5.3 |2013-03-18|Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung\\  |
+|4.0.10 |2004-03-15|1. Aufruf der Prozeduren "_mi_StartProcedure", "_mi_FinishProcedure" und "_mi_ChooseParamValueSeperator" \\ 2. Ausführen von "set transaction isolation level 1" und "set rowcount 0" zu Beginn der Prozedur\\ 3. Fehler in der Doku\\  |
+|4.0.0 |2003-04-03|Erstmalig in dieser Version erstellt\\  |
+==== Code-Snippets ====
+== Engine Playground ==
+Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
+  * [[http://playground.dstore.de/index.php?proc=do_GetSortOrderForResultSet_Ad|do_GetSortOrderForResultSet_Ad im Engine Playground öffnen]]
+== cURL ==
+Unformatierte Ausgabe:
+<code bash>
+curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/do_GetSortOrderForResultSet_Ad?ProcedureName=<value>&ProcedureResultConditionID=<value>'</code>Mit xmllint ((I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org)) formatierte Ausgabe:
+<code bash>
+curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/do_GetSortOrderForResultSet_Ad?ProcedureName=<value>&ProcedureResultConditionID=<value>' | xmllint --format -</code>== dStore_php ==
+<code php>
+use dStore_php\WebService;
+$service = new WebService\Service( WebService\Scheme::HTTP,'<partner>-<project>.dstore.de', 80);
+$request = new WebService\Requests\Engine\Procedure\Request(
+			new WebService\Requests\AccessData('default'),
+	'do_GetSortOrderForResultSet_Ad',
+		array(
+			'ProcedureName' => '<value>',
+			'ProcedureResultConditionID' => <value>,
+			// 'SortConditionID' => NULL
+		)
+);
+$service->execute($request);
+			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
+			$ResultSet = $xml_result->getRowsAsArray();
+</code>
+== engine/execute ==
+XML zur Ausführung mit der Methode [[:webservice:engine:execute|engine/execute]], z.B. per
+  curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'
+<code xml>
+<?xml version="1.0" encoding="UTF-8"?>
+<ListOfBatches>
+	<Batch No="0">
+		<Procedure Name="do_GetSortOrderForResultSet_Ad">
+			<Parameters>
+				<Parameter Name="ProcedureName"><!-- varchar value --></Parameter>
+				<Parameter Name="ProcedureResultConditionID"><!-- integer value --></Parameter>
+				<!-- <Parameter Name="SortConditionID">NULL</Parameter> -->
+			</Parameters>
+		</Procedure>
+	</Batch>
+</ListOfBatches></code>

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Unterschiede

Seiten-Werkzeuge