InformationHandler: Unterschied zwischen den Versionen

Aktuelle Version vom 24. Februar 2010, 12:57 Uhr

Name

INFE InformationHandler - Verwaltet Artikel

Klasse

com.sitepark.ies.control.jsp.handler.InformationHandler

Beschreibung

Über diesen Handler können die Artikel des Systems verwaltet werden. Es können Artikel erzeugt, geändert, gelöscht, kopiert, verschoben und Verknüpfungen erstellt werden. Über diesen Handler kann eine Vorschau eines Artikels mit den übertragenen Daten und einen angegebenen Publikationsbereich erzeugt werden. Der Artikel wird ebenfalls für das Auslesen von alten Artikel-Versionen verwendet.

Parameter

Name	Required	Default	ab IES Version
`SYS_INFE_action`	Ja	None	1
`SYS_INFE_id`	Ja für `update`, `delete`, `reposit`	None	1
`SYS_INFE_entries`	Ja für `copy`, `move`, `create-link`	None	1
`SYS_INFE_target`	Ja für `create`, `copy`, `move`, `create-link`	None	1
`SYS_INFE_name`	Ja für `create`	None	1
`SYS_INFE_anchor`	Nein	None	1
`SYS_INFE_comment`	Nein	None	1
`SYS_INFE_file`	Ja für Artikel vom Typ `article`	None	1
`SYS_INFE_articleType`	Ja für `create`	None	1
`SYS_INFE_publicationArea`	Nein	None	1
`SYS_INFE_publicationChecked`	Nein	None	1
`SYS_INFE_publicationTemplate`	Ja, für jeden `SYS_INFE_publicationArea` Parameter	None	1
`SYS_INFE_publicationPersonalization`	Nein	None	1
`SYS_INFE_previewArea`	Nein	None	1
`SYS_INFE_version`	Ja für reposit	None	1
`SYS_INFE_listID`	Nein	None	1
`SYS_INFE_listAction`	Nein	None	1

SYS_INFE_action

Zur Verfügung stehende Aktionen:

create: Erzeugt einen neuen Artikel.
update: Ändert einen Artikel. Alle mitgesendeten Felder werden aktualisiert. Ist das Feld leer, wird es vom Artikel gelöscht. Nicht mitgesendete Felder bleiben unverändert.
delete: Löscht einen Artikel.
copy: Kopiert eine Liste von Artikeln. Die ID-Liste wird in SYS_INFE_entries angegeben. Die kopierten Artikel werden in dem Pool angelegt, der mit SYS_INFE_target angegeben wurde.
move: Verschiebt eine Liste von Artikeln. Die ID-Liste wird in SYS_INFE_entries angegeben. Die Artikel werden in den Pool verschoben, der mit SYS_INFE_target angegeben wurde.
create-link: Verknüpft eine Liste von Artikeln. Die ID-Liste wird in SYS_INFE_entries angegeben. Die neuen Verknüpfungen werden in dem Pool angelegt, der mit SYS_INFE_target angegeben wurde. Verknüpfungen können nur für Resourcen erstellt werden.
preview: Mit dieser Aktion wird aus den mitgesendeten Artikeldaten und dem angegebenen Artikel (falls vorhanden) ein temporärer Artikel erzeugt, mit dem eine temporäre Datei in dem angegebenen Publikationsbereich generiert wird.
edit: Mit dieser Aktion wird ein Artikel nur innerhalb der Session verändert, ohne die Änderungen zu speichern. Hiermit kann ein Artikel erst solange bearbeitet werden, bis alle gewünschten Daten eingetragen wurden. Anschließend kann mit einem update bzw. create der Artikel gespeichert werden.
reposit: Mit dieser Aktion wird von einem Artikel eine ältere Version aus der Datenbank geholt und als aktuelles Element gesetzt.
none: Es wird keine Aktion ausgeführt.

SYS_INFE_id: ID des Artikels, auf den sich die Aktion bezieht.

SYS_INFE_entries: Liste von Artikel-IDs, die verschoben/kopiert/verlinkt werden sollen.

SYS_INFE_target: Die ID des Pools, indem ein Artikel/Link angelegt/verschoben werden soll.

SYS_INFE_name: Der Name des Artikels.

SYS_INFE_comment: Bemerkung für den Artikel.

SYS_INFE_anchor: Anchor des Artikels.

