Gibt (Artikel-)Bedingungs-Teile zurück.

Ein Bedingungs-Teil ist Bestandteil einer sogenannten Artikel-Bedingung, deren Aufbau kurz beschrieben so aussieht :

Eine Artikel-Bedingung besteht aus Bedingungs-Gruppen, die jeweils aus Bedingungs-Teilen bestehen, die ihrerseits immer drei Bedingungs-Arten (Hierarchie-Bedingung, Vorgänger-Bedingung und Eigenschafts-Bedingung) definieren.

Im folgenden werden die Bestandteile einzeln erläutert. Beginnen wir mit der „kleinsten Einheit“ :

1.) Ein sogenannter Bedingungs-Teil („ItemConditionPart“) definiert drei Bedingungs-Arten :

a) Hierarchie-Bedingung („LevelIDs“)

Diese besteht aus einer Menge von Hierarchien („LevelIDs“), wobei es auch möglich ist, den Wert „,,“ zu definieren, der für „beliebige Hierarchie“ steht.

b) Vorgänger-Bedingung („DomainTreeNodeIDs“)

Dabei handelt es sich um eine Menge von Vorgänger-IDs („TreeNodeIDs“), wobei es auch möglich ist, den Wert „,,“ zu definieren, der „beliebiger Vorgänger“ bedeutet.

c) Eigenschafts-Bedingung

Sie ist immer zu einem Merkmal („NodeCharacteristicID“) definiert und besteht aus einem „Operator1“ und der dazugehörigen „Condition1“, sowie optional aus einem weiteren „Operator2“ und der dazugehörigen „Condition2“. Dazu können Optionen hinsichtlich Vererbung und rekursiver Auswertung bei der Ermittlung der Eigenschaft definiert werden.
Es ist auch möglich, den Wert „-1“ als Merkmal („NodeCharacteristicID“) zu definieren, was den speziellen Fall „KEINE Eigenschafts-Bedingung“ darstellen soll.

Ein Artikel-Element erfüllt einen Bedingungs-Teil genau dann, wenn alle drei Bedingungs-Arten erfüllt sind. Der spezielle (in einer Standard-Installation bereits definierte) Teil …

• „beliebige Hierarchie“ und
• „beliebiger Vorgänger“ und
• „KEINE Eigenschafts-Bedingung“

wird von jedem (nicht gelöschten) Artikel-Element erfüllt.

Hinweis : Der „Active“-Status eines Elementes spielt grundsätzlich keine Rolle !

2.) Durch eine logische Verknüpfung entweder mit „AND“ oder „OR“ von solchen Bedingungs-Teilen ergibt sich eine sogenannte Bedingungs-Gruppe („ItemConditionGroup“).
Artikel-Elemente erfüllen also eine solche Bedingungs-Gruppe, wenn sie entweder alle (bei „AND“) oder mindestens einen (bei „OR“) ihrer Bedingungs-Teile erfüllen.

3.) Mehrere solcher Gruppen können dann ihrerseits wiederum entweder mit „AND“ oder „OR“ verknüpft werden und bilden letztlich eine Artikel-Bedingung.
Artikel-Elemente erfüllen also eine solche (Gesamt-)Artikel-Bedingung, wenn sie entweder alle (bei „AND“) oder mindestens eine (bei „OR“) ihrer Bedingungs-Gruppen erfüllen.

Somit lassen sich einfache und komplexe Bedingungen formulieren. Beispiele :

1.) „Artikel-Elemente der Kategorie X oder Y der Marke Z“
⇒ Dies ließe sich mit einem Bedingungs-Teil …
„Beliebige Hierarchie UND X,Y als DomainTreeNodeIDs UND Eigenschaft Z zum Merkmal Marke“
… abbilden, der als einziger Teil einer Bedingungs-Gruppe angehören würde, die ihrerseits alleine dann schon die gesamte Bedingung darstellt.

2.) „Rot gefärbte Produkte der Marke X oder blau gefärbte Produkte in Kategorie A der Marke Y“
⇒ Dieses etwas kompliziertere Beispiel läßt sich beispielsweise wie folgt mit vier Bedingungs-Teilen und zwei -Gruppen abbilden :
Die beiden Teile …

• „Produkt-Hierarchie UND beliebiger Vorgänger UND Eigenschaft rot zum Merkmal Farbe“

und

• „Produkt-Hierarchie UND beliebiger Vorgänger UND Eigenschaft X zum Merkmal Marke“

