Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:im_getdirectsuccessors_ad

im_GetDirectSuccessors_Ad

Liefert zu einem Element des Artikelbaums (→ „TreeNodeID“) alle direkten Nachfolger. Die Elemente, die für den Benutzer, der diese Prozedur aufruft, gesperrt sind, werden dabei natürlich nicht berücksichtigt.

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

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
TreeNodeID ID eines Elementes im Artikelbaum, zu dem die Nachfolger ermittelt werden sollen
integer3.5.0
LanguageID0 ID einer Sprache, in der die Artikelbeschreibungen ausgegeben werden sollen
tinyint3.5.0
OnlyActive1 „0“ : Aktive und inaktive Elemente des Artikelbaums werden ausgegeben
„1“ : Nur die aktiven Elemente des Artikelbaums werden ausgegeben
bit3.5.0
OnlyNotDeleted1 „0“ : Gelöschte und bestehende Elemente des Artikelbaums werden ausgegeben
„1“ : Es werden nur momentan existierende Elemente des Artikelbaums ausgegeben (solche, für die in „TreeView“ „Deleted = 0“ ist)
bit3.5.0
GroupByCharacteristicIDNULL Ermöglicht die Ermittlung zusätzlicher Ausgabemerkmale zu den gefundenen Elemente und bewirkt eine Sortierung des Ergebisses anhand dieses Merkmals
smallint3.5.17
BinaryCharacteristicValueIDNULL ID einer Eigenschaft die „Binaries“ haben können (eine Dateigröße z.B.). Ermöglicht die zusätzliche Suche von BinaryCodeIDs, welche die hier angegebene Eigenschaft besitzen
integer3.5.17
FilterByCharacteristicIDNULL Nur Nachfolger, die „FilterByCharacValue“ als Eigenschaft zum Merkmal „FilterByCharacteristicID“ haben. (Achtung: Hierbei wird keine Vererbung berücksichtigt)
smallint3.5.17
FilterByCharacValueNULL Nur Nachfolger, die „FilterByCharacValue“ als Eigenschaft zum Merkmal „FilterByCharacteristicID“ haben. (Achtung: Hierbei wird keine Vererbung berücksichtigt)
varchar(1000)3.5.17
NegateFilterByParams0 Wird nur berücksichtigt, falls die „FilterBy…“-Parameter angegeben sind ! Bei Angabe von „1“ für diesen Parameter sind nur Elemente in der Rückgabemenge, die die Eigenschaft „FilterByCharacValue“ zum Merkmal „FilterByCharacteristicID“ NICHT haben.
bit4.0.2

Rückgabe

wenn GroupByCharacteristicID = NULL

Spaltenname Beschreibung SQL-Datentyp4) ab Version
NodeIDID des zur „TreeNodeID“ zugehörigen Artikel-Elementes
integer3.5.0
TreeNodeIDID eines Elementes im Artikelbaum, das Nachfolger von „TreeNodeID“ ist
integer3.5.0
InheritsFromID eines Elementes im Artikelbaum, VON dem „TreeNodeID“ Eigenschaften erbt (im Regelfall ist dies das Vorgänger-Element, also „TreeNodeID“)
integer3.5.0
NodeDescriptionBezeichnung der „NodeID“
varchar(100)3.5.0
ActiveIst „TreeNodeID“ z.Zt. aktiviert ? („0“ : Nein, „1“ : Ja)
bit3.5.0
CountSuccessorsWieviele Nachfolger hat „TreeNodeID“; es werden nur die „OnlyActive“ bzw. „OnlyNotDeleted“ entsprechenden Elemente berücksichtigt !
integer3.5.0
SymbolIDID eines Symbols, das der „NodeID“ zugeordnet ist
tinyint3.5.0
LevelNoNummer der Hierarchie der „NodeID“
tinyint3.5.0
SortNoBestimmt die Reihenfolge von „TreeNodeID“ innerhalb aller Nachfolger von „TreeNodeID“
smallint3.5.0
BinaryCodeIDID eines „Binaries“, das der „NodeID“ zugeordnet ist, und das „BinaryCharacteristicValueID“ als Eigenschaft besitzt. Da es prinzipiell mehrere „Binaries“ mit dieser Eigenschaft geben könnte, wird immer das Binärobjekt mit der KLEINSTEN ID zurückgegeben
integer3.5.0
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • SortNo (absteigend)

wenn GroupByCharacteristicID <> NULL