SYS_INFE_file: Der Name der Datei, die mit dem Artikel erzeugt werden soll. (Nur für Artikel vom Typ article).

SYS_INFE_articleType

Zur Verfügung stehende Aktionen:

acticle: Ein Artikel, der generiert werden kann. z.B. als Datei.
resource: Ein Artikel, der nur in der Datenbank liegt und nicht generiert werden kann.
media: Ein Medium, z.B. Bilder, PDF, ...

SYS_INFE_publicationArea: Über diesen Parameter wird die Publikation eines Artikels gesteuert. Dieser Parameter enthält die ID des Publikationsbereichs für den die weiteren Parameter SYS_INFE_publicationChecked, SYS_INFE_publicationTemplate und SYS_INFE_publicationPersonalization gelten.

Alle zur Verfügung stehenden Publikations-Objekte eines Mandanten können mit system.client.publisher erreicht werden.

SYS_INFE_publicationChecked: Soll ein Artikel für einen mit SYS_INFE_publicationArea angegebenen Publikationsbereich publiziert werden, so muß mit diesem Parameter ebenfalls die ID des Publikationsbereichs mitgesendet werden. Soll ein Artikel für einen mit SYS_INFE_publicationArea angegebenen Publikationsbereich depubliziert werden, so wird für diesen Publikationsbereich kein SYS_INFE_publicationChecked-Parameter mitgesendet.

SYS_INFE_publicationTemplate: Für diesen Parameter ist die Reihenfolge der Parameter die mitgesendet werden entscheidend. Für jeden mit SYS_INFE_publicationArea angegebenen Publikationsbereich muß es einen Parameter SYS_INFE_publicationTemplate geben, der die ID des Templates enthält, mit dem der Artikel für diesen Publikationsbereich publiziert werden soll. Dabei erfolgt die Zuordnung zwischen SYS_INFE_publicationArea und SYS_INFE_publicationTemplate über die Reihenfolge, in der die Parameter gesendet werden. Der erste SYS_INFE_publicationArea-Parameter verwendet das Template, das mit dem ersten SYS_INFE_publicationTemplate-Parameter mitgesendet wurde. Die Anzahl beider Parameter muß gleich sein.

SYS_INFE_publicationPersonalization: Sollen für die Publikationsbereiche Personalisierungsdaten gespeichert werden, so wird dieser Parameter mitgesendet. Wird dieser Parameter mitgesendet, muß ähnlich wie bei SYS_INFE_publicationTemplate, die Anzahl der Parameter mit der Anzahl der SYS_INFE_publicationArea-Parameter gleich sein. Die Zuordnung erfolgt über die Reihenfolge der gesendeten Parameter.

SYS_INFE_previewArea: Der Publikationsbereich, für den eine Vorschau erzeugt werden soll.

SYS_INFE_version: Ein bestimmter Versions-Stand der angezeigt und bearbeitet werden soll. Die aktuelle Version hat stets den Stand 0. Versionen werden durch Zeitstempel repräsentiert (in Millisekunden ab dem 1.1.1970 1:00). Diese können über myInformationID.history ausgelesen werden. Der hier angegebene Wert wird mit dem Kommando reposit ausgewertet.

SYS_INFE_listAction

Dieser Parameter löst eine Aktion auf eine Liste des Artikels aus. Dadurch kann eine Liste modifiziert werden. Folgende Aktionen sind möglich:

clearList: Löscht eine ganze Liste, die mit über SYS_INFE_listID angegebenen wurde.
swapList: Vertauscht alle Listen-Elemente der mit SYS_INFE_listID angegebenen Liste. Das erste Element wird zum letzten, das zweite zum vorletzten, ..., das letzte Element wird zum ersten Element.
addItem: Fügt ein leeres Listen-Element an das Ende der mit SYS_INFE_listID angegebenen Liste. Da spt:iterator auch ein leeres Listen-Element anzeigt, wenn die Liste leer ist, werden zwei leere Listen-Elemente bei einer leeren Liste erzeugt.
moveItemDown: Verschiebt das mit SYS_INFE_listID angegebene Listen-Element um eine Position nach unten.
moveItemUp: Verschiebt das mit SYS_INFE_listID angegebene Listen-Element um eine Position nach oben.
removeItem: Löscht das mit SYS_INFE_listID angegebene Listen-Element.
insertItem: Fügt das mit SYS_INFE_listID angegebene Listen-Element hinzu. Da spt:iterator auch ein leeres Listen-Element anzeigt, wenn die Liste leer ist, werden zwei leere Listen-Elemente bei einer leeren Liste erzeugt.

