ArticlePool (Objekt): Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
K (Hob den Schutz von „ArticlePool (Objekt)“ auf)
 
(14 dazwischenliegende Versionen von 4 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
 
==Name==
 
==Name==
ArticlePool - Pool in dem die [[Article|Artikel]], [[Media|Medien]] und [[Ressource|Resourcen]] strukturiert sind
+
ArticlePool - Pool in dem die [[Article|Artikel]], [[Media|Medien]] und [[Resource|Resourcen]] strukturiert sind
  
 
==Beschreibung==
 
==Beschreibung==
Ein ArticlePool ist ein Pool in dem die [[Article|Artikel]], [[Media|Medien]] und [[Ressource|Resourcen]] strukturiert sind.
+
Ein Artikelpool ist ein Pool in dem [[Article|Artikel]], [[Media|Medien]] und [[Resource|Resourcen]] zusammengefasst sind. Artikelpools dienen dabei auch dem Aufbau einer Verzeichnisstruktur auf dem Webserver, in denen [[Article|Artikel]] und [[Media|Medien]] über [[FilePublisher]] publiziert werden.
  
 
==Attribute==
 
==Attribute==
{| class="prettytable"
+
{| class="prettytable sortable"
 
|- class="hintergrundfarbe1"
 
|- class="hintergrundfarbe1"
 
! Attribut || Type || Beschreibung || ab IES Version
 
! Attribut || Type || Beschreibung || ab IES Version
 
|-
 
|-
| xxx
+
| id
 +
| [[ID]]
 +
| ID des Artikelpools
 +
| 1
 +
|-
 +
| original
 +
| [[ID]]
 +
| ist identisch mit <code>id</code>, da es für Artikelpools keine [[Symbolischer Link|symbolischen Links]] gibt
 +
| 1
 +
|-
 +
| withoutType
 +
| [[Number]]
 +
| ID-Teil ohne Typ-Definition
 +
| 1
 +
|-
 +
| withoutSignature
 
| [[Number]]
 
| [[Number]]
| xxx
+
| ID-Teil ohne Signatur- und Typ-Definition
 +
| 2.1.0.13
 +
|-
 +
| type
 +
| [[constants#ROOT_INFORMATION_POOL|system.constants.ROOT_INFORMATION_POOL]],<br/>[[constants#STANDARD_INFORMATION_POOL|system.constants.STANDARD_INFORMATION_POOL]]
 +
| Typ des Pools
 +
| 1
 +
|-
 +
| category
 +
| [[constants#INFORMATION_POOL|system.constants.INFORMATION_POOL]]
 +
| Typ des Objektes
 +
| 1
 +
|-
 +
| anchor
 +
| [[Anchor]]
 +
| Anchor des Pools
 +
| 1
 +
|-
 +
| name
 +
| [[String]]
 +
| Name des Pools in der <code>default</code>-Sprache
 +
| 1
 +
|-
 +
| localeName
 +
| [[String]]
 +
| Sprachenspezifischer Name. Welche Sprache verwendet wird, bestimmt das <code>locale</code>-Attribute des Ausgabe-Tags
 +
| 2
 +
|-
 +
| comment
 +
| [[String]]
 +
| Kommentar zu dem Pool in der default-Sprache
 +
| 1
 +
|-
 +
| localeComment
 +
| [[Text]]
 +
| Sprachenspezifischer Kommentar. Welche Sprache verwendet wird, bestimmt das <code>locale</code>-Attribute des Ausgabe-Tags
 +
| 2
 +
|-
 +
| parent
 +
| [[ArticlePool]]
 +
| Artikelpool in dem der Pool liegt
 +
| 1
 +
|-
 +
| stepParents
 +
| [[Collection]]&nbsp;<[[ArticlePool]]>
 +
| Liefert eine leere Liste, da es für Pools keine [[Symbolischer Link|symbolischen Links]] gibt
 +
| 1
 +
|-
 +
| path
 +
| [[Collection]]&nbsp;<[[ArticlePool]]>
 +
| Liste aller übergeordneten Artikelpools und dieser Pool. Das erste Element der Liste ist der Root-Pool. Das zweitletzte Element der Liste ist <code>parent</code>. Das letzte Element der Liste ist dieser Pool
 +
| 1
 +
|-
 +
| createdBy
 +
| [[User]]
 +
| [[User|Nutzer]], der diesen Pool erzeugt hat
 +
| 1
 +
|-
 +
| created
 +
| [[Date]]
 +
| Datum und Uhrzeit, zu dem dieser Pool erzeugt wurde
 +
| 1
 +
|-
 +
| changedBy
 +
| [[User]]
 +
| [[User|Nutzer]], der diesen Pool zuletzt geändert hat
 
| 1
 
| 1
 
|-
 
|-
| xxx
+
| changed
| [[Condition]]
+
| [[Date]]
| xxx
+
| Datum und Uhrzeit, zu dem dieser Pool das letzte mal geändert wurde
 
| 1
 
| 1
 
|-
 
|-
| xxx
+
| permissions
| [[Collection]]
+
| [[Permission]]
| xxx
+
| Gibt an, welche Rechte der [[User|Nutzer]], der dieses Objekt angefordert hat, auf dieses Objekt besitzt
 
| 1
 
| 1
 
|-
 
|-
| xxx
+
| lock
| [[Element]]
+
| [[Lock]]
| xxx
+
| Wenn dieses Attribut gesetzt ist, ist das Objekt von einem anderen [[User|Nutzer]] gelockt
 +
| 2
 +
|-
 +
| isReadOnly
 +
| [[Boolean]]
 +
| true, wenn der [[User|Nutzer]], der dieses Objekt angefordert hat nur lesend darauf zugreifen darf. Dies ist der Fall, wenn der [[User|Nutzer]] nur Leserechte auf dieses Objekt hat oder das Objekt von einem anderen [[User|Nutzer]] gelockt wurde
 
| 1
 
| 1
|}
 
 
==Methoden==
 
{| class="prettytable"
 
|- class="hintergrundfarbe1"
 
! Methode || Rückgabewert || Beschreibung || ab IES Version
 
 
|-
 
|-
| <code>xxx</code>
+
| dir
 
| [[String]]
 
| [[String]]
| xxx.
+
| Verzeichnis des Pools, in dem die [[Article|Artikel]] generiert werden sollen
 
| 1
 
| 1
 
|-
 
|-
| <code>xxx</code>
+
| absoluteDirectory
 
| [[String]]
 
| [[String]]
| xxx.
+
| Die komplette Verzeichnisstruktur, die sich aus den Verzeichnissen der übergeordneten Pools und dem Verzeichnis dieses Pools ergibt
 +
| 1
 +
|-
 +
| isElement
 +
| [[Boolean]]
 +
| ist immer false
 +
| 1
 +
|-
 +
| isPool
 +
| [[Boolean]]
 +
| ist immer true
 +
| 1
 +
|-
 +
| isSymbolicLink
 +
| [[Boolean]]
 +
| immer false, da es für Pools keine [[Symbolischer Link|symbolischen Links]] gibt
 +
| 1
 +
|-
 +
| elements
 +
| [[Collection]]&nbsp;<[[Article]]>
 +
| Liste der [[Article|Artikel]], [[Media|Medien]] und [[Resource|Resourcen]] dieses Pools
 +
| 1
 +
|-
 +
| allElements
 +
| [[Collection]]&nbsp;<[[Article]]>
 +
| Liste aller [[Article|Artikel]], [[Media|Medien]] und [[Resource|Resourcen]] dieses Pools und dessen Unter-Pools
 +
| 1
 +
|-
 +
| sortedElements
 +
| [[Collection]]&nbsp;<[[Article]]>
 +
| Liste der [[Article|Artikel]], [[Media|Medien]] und [[Resource|Resourcen]] dieses Pools sortiert nach dem Attribute <code>name</code>
 +
| 1
 +
|-
 +
| pools
 +
| [[Collection]]&nbsp;<[[ArticlePool]]>
 +
| Liste der Artikelpools dieses Pools
 +
| 1
 +
|-
 +
| allPools
 +
| [[Collection]]&nbsp;<[[ArticlePool]]>
 +
| Liste aller Artikelpools dieses Pools und dessen Unter-Pools
 
| 1
 
| 1
 +
|-
 +
| sortedPools
 +
| [[Collection]]&nbsp;<[[ArticlePool]]>
 +
| Liste der Artikelpools dieses Pools sortiert nach dem Attribute <code>name</code>
 +
| 1
 +
|-
 +
| hasChildren
 +
| [[Boolean]]
 +
| true, wenn der Pool weitere [[Article|Artikel]], [[Media|Medien]], [[Resource|Resourcen]] oder Pools enthält
 +
| 1
 +
|-
 +
! colspan="4" |<div class="note">
 +
Ein Pool kann beliebig viele weitere Attribute enthalten.
 +
Dies können normale Textfelder, aber auch Listen-, BinärInformation usw. sein.
 +
Alleine das [[Template]] zur Erzeugung und Änderung von Artikeln bestimmt diese Attribute
 +
</div>
 
|}
 
|}
 
;<code>xxx</code>
 
:xxx.
 
:;Parameter
 
::;<code>xxx</code>
 
:::xxx.
 
::;<code>xxx</code>
 
:::xxx.
 
:;Rückgabewert
 
::;[[String]]
 
:::xxx.
 
 
;<code>xxx</code>
 
:xxx.
 
:;Parameter
 
::;<code>xxx</code>
 
:::xxx.
 
::;<code>xxx</code>
 
:::xxx.
 
:;Rückgabewert
 
::;[[String]]
 
:::xxx.
 
  
  
 
<noinclude>
 
<noinclude>
 
[[Category:Objekte]]
 
[[Category:Objekte]]
[[Category:Qualität_des_Inhalts_prüfen]]
 
[[Category:Qualität_der_Sprache_prüfen]]
 
[[Category:Qualität_des_Codes_prüfen]]
 
 
</noinclude>
 
</noinclude>

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

Name

ArticlePool - Pool in dem die Artikel, Medien und Resourcen strukturiert sind

Beschreibung

Ein Artikelpool ist ein Pool in dem Artikel, Medien und Resourcen zusammengefasst sind. Artikelpools dienen dabei auch dem Aufbau einer Verzeichnisstruktur auf dem Webserver, in denen Artikel und Medien über FilePublisher publiziert werden.

Attribute

Attribut Type Beschreibung ab IES Version
id ID ID des Artikelpools 1
original ID ist identisch mit id, da es für Artikelpools keine symbolischen Links gibt 1
withoutType Number ID-Teil ohne Typ-Definition 1
withoutSignature Number ID-Teil ohne Signatur- und Typ-Definition 2.1.0.13
type system.constants.ROOT_INFORMATION_POOL,
system.constants.STANDARD_INFORMATION_POOL
Typ des Pools 1
category system.constants.INFORMATION_POOL Typ des Objektes 1
anchor Anchor Anchor des Pools 1
name String Name des Pools in der default-Sprache 1
localeName String Sprachenspezifischer Name. Welche Sprache verwendet wird, bestimmt das locale-Attribute des Ausgabe-Tags 2
comment String Kommentar zu dem Pool in der default-Sprache 1
localeComment Text Sprachenspezifischer Kommentar. Welche Sprache verwendet wird, bestimmt das locale-Attribute des Ausgabe-Tags 2
parent ArticlePool Artikelpool in dem der Pool liegt 1
stepParents Collection <ArticlePool> Liefert eine leere Liste, da es für Pools keine symbolischen Links gibt 1
path Collection <ArticlePool> Liste aller übergeordneten Artikelpools und dieser Pool. Das erste Element der Liste ist der Root-Pool. Das zweitletzte Element der Liste ist parent. Das letzte Element der Liste ist dieser Pool 1
createdBy User Nutzer, der diesen Pool erzeugt hat 1
created Date Datum und Uhrzeit, zu dem dieser Pool erzeugt wurde 1
changedBy User Nutzer, der diesen Pool zuletzt geändert hat 1
changed Date Datum und Uhrzeit, zu dem dieser Pool das letzte mal geändert wurde 1
permissions Permission Gibt an, welche Rechte der Nutzer, der dieses Objekt angefordert hat, auf dieses Objekt besitzt 1
lock Lock Wenn dieses Attribut gesetzt ist, ist das Objekt von einem anderen Nutzer gelockt 2
isReadOnly Boolean true, wenn der Nutzer, der dieses Objekt angefordert hat nur lesend darauf zugreifen darf. Dies ist der Fall, wenn der Nutzer nur Leserechte auf dieses Objekt hat oder das Objekt von einem anderen Nutzer gelockt wurde 1
dir String Verzeichnis des Pools, in dem die Artikel generiert werden sollen 1
absoluteDirectory String Die komplette Verzeichnisstruktur, die sich aus den Verzeichnissen der übergeordneten Pools und dem Verzeichnis dieses Pools ergibt 1
isElement Boolean ist immer false 1
isPool Boolean ist immer true 1
isSymbolicLink Boolean immer false, da es für Pools keine symbolischen Links gibt 1
elements Collection <Article> Liste der Artikel, Medien und Resourcen dieses Pools 1
allElements Collection <Article> Liste aller Artikel, Medien und Resourcen dieses Pools und dessen Unter-Pools 1
sortedElements Collection <Article> Liste der Artikel, Medien und Resourcen dieses Pools sortiert nach dem Attribute name 1
pools Collection <ArticlePool> Liste der Artikelpools dieses Pools 1
allPools Collection <ArticlePool> Liste aller Artikelpools dieses Pools und dessen Unter-Pools 1
sortedPools Collection <ArticlePool> Liste der Artikelpools dieses Pools sortiert nach dem Attribute name 1
hasChildren Boolean true, wenn der Pool weitere Artikel, Medien, Resourcen oder Pools enthält 1
Ein Pool kann beliebig viele weitere Attribute enthalten. 
Dies können normale Textfelder, aber auch Listen-, BinärInformation usw. sein. 
Alleine das Template zur Erzeugung und Änderung von Artikeln bestimmt diese Attribute