Sortiert eine Menge von TreeNodeIDs anhand ihrer Eigenschaften. Die „TreeNodeIDs“ sind über die Interface-Prozedur „if_im_SortTreeNodes“ vor dem Aufruf dieser Prozedur in die Schnittstelle einzufügen.

Die Merkmal-IDs der Eigenschaften, die zur Sortierung herangezogen werden (maximal 3 !) sind (durch „¶“ getrennt) in „SortByCharacteristicIDList“ zu übergeben. Sortiert wird zuerst nach den Eigenschaften zum ersten Merkmal, dann (falls angegeben) zum zweiten Merkmal und schließlich (falls angegeben) zum dritten Merkmal.

WIE zu sortieren ist, muß man im Parameter „SortOptionList“ angeben. Dabei handelt es sich um eine Summe von Optionen, bzw. um eine Liste von „Options-Summen“ (durch „¶“ getrennt), die sich auf das Merkmal in „SortByCharacteristicIDList“ beziehen, das an der entsprechenden Stelle kommt.

Folgende Optionen sind derzeit möglich :

• „1“ : ABsteigende Sortierung nach der zur Eigenschaft zugehörigen „SortNo“ aus „NodeCharacteristicValues“
• „2“ : AUFsteigende Sortierung nach der zur Eigenschaft zugehörigen „SortNo“ aus „NodeCharacteristicValues“
• „4“ : ABsteigende Sortierung nach den Werten selbst. Dabei wird bei „Text“-Eigenschaften die Groß- und Kleinschreibung

grundsätzlich NICHT beachtet.

• „8“ : AUFsteigende Sortierung nach den Werten selbst. Dabei wird bei „Text“-Eigenschaften die Groß- und Kleinschreibung

grundsätzlich NICHT beachtet.

• „16“ : „NULL“-Werte (d.h. es ist KEINE Eigenschaft vorhanden) werden nach UNTEN sortiert
• „32“ : „NULL“-Werte (d.h. es ist KEINE Eigenschaft vorhanden) werden nach OBEN sortiert

Logischerweise kann nur EINE von den Optionen „1“, „2“, „4“ und „8“ gewählt werden, und es kann natürlich nur entweder Option
„16“ oder „32“ gewählt werden !

Bei der Ermittlung der Eigenschaften gibt es durch die Parameter „InheritDepthOptionList“ und „RecursiveEvaluationOptionList“ die Möglichkeit, bzgl. Vererbung und rekursiver Auswertung Einschränkungen vorzunehmen. Es handelt sich wieder jeweils um eine Liste von Werten (durch „¶“), die sich auf das Merkmal in „SortByCharacteristicIDList“ beziehen, das an der entsprechenden Stelle kommt :

1.) Mit dem jeweiligen „InheritDepth“-Wert hat der Aufrufer die Möglichkeit, bei der Ermittlung der Eigenschaften zum entsprechenden Merkmal hinsichtlich der Vererbung Einschränkungen vorzunehmen :

• -1 : alle direkten und geerbten Eigenschaften berücksichtigen
• 0 : keine geerbten Eigenschaften beachten
• 1 : zusätzlich einfach geerbte Eigenschaften berücksichtigen
• 2 : zusätzlich einfach und zweifach geerbte Eigenschaften berücksichtigen

usw.

2.) Es gibt sogenannte „REKURSIVE“ Merkmale, die als Ausprägung wiederum Merkmale haben, d.h. alle (vordefinierten)
Eigenschaften sind IDs.

Beispiel : Es sind mehrere „Preis“-Merkmale definiert, „Preis in EUR“, „Sonderpreis in EUR“, etc. Das Merkmal
„Verkaufspreis (EUR)“ sei die Angabe, welches von den Preisen denn der für den Verkauf relevante ist. Möchte
ich nun nach dem Verkaufspreis sortieren, ist es in der Regel gewünscht, daß nach dem tatsächlichen Preis
sortiert werden soll - und nicht nach den Merkmal-IDs, die direkt zum Merkmal Verkaufspreis gespeichert sind !
In diesem Fall übergebe ich an der entsprechenden Stelle im Parameter „RecursiveEvaluationOptionList“ den Wert
„1“. Ist das nicht gewünscht oder ist das Merkmal überhaupt kein rekursives Merkmal, ist „0“ anzugeben.
Wie schon bei „SortOptionList“ kann man auch für diese beiden Parameter „NULL“ angeben. Es wird dann automatisch KEINE
Vererbung berücksichtigt und auch KEINE rekursive Auswertung durchgeführt !

(parameterunabängige Sortierung)

• ValueSortNo_1 (aufsteigend)
• ValueSortNo_2 (aufsteigend)
• ValueSortNo_3 (aufsteigend)
• TreeNodeID (aufsteigend)

Die Prozedur hat keine Output-Parameter.

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

Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:

• im_SortTreeNodes_Pu im Engine Playground öffnen

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/im_SortTreeNodes_Pu?SortByCharacteristicIDList=<value>'

Mit xmllint ⁹⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/im_SortTreeNodes_Pu?SortByCharacteristicIDList=<value>' | xmllint --format -

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'),
	'im_SortTreeNodes_Pu',
		array(
			'SortByCharacteristicIDList' => '<value>',
			// 'SortOptionList' => NULL,
			// 'InheritDepthOptionList' => NULL,
			// 'RecursiveEvaluationOptionList' => NULL,
			// 'BinaryCharacteristicValueID' => NULL,
			// 'GetValuesForSortByCharacs' => 1
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();

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="im_SortTreeNodes_Pu">
			<Parameters>
				<Parameter Name="SortByCharacteristicIDList"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="SortOptionList">NULL</Parameter> -->
				<!-- <Parameter Name="InheritDepthOptionList">NULL</Parameter> -->
				<!-- <Parameter Name="RecursiveEvaluationOptionList">NULL</Parameter> -->
				<!-- <Parameter Name="BinaryCharacteristicValueID">NULL</Parameter> -->
				<!-- <Parameter Name="GetValuesForSortByCharacs">1</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>