SYS_INFE_listId: Die ID der Liste, oder des Listen-Elements, auf das sich die Listen-Action SYS_INFE_listAction bezieht.

Fehlercodes

@@ Zeile 3: / Zeile 3: @@
 ==Klasse==
-<code>com.sitepark.ies.jsp.handler.InformationHandler</code>
+<code>com.sitepark.ies.control.jsp.handler.InformationHandler</code>
 ==Beschreibung==
-Über diesen Handler können die Artikel des Systems verwaltet werden. Es können Artikel erzeugt, geändert, gelöscht, kopiert, verschoben und Verknüpfungen erstellt werden. Über diesen Handler kann eine Vorschau eines Artikels mit den übertragenen Daten und einen angegebenen Publikationsbereich erzeugt werden. Der Artikel wird ebenfalls für das auslesen von alten Artikel-Versionen verwendet.
+Über diesen Handler können die Artikel des Systems verwaltet werden. Es können Artikel erzeugt, geändert, gelöscht, kopiert, verschoben und Verknüpfungen erstellt werden. Über diesen Handler kann eine Vorschau eines Artikels mit den übertragenen Daten und einen angegebenen Publikationsbereich erzeugt werden. Der Artikel wird ebenfalls für das Auslesen von alten Artikel-Versionen verwendet.
 ==Parameter==
