Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:do_getprocressortconditions_ad

do_GetProcResSortConditions_Ad

Gibt Bedingungen für eine Prozedur-Rückgabemenge zurück, unter denen diese Rückgabemenge sortiert wird oder sortiert werden kann (s. a. do_GetSortOrderForResultSet_Ad).

Die Rückgabemenge sieht so aus :

  • SortConditionID integer → ID einer Sortierungs-Bedingung für die (durch „ProcedureName“ und

„ProcedureResultConditionID“ referenzierte) Rückgabemenge

  • ConditionDescription varchar(100) → Bezeichnung der Bedingung „SortConditionID“
  • ParameterName varchar(50) → Name eines Parameters der Prozedur „ProcedureName“, dessen Wert beim Aufruf

der Prozedur die Bedingung „Condition“ erfüllen muß, um eine entsprechende
Sortierung der Rückgabemenge zu liefern

  • Condition varchar(255) → Bedingung, die der Parameter „ParameterName“ der Prozedur „ProcedureName“

beim Aufruf erfüllen muß, damit die Rückgabemenge entsprechend sortiert wird

Sortiert wird aufsteigend nach „ConditionDescription und „ParameterName“.

HTTP-MethodGET
HTTP-AuthOptional
Aliasdo_GetProcedureResultSortingConditions_Ad
Tags
Engine-Kategoriedocumentation
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
ProcedureName Name einer Prozedur, die unter der in „ProcedureResultConditionID“ angegebenen Bedingung eine Rückgabemenge liefert, zu der evtl. dokumentierte Sortierungen (dieser Rückgabe) ermittelt werden sollen
varchar(50)7.0.3
ProcedureResultConditionID ID einer Bedingung (mögliche Werte s. do_GetProcResultConditions_Ad), unter der „ProcedureName“ eine Rückgabemenge liefert, zu der evtl. dokumentierte Sortierungen (dieser Rückgabe) ermittelt werden sollen
integer7.0.3
SortConditionIDNULL ID einer Sortierungs-Bedingung. Falls angegeben, werden nur die genauen Bedingungen dieser Sortierung für die durch „ProcedureName“ und „ProcedureResultConditionID“ angegebene Rückgabemenge ermittelt.
integer7.0.3

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
SortConditionIDID einer Sortierungs-Bedingung für die (durch „ProcedureName“ und „ProcedureResultConditionID“ referenzierte) Rückgabemenge. Falls angegeben, natürlich identisch mit „SortConditionID“.
integer7.0.3
ConditionDescriptionBezeichnung der Sortierungs-Bedingung „SortConditionID“
varchar(100)7.0.3
ParameterNameName eines Parameters der Prozedur „ProcedureName“, dessen Wert beim Aufruf die Bedingung „Condition“ erfüllen muß, damit die Rückgabemenge wie zu „SortConditionID“ hinterlegt (s. do_GetSortOrderForResultSet_Ad) sortiert wird
varchar(50)7.0.3
ConditionBedingung, die der Wert des Parameters „ParameterName“ beim Aufruf der Prozedur erfüllen muß, damit die Rückgabemenge wie zu „SortConditionID“ hinterlegt (s. do_GetSortOrderForResultSet_Ad) sortiert wird
varchar(255)7.0.3
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • ConditionDescription (aufsteigend)
  • ParameterName (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 5)
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochennur indirekt
-502Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)nur indirekt
-500Falsche Parameterdirekt und indirekt

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

7.0.7 2015-01-29Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
7.0.4 2014-03-19Kleiner interner Doku-Fehler behoben
7.0.3 2013-12-13Erstmalig 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:

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/do_GetProcResSortConditions_Ad?ProcedureName=<value>&ProcedureResultConditionID=<value>'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/do_GetProcResSortConditions_Ad?ProcedureName=<value>&ProcedureResultConditionID=<value>' | xmllint --format -
dStore_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_GetProcResSortConditions_Ad',
		array(
			'ProcedureName' => '<value>',
			'ProcedureResultConditionID' => <value>,
			// 'SortConditionID' => NULL
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();
engine/execute

XML zur Ausführung mit der Methode engine/execute, z.B. per

curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'
<?xml version="1.0" encoding="UTF-8"?>
<ListOfBatches>
	<Batch No="0">
		<Procedure Name="do_GetProcResSortConditions_Ad">
			<Parameters>
				<Parameter Name="ProcedureName"><!-- varchar value --></Parameter>
				<Parameter Name="ProcedureResultConditionID"><!-- integer value --></Parameter>
				<!-- <Parameter Name="SortConditionID">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
6)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/do_getprocressortconditions_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)