… werden mit „AND“ zu einer Gruppe „1“ verknüpft.
Außerdem verknüpft man die beiden Teile …

• „Produkt-Hierarchie UND A als DomainTreeNodeID UND Eigenschaft blau zum Merkmal Farbe“

und

• „Produkt-Hierarchie UND A als DomainTreeNodeID UND Eigenschaft Y zum Merkmal Marke“

… wiederum mit „AND“ zu einer Gruppe „2“.
Durch eine „OR“-Verknüpfung der beiden Gruppen ist dann schließlich die gesamte Bedingung definiert.
Anmerkung : Es gibt oftmals mehrere Möglichkeiten der Abbildung, da gerade z.B. die Hierarchie-Bedingung bei einer Verknüpfung zweier Bedinungs-Teile mit „UND“ nur bei einer der Teile definiert werden muß - in unserem obigen Beispiel 2 haben wir die Hierarchie hingegen bei ALLEN Bedingungs-Teilen definiert.

Anmerkung zum Parameter „ConditionPartDescriptionLike“ :

Ist man „auf der Suche“ nach definierten Bedingungs-Teilen, gibt es die Möglichkeit, in der Beschreibung dieser Teile zu suchen. Dazu ist „NULL“ für „ConditionPartID“ zu übergeben, „GetUnusedConditionParts“ auf „0“ zu setzen, und in „ConditionPartDescriptionLike“ muß dann der mit dem „LIKE“-Operator anzuwendende Ausdruck (die üblichen wildcards „%“ und „_“ sowie durch „[“ und „]“ eingeschlossene Zeichenmengen etc. sind also möglich) stehen. In diesem Fall wird die Rückgabemenge zum einen immer nach der „ConditionPartDescription“ sortiert, zum anderen werden maximal „RowCount“ („NULL“ ist nicht erlaubt) Datensätze ausgegeben - „0“ angeben, um ALLE Datensätze zu erhalten.

Anmerkung zum Parameter „GetUnusedConditionParts“ :

Als weitere Alternative kann man sich noch nicht verwendete (wieder werden aber maximal „RowCount“ Teile zurückgegeben) Bedingungs-Teile ausgeben lassen. Dazu ist „1“ für „GetUnusedConditionParts“ anzugeben - „ConditionPartID“ und „ConditionPartDescriptionLike“ werden dann nicht beachtet, „OrderBy“ aber sehr wohl !

Anmerkungen zu den „OnlyCondPartsWith…“-Parametern

Falls „GetUnusedConditionParts = 0“ übergeben und „NULL“ für „ConditionPartID“ angegeben ist, gibt es noch die Möglichkeit, sich nur Bedingungs-Teile mit einem bestimmten Merkmal und/oder bestimmten Kategorien ausgeben zu lassen.

Für eine Filterung nach einem Merkmal ist „OnlyCondPartsWithNodeCharacID“ mit der ID des entsprechenden Merkmals zu übergeben, um nach Kategorien zu filtern, sind entsprechende „TreeNodeID“s in den „OnlyCondPartsWithDomTNodeID_…“-Parametern anzugeben.

Wenn mehrere der „OnlyCondPartsWithDomTNodeID_…“-Parameter angegeben werden, bekommt man Bedingungs-Teile, bei denen mindestens eine der IDs als „DomainTreeNodeIDs“ verwendet werden.

Die Filterung erfolgt ZUSÄTZLICH zu einer evtl. Suche anhand der Beschreibung (→ Parameter „ConditionPartDescriptionLike“) !

Läßt man „ConditionPartID“, „ConditionPartDescriptionLike“ und die „OnlyCondPartsWith…“-Parameter „NULL“ und ist „0“ für „GetUnusedConditionParts“ angegeben, dann werden die ersten „RowCount“ Datensätze aller (je nach „OrderBy“ sortierten) Bedingungs-Teile ermittelt - der Wert „NULL“ ist auch hier nicht erlaubt !

Anmerkung zum Parameter „OrderBy“ :

Mit „OrderBy“ bestimmt man im Falle einer Suche nach MEHREREN (Artikel-)Bedingungs-Teilen (wenn also KEINE ID in „ConditionPartID“ angegeben ist bzw. dieser Parameter nicht beachtet wird) die Reihenfolge der Datensätze in der Ergebnismenge :