-{| class="prettytable"
+{| class="prettytable sortable"
 |- class="hintergrundfarbe1"
 ! Name || Required || Default || ab IES Version
@@ Zeile 54: / Zeile 54: @@
 |-
 | <code>SYS_INFE_articleType</code>
-| Nein
+| Ja für <code>create</code>
 | None
 | 1
@@ Zeile 112: / Zeile 112: @@
 ::Verschiebt eine Liste von Artikeln. Die ID-Liste wird in <code>SYS_INFE_entries</code> angegeben. Die Artikel werden in den Pool verschoben, der mit <code>SYS_INFE_target</code> angegeben wurde.
 :;<code>create-link</code>
-::Verknüpft eine Liste von Artikeln. Die ID-Liste wird in <code>SYS_INFE_entries</code> angegeben. Die neuen Verknüpfungen werden in dem Pool angelegt, der mit <code>SYS_INFE_target</code> angegeben wurde. Verknüpfungen können nur für Artikel vom Type <code>resource</code> erstellt werden.
+::Verknüpft eine Liste von Artikeln. Die ID-Liste wird in <code>SYS_INFE_entries</code> angegeben. Die neuen Verknüpfungen werden in dem Pool angelegt, der mit <code>SYS_INFE_target</code> angegeben wurde. Verknüpfungen können nur für [[Resource|Resourcen]] erstellt werden.
 :;<code>preview</code>
 ::Mit dieser Aktion wird aus den mitgesendeten Artikeldaten und dem angegebenen Artikel (falls vorhanden) ein temporärer Artikel erzeugt, mit dem eine temporäre Datei in dem angegebenen Publikationsbereich generiert wird.
@@ Zeile 143: / Zeile 143: @@
 :Der Name der Datei, die mit dem Artikel erzeugt werden soll. (Nur für Artikel vom Typ <code>article</code>).
-;<code>SYS_INFE_type</code>
+;<code>SYS_INFE_articleType</code>
 :Zur Verfügung stehende Aktionen:
 :;<code>acticle</code>
-::Ein Artikel, der generiert werden kann. Z.B. als Datei.
+::Ein Artikel, der generiert werden kann. z.B. als Datei.
 :;<code>resource</code>
-::Ein Artikel, der nur in der Datebank liegt und nicht generiert werden kann.
+::Ein Artikel, der nur in der Datenbank liegt und nicht generiert werden kann.
 :;<code>media</code>
 ::Ein Medium, z.B. Bilder, PDF, ...
 ;<code>SYS_INFE_publicationArea</code>
-:Über diesen Parameter wird die Publikation eines Artikels gesteuert. Dieser Parameter enthält die ID des Publikationsbereiches für den die weiteren Parameter <code>SYS_INFE_publicationChecked</code>, <code>SYS_INFE_publicationTemplate</code> und <code>SYS_INFE_publicationPersonalization</code> gelten.
+:Über diesen Parameter wird die Publikation eines Artikels gesteuert. Dieser Parameter enthält die ID des Publikationsbereichs für den die weiteren Parameter <code>SYS_INFE_publicationChecked</code>, <code>SYS_INFE_publicationTemplate</code> und <code>SYS_INFE_publicationPersonalization</code> gelten.
 :Alle zur Verfügung stehenden Publikations-Objekte eines Mandanten können mit <code>system.client.publisher</code> erreicht werden.
 ;<code>SYS_INFE_publicationChecked</code>
-:Soll ein Artikel für einen mit <code>SYS_INFE_publicationArea</code> angegebenen Publikationsbereich publiziert werden, so muß mit diesem Parameter ebenfalls die ID des Publikationsbereiches mitgesendet werden. Soll ein Artikel für einen mit <code>SYS_INFE_publicationArea</code> angegebenen Publikationsbereich depubliziert werden, so wird für diesen Publikationsbereich kein <code>SYS_INFE_publicationChecked</code>-Parameter mitgesendet.
+:Soll ein Artikel für einen mit <code>SYS_INFE_publicationArea</code> angegebenen Publikationsbereich publiziert werden, so muß mit diesem Parameter ebenfalls die ID des Publikationsbereichs mitgesendet werden. Soll ein Artikel für einen mit <code>SYS_INFE_publicationArea</code> angegebenen Publikationsbereich depubliziert werden, so wird für diesen Publikationsbereich kein <code>SYS_INFE_publicationChecked</code>-Parameter mitgesendet.
 ;<code>SYS_INFE_publicationTemplate</code>
@@ Zeile 170: / Zeile 170: @@
 ;<code>SYS_INFE_version</code>
-:Ein bestimmter Versions-Stand der angezeigt und bearbeitet werden soll. Die aktuelle Version hat stets den Stand 0. Versionen werden durch Zeitstempel repräsentiert (in Millisekunden ab dem 1.1.1970 1:00). Diese können über <code>myInformationID.history</code> ausgelesen werden. Der hier angegebene Wert wird mit dem Kommando reposit ausgewertet.
+:Ein bestimmter Versions-Stand der angezeigt und bearbeitet werden soll. Die aktuelle Version hat stets den Stand 0. Versionen werden durch Zeitstempel repräsentiert (in Millisekunden ab dem 1.1.1970 1:00). Diese können über <code>myInformationID.history</code> ausgelesen werden. Der hier angegebene Wert wird mit dem Kommando <code>reposit</code> ausgewertet.
 ;<code>SYS_INFE_listAction</code>
 :Dieser Parameter löst eine Aktion auf eine Liste des Artikels aus. Dadurch kann eine Liste modifiziert werden. Folgende Aktionen sind möglich:
+:;clearList
+::Löscht eine ganze Liste, die mit über <code>SYS_INFE_listID</code> angegebenen wurde.
 :;swapList
-::Vertauscht alle Listen-Elemente der mit <code>SYS_INFE_listID</code> angegebene Liste. Das erste Element wird zum letzten, das zweite zum zweitletzten, ..., das letzte Element wird zum ersten Element.
+::Vertauscht alle Listen-Elemente der mit <code>SYS_INFE_listID</code> angegebenen Liste. Das erste Element wird zum letzten, das zweite zum vorletzten, ..., das letzte Element wird zum ersten Element.
 :;addItem
 ::Fügt ein leeres Listen-Element an das Ende der mit <code>SYS_INFE_listID</code> angegebenen Liste. Da <code>spt:iterator</code> auch ein leeres Listen-Element anzeigt, wenn die Liste leer ist, werden zwei leere Listen-Elemente bei einer leeren Liste erzeugt.
@@ Zeile 188: / Zeile 190: @@
 ;<code>SYS_INFE_listId</code>
-:Die ID der Liste, oder des Listen-Element, auf das die Listen-Action <code>SYS_INFE_listAction</code> bezieht.
+:Die ID der Liste, oder des Listen-Elements, auf das sich die Listen-Action <code>SYS_INFE_listAction</code> bezieht.
 ==Fehlercodes==
@@ Zeile 199: / Zeile 200: @@
 <noinclude>
 [[Category:Handler]]
-[[Category:Qualität_der_Sprache_prüfen]]
-[[Category:Qualität_des_Codes_prüfen]]
 </noinclude>