Spaltenname Beschreibung SQL-Datentyp5) ab Version
NodeIDID des zur „TreeNodeID“ zugehörigen Artikel-Elementes
integer3.5.0
TreeNodeIDID eines Elementes im Artikelbaum, das Nachfolger von „TreeNodeID“ ist
integer3.5.0
InheritsFromID eines Elementes im Artikelbaum, VON dem „TreeNodeID“ Eigenschaften erbt (im Regelfall ist dies das Vorgänger-Element, also „TreeNodeID“)
integer3.5.0
NodeDescriptionBezeichnung der „NodeID“
varchar(100)3.5.0
ActiveIst „TreeNodeID“ z.Zt. aktiviert ? („0“ : Nein, „1“ : Ja)
bit3.5.0
CountSuccessorsWieviele Nachfolger (egal ob aktiv oder nicht) hat „TreeNodeID“
integer3.5.0
SymbolIDID eines Symbols, das der „NodeID“ zugeordnet ist
tinyint3.5.0
LevelNoNummer der Hierarchie der „NodeID“
tinyint3.5.0
SortNoBestimmt die Reihenfolge von „TreeNodeID“ innerhalb aller Nachfolger von „TreeNodeID“
smallint3.5.0
BinaryCodeIDID eines „Binaries“, das der „NodeID“ zugeordnet ist, und das „BinaryCharacteristicValueID“ als Eigenschaft besitzt. Da es prinzipiell mehrere „Binaries“ mit dieser Eigenschaft geben könnte, wird immer das Binärobjekt mit der KLEINSTEN ID zurückgegeben
integer3.5.0
Value(Direkte !) Eigenschaft der „TreeNodeID“ zum Merkmal „GroupByCharacteristicID“
varchar(1000)3.5.17
ValueIDID der Eigenschaft „Value“
integer3.5.17
ValueSortNoBestimmt die Reihenfolge von „Value“ innerhalb aller Eigenschaften zum Merkmal „GroupByCharacteristicID“. Enthält „-1“, wenn „TreeNodeID“ KEINE Eigenschaft zum Merkmal „GroupByCharacteristicID“ besitzt
smallint3.5.17
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • ValueSortNo (absteigend)
  • Value (aufsteigend)
  • SortNo (absteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 6)
-621Fehlender oder falscher Eintrag in PersonTypeSettingsnur indirekt
-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
-550Fehlender oder falscher Eintrag in Settingsnur 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
-283Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu ermittelnnur direkt
-120Der Benutzer hat keine Berechtigung für das (die) Element(e)nur 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.1 2013-08-071. Datentyp-Erweiterung des Parameters „FilterByCharacValue“ [von 100 auf 1000]
2. Datentyp der Rückgabespalte „Value“ hat sich erweitert
3. Interne Anpassungen [u.a. Quellcode an den aktuellen Standard]
6.5.3 2013-03-18Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung)e
5.1.5 2006-08-29Fehler : „LockedNodeCharacteristics“ wurde bisher GAR NICHT beachtet !
5.1.1 2006-04-05Optimierung des Zugriffs auf „NodeProperties“ (bedingt durch die Änderung dieser Tabelle in 5.1.0)
4.0.11 2004-03-311. Aufruf der Prozeduren „_mi_StartProcedure“, „_mi_FinishProcedure“ und „_mi_ChooseParamValueSeperator“
2. „set transaction isolation level 1“, „set rowcount 0“ zu Beginn d. Prozedur
3. Konsequente Fehlerbehandlung
4.0.2 2003-06-11Neuer Parameter „NegateFilterByParams“
4.0.1 2003-05-16Ab jetzt wird berücksichtigt, daß in „NodeProperties“ auch Gültigkeitszeiträume in der Zukunft vorhanden sein können !
4.0.0 2003-04-031. Code-Vereinfachungen bzgl. „OnlyActive“, „OnlyNotDeleted“ und „FilterByValueID“
2. Bei „CountSuccessors“ wird jetzt ebenfalls „OnlyActive“ bzw. „OnlyNotDeleted“ berücksichtigt !
3. Diverse Fehler in der Doku
3.5.17 2002-05-02
3.5.0 2000-11-23Erstmalig 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/im_GetDirectSuccessors_Ad?TreeNodeID=<value>'

Mit xmllint 7) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetDirectSuccessors_Ad?TreeNodeID=<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'),
	'im_GetDirectSuccessors_Ad',
		array(
			'TreeNodeID' => <value>,
			// 'LanguageID' => 0,
			// 'OnlyActive' => 1,
			// 'OnlyNotDeleted' => 1,
			// 'GroupByCharacteristicID' => NULL,
			// 'BinaryCharacteristicValueID' => NULL,
			// 'FilterByCharacteristicID' => NULL,
			// 'FilterByCharacValue' => NULL,
			// 'NegateFilterByParams' => 0
		)
);
 
$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="im_GetDirectSuccessors_Ad">
			<Parameters>
				<Parameter Name="TreeNodeID"><!-- integer value --></Parameter>
				<!-- <Parameter Name="LanguageID">0</Parameter> -->
				<!-- <Parameter Name="OnlyActive">1</Parameter> -->
				<!-- <Parameter Name="OnlyNotDeleted">1</Parameter> -->
				<!-- <Parameter Name="GroupByCharacteristicID">NULL</Parameter> -->
				<!-- <Parameter Name="BinaryCharacteristicValueID">NULL</Parameter> -->
				<!-- <Parameter Name="FilterByCharacteristicID">NULL</Parameter> -->
				<!-- <Parameter Name="FilterByCharacValue">NULL</Parameter> -->
				<!-- <Parameter Name="NegateFilterByParams">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
6)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
7)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/im_getdirectsuccessors_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)