• „0“/„1“ : AUFsteigende bzw. ABsteigende Sortierung nach „CreatedAtDateAndTime“
• „2“/„3“ : AUFsteigende bzw. ABsteigende Sortierung nach „EditedAtDateAndTime“. Dies ist im Fall „GetUnusedConditionParts = 0“ gleichzeitig eine Filterung, da „EditedAtDateAndTime“ nur gesetzt wird, wenn auch wirklich Änderungen stattfinden ! Man kann also z.B. auch ein leeres Ergebnis bekommen. Alternative Sortierung : s. Werte „5“ bzw. „6“ !
• „4“ : Aufsteigende Sortierung nach „ConditionPartDescription“
• „5“/„6“ : AUFsteigende bzw. ABsteigende Sortierung nach „EditedAtDateAndTime“/„CreatedAtDateAndTime“. Hintergrund : „EditedAtDateAndTime“ eines Bedingungs-Teils kann „NULL“ sein, dann greift aber „CreatedAtDateAndTime“ (was immer vorhanden ist) ! Wir wählen also „EditedAtDateAndTime“ falls vorhanden, andernfalls „CreatedAtDateAndTime“ und sortieren dann nach dem gewählten Wert.

ACHTUNG : Ist „ConditionPartDescriptionLike“ angegeben (und wird auch beachtet), wird immer der Wert „4“ für „OrderBy“ gewählt, egal was übergeben wurde !

wenn OrderBy = 0

• CreatedAtDateAndTime (aufsteigend)

wenn OrderBy = 1

• CreatedAtDateAndTime (absteigend)

wenn OrderBy = 2

• EditedAtDateAndTime (aufsteigend)

wenn OrderBy = 3

• EditedAtDateAndTime (absteigend)

wenn OrderBy = 4

• ConditionPartDescription (aufsteigend)

wenn OrderBy = 5

• isnull(EditedAtDateAndTime, CreatedAtDateAndTime) (aufsteigend)

wenn OrderBy = 6

• isnull(EditedAtDateAndTime, CreatedAtDateAndTime) (absteigend)

wenn OrderBy = 0

• CreatedAtDateAndTime (aufsteigend)

wenn OrderBy = 1

• CreatedAtDateAndTime (absteigend)

wenn OrderBy = 2

• EditedAtDateAndTime (aufsteigend)

wenn OrderBy = 3

• EditedAtDateAndTime (absteigend)

wenn OrderBy = 4

• ConditionPartDescription (aufsteigend)

wenn OrderBy = 5

• isnull(EditedAtDateAndTime, CreatedAtDateAndTime) (aufsteigend)

wenn OrderBy = 6

• isnull(EditedAtDateAndTime, CreatedAtDateAndTime) (absteigend)

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_GetItemConditionParts_Ad im Engine Playground öffnen

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetItemConditionParts_Ad'

Mit xmllint ¹⁰⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetItemConditionParts_Ad' | 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_GetItemConditionParts_Ad',
		array(
			// 'ConditionPartID' => NULL,
			// 'ConditionPartDescriptionLike' => NULL,
			// 'GetUnusedConditionParts' => 0,
			// 'OrderBy' => 6,
			// 'RowCount' => 100,
			// 'OnlyCondPartsWithNodeCharacID' => NULL,
			// 'OnlyCondPartsWithDomTNodeID_1' => NULL,
			// 'OnlyCondPartsWithDomTNodeID_2' => NULL,
			// 'OnlyCondPartsWithDomTNodeID_3' => NULL,
			// 'OutputIntoOneID' => 0
		)
);
 
$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_GetItemConditionParts_Ad">
			<Parameters>
				<!-- <Parameter Name="ConditionPartID">NULL</Parameter> -->
				<!-- <Parameter Name="ConditionPartDescriptionLike">NULL</Parameter> -->
				<!-- <Parameter Name="GetUnusedConditionParts">0</Parameter> -->
				<!-- <Parameter Name="OrderBy">6</Parameter> -->
				<!-- <Parameter Name="RowCount">100</Parameter> -->
				<!-- <Parameter Name="OnlyCondPartsWithNodeCharacID">NULL</Parameter> -->
				<!-- <Parameter Name="OnlyCondPartsWithDomTNodeID_1">NULL</Parameter> -->
				<!-- <Parameter Name="OnlyCondPartsWithDomTNodeID_2">NULL</Parameter> -->
				<!-- <Parameter Name="OnlyCondPartsWithDomTNodeID_3">NULL</Parameter> -->
				<!-- <Parameter Name="OutputIntoOneID">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>