Resource (Objekt): Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
K (Hob den Schutz von „Resource (Objekt)“ auf)
 
(11 dazwischenliegende Versionen von 4 Benutzern werden nicht angezeigt)
Zeile 6: Zeile 6:
  
 
==Attribute==
 
==Attribute==
{| class="prettytable"
+
{| class="prettytable sortable"
 
|- class="hintergrundfarbe1"
 
|- class="hintergrundfarbe1"
 
! Attribut || Type || Beschreibung || ab IES Version
 
! Attribut || Type || Beschreibung || ab IES Version
Zeile 17: Zeile 17:
 
| original
 
| original
 
| [[ID]]
 
| [[ID]]
| ID der Original-Resource, wenn diese Resource nur ein Link auf die Original-Resource ist. Ist diese Resource die Original-Resource, ist <code>original</code> mit <code>id</code> identisch
+
| ID der Original-Resource, wenn diese Resource nur ein [[Symbolischer Link|symbolischer Link]] auf die Original-Resource ist. Ist diese Resource die Original-Resource, sind <code>original</code> und <code>id</code> identisch
 
| 1
 
| 1
 
|-
 
|-
Zeile 24: Zeile 24:
 
| ID-Teil ohne Typ-Definition
 
| ID-Teil ohne Typ-Definition
 
| 1
 
| 1
 +
|-
 +
| withoutSignature
 +
| [[Number]]
 +
| ID-Teil ohne Signatur- und Typ-Definition
 +
| 2.1.0.13
 
|-
 
|-
 
| type
 
| type
Zeile 52: Zeile 57:
 
| localeName
 
| localeName
 
| [[String]]
 
| [[String]]
| Sprachenspezifischer Name. Welche Sprache verwendet wird, wird über das <code>locale</code>-Attribute der Ausgabe-Tags bestimmt
+
| Sprachenspezifischer Name. Die zu verwendende Sprache, wird über das <code>locale</code>-Attribut der Ausgabe-Tags bestimmt
| 2
+
| 1
 
|-
 
|-
 
| comment
 
| comment
Zeile 62: Zeile 67:
 
| localeComment
 
| localeComment
 
| [[String]]
 
| [[String]]
| Sprachenspezifischer Kommentar. Welche Sprache verwendet wird, wird über das <code>locale</code>-Attribute der Ausgabe-Tags bestimmt
+
| Sprachenspezifischer Kommentar. Die zu verwendende Sprache, wird über das <code>locale</code>-Attribut der Ausgabe-Tags bestimmt
| 2
+
| 1
 
|-
 
|-
 
| parent
 
| parent
Zeile 71: Zeile 76:
 
|-
 
|-
 
| stepParents
 
| stepParents
| [[Collection]]
+
| [[Collection]]&nbsp;<[[ArticlePool]]>
| Liste der [[ArticlePool|ArticlePools]] in denen diese Resource noch verlinkt ist. Ist diese Resource ein Link, ist <code>parent</code> in der Liste nicht enthalten, dafür aber der Pools der originalen Resource.
+
| Liste der [[ArticlePool|ArticlePools]] in denen diese Resource über [[Symbolischer Link|symbolische Links]] verlinkt ist. Sollte diese Resource ein [[Symbolischer Link|symbolischer Link]] sein, ist <code>parent</code> in der Liste nicht enthalten, dafür aber in den Pools der originalen Resource.
 
| 1
 
| 1
 
|-
 
|-
 
| path
 
| path
| [[Collection]]
+
| [[Collection]]&nbsp;<[[ArticlePool]]/[[Resource]]>
| Liste aller übergeordenten Articlepools und diese Ressource. Das erste Element der Liste ist der Root-Pool. Das zweitletzte Element der Liste ist <code>parent</code>. Das letzte Element der Liste ist diese Ressource
+
| Liste aller übergeordneten Artikelpools und diese Resource. Das erste Element der Liste ist der Root-Pool. Das zweitletzte Element der Liste ist <code>parent</code>. Das letzte Element der Liste ist diese Ressource
 
| 1
 
| 1
 
|-
 
|-
Zeile 127: Zeile 132:
 
| isSymbolicLink
 
| isSymbolicLink
 
| [[Boolean]]
 
| [[Boolean]]
| <code>true</code>, wenn diese Resource nur ein Link auf die Original-Resource ist
+
| <code>true</code>, wenn diese Resource nur ein [[Symbolischer Link|symbolischer Link]] auf die Original-Resource ist
 
| 1
 
| 1
 
|-
 
|-
 
| history
 
| history
| [[Collection]]
+
| [[Collection]]&nbsp;<[[HistoryEntry]]>
 
| Liste von [[HistoryEntry]]-Objekten, die alle Aktionen auf dieses Objekte beschreiben
 
| Liste von [[HistoryEntry]]-Objekten, die alle Aktionen auf dieses Objekte beschreiben
 
| 1
 
| 1
Zeile 137: Zeile 142:
 
| isEmpty
 
| isEmpty
 
| [[Boolean]]
 
| [[Boolean]]
| <code>true</code>, wenn die Ressource keine Informations-Objekte enthält
+
| <code>true</code>, wenn die Resource keine Informations-Objekte enthält
 
| 1
 
| 1
 
|-
 
|-
 
| all
 
| all
| [[Collection]]
+
| [[Collection]]&nbsp;<[[Information]]>
 
| Liefert eine Liste alle Informations-Objekte
 
| Liefert eine Liste alle Informations-Objekte
 
| 1
 
| 1
 
|-
 
|-
 
| flat
 
| flat
| [[Collection]]
+
| [[Collection]]&nbsp;<[[Information]]>
 
| Liefert eine Liste aller [[Information|Informations]]-Objekte ohne Struktierungs-Objekt wie [[ListInformation|ListInformations]], [[ListItemInformation|ListItemInformations]] oder [[SubInformation|SubInformations]]
 
| Liefert eine Liste aller [[Information|Informations]]-Objekte ohne Struktierungs-Objekt wie [[ListInformation|ListInformations]], [[ListItemInformation|ListItemInformations]] oder [[SubInformation|SubInformations]]
 
| 1
 
| 1
Zeile 152: Zeile 157:
 
| isPublished
 
| isPublished
 
| [[Boolean]]
 
| [[Boolean]]
| Dieses Attribute ist im [[Template-Modus|Out-Modus]] gültig. Es zeigt an, ob dieser Artikel für den aktuellen [[Publisher]] freigegeben ist
+
| Dieses Attribut ist im [[Template-Modus|Out-Modus]] gültig. Es zeigt an, ob dieser Artikel für den aktuellen [[Publisher]] freigegeben ist
 
| 1
 
| 1
 
|-
 
|-
Zeile 176: Zeile 181:
 
|-
 
|-
 
| publicationStates
 
| publicationStates
| [[Collection]]
+
| [[Collection]]&nbsp;<[[PublicationState]]>
 
| Liste von [[PublicationState]]-Objekten, die die Stati für jeden [[Publisher]], in denen diese Resource publiziert ist, enhalten
 
| Liste von [[PublicationState]]-Objekten, die die Stati für jeden [[Publisher]], in denen diese Resource publiziert ist, enhalten
 
| 1
 
| 1
 +
|-
 +
| publishedIn
 +
| [[Collection]]&nbsp;<[[Publisher]]>
 +
| Liste von [[Publisher]]-Objekten, in denen die Resource publiziert ist
 +
| 2.1.0
 +
|-
 +
| referrerLinks
 +
| [[Collection]]&nbsp;<[[IDLink]]>
 +
| Liste von [[IDLink]]-Objekten, die die Links auf diese Resource beschreiben.
 +
| 2.1.0
 
|-
 
|-
 
| external
 
| external
Zeile 196: Zeile 211:
 
! Methode || Rückgabewert || Beschreibung || ab IES Version
 
! Methode || Rückgabewert || Beschreibung || ab IES Version
 
|-
 
|-
| <code>isPublished([[Publisher]])</code>
+
| <code>isPublished([[Publisher]] publisher)</code>
 
| [[Boolean]]
 
| [[Boolean]]
| Liefert <code>true</code>, wenn der Artikel für den angegebenen [[Publisher]] publiziert ist
+
| Liefert <code>true</code>, wenn der Artikel für den angegebenen Publisher publiziert ist
 
| 1
 
| 1
 
|-
 
|-
| <code>hasValidUrl([[Publisher]])</code>
+
| <code>hasValidUrl([[Publisher]] publisher)</code>
 
| [[Boolean]]
 
| [[Boolean]]
 
| Liefert <code>true</code>, wenn das Feld <code>external</code> gesetzt ist
 
| Liefert <code>true</code>, wenn das Feld <code>external</code> gesetzt ist
 
| 1
 
| 1
 
|-
 
|-
| <code>url([[Publisher]])</code>
+
| <code>url([[Publisher]] publisher)</code>
 
| [[URL]]
 
| [[URL]]
 
| Liefert den Inhalt des Feldes <code>external</code>
 
| Liefert den Inhalt des Feldes <code>external</code>
 
| 1
 
| 1
 
|-
 
|-
| <code>absoluteUrl([[Publisher]])</code>
+
| <code>absoluteUrl([[Publisher]] publisher)</code>
 
| [[URL]]
 
| [[URL]]
 
| Liefert den Inhalt des Feldes <code>external</code>
 
| Liefert den Inhalt des Feldes <code>external</code>
 
| 1
 
| 1
 
|-
 
|-
| <code>relativeUrl([[Publisher]])</code>
+
| <code>relativeUrl([[Publisher]] publisher)</code>
 
| [[URL]]
 
| [[URL]]
 
| Liefert den Inhalt des Feldes <code>external</code>
 
| Liefert den Inhalt des Feldes <code>external</code>
 
| 1
 
| 1
 
|-
 
|-
| <code>publicationState([[Publisher]])</code>
+
| <code>publicationState([[Publisher]] publisher)</code>
 
| [[PublicationState]]
 
| [[PublicationState]]
| Liefert für den angegebenen [[Publisher]] den Publikationsstatus
+
| Liefert für den angegebenen Publisher den Publikationsstatus
 
| 1
 
| 1
 
|}
 
|}
  
;<code>isPublished([[Publisher]])</code>
+
;<code>[[Boolean]] isPublished([[Publisher]] publisher)</code>
:Liefert <code>true</code>, wenn die Resource für den angegebenen [[Publisher]] publiziert ist.
+
:Liefert <code>true</code>, wenn die Resource für den angegebenen Publisher publiziert ist.
 
:;Parameter
 
:;Parameter
::;<code>[[Publisher]]</code>
+
::;<code>Publisher</code>
 
:::Publisher, für den geprüft werden soll, ob die Resource für diesen publiziert ist.
 
:::Publisher, für den geprüft werden soll, ob die Resource für diesen publiziert ist.
 
:;Rückgabewert
 
:;Rückgabewert
::;[[Boolean]]
+
::;Boolean
 
:::<code>true</code>, wenn das Feld <code>external</code> gesetzt ist.
 
:::<code>true</code>, wenn das Feld <code>external</code> gesetzt ist.
  
;<code>hasValidUrl([[Publisher]])</code>
+
;<code>[[Boolean]] hasValidUrl([[Publisher]] publisher)</code>
 
:Liefert <code>true</code>, wenn das Feld <code>external</code> gesetzt ist.
 
:Liefert <code>true</code>, wenn das Feld <code>external</code> gesetzt ist.
 
:;Parameter
 
:;Parameter
::;<code>[[Publisher]]</code>
+
::;<code>Publisher</code>
 
:::Bei einem Resource-Objekt wird dieser Parameter nicht ausgewertet.
 
:::Bei einem Resource-Objekt wird dieser Parameter nicht ausgewertet.
 
:;Rückgabewert
 
:;Rückgabewert
::;[[Boolean]]
+
::;Boolean
 
:::<code>true</code>, wenn das Feld <code>external</code> gesetzt ist.
 
:::<code>true</code>, wenn das Feld <code>external</code> gesetzt ist.
  
;<code>url([[Publisher]])</code>
+
;<code>[[URL]] url([[Publisher]] publisher)</code>
:Liefert die [[URL]] des Artikels, wenn der Artikel für den angegebenen [[Publisher]] freigegeben ist. Mit dieser Methode wird die [[URL]] beginnend ab dem Dokument-Root (<code>/</code>) ausgegeben.
+
:Liefert die URL des Artikels, wenn der Artikel für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL beginnend ab dem Dokument-Root (<code>/</code>) ausgegeben.
 
:;Parameter
 
:;Parameter
::;<code>[[Publisher]]</code>
+
::;<code>Publisher</code>
 
:::Bei einem Resource-Objekt wird dieser Parameter nicht ausgewertet.
 
:::Bei einem Resource-Objekt wird dieser Parameter nicht ausgewertet.
 
:;Rückgabewert
 
:;Rückgabewert
::;[[URL]]
+
::;URL
 
:::Liefert den Inhalt des Feldes <code>external</code>.
 
:::Liefert den Inhalt des Feldes <code>external</code>.
  
;<code>absoluteUrl([[Publisher]])</code>
+
;<code>[[URL]] absoluteUrl([[Publisher]] publisher)</code>
:Liefert die [[URL]] des Artikels, wenn der Artikel für den angegebenen [[Publisher]] freigegeben ist. Mit dieser Methode wird die [[URL]] mit <code>http://www.domain.de</code> ausgegeben.
+
:Liefert die URL des Artikels, wenn der Artikel für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL mit <code><nowiki>http://www.domain.de</nowiki></code> ausgegeben.
 
:;Parameter
 
:;Parameter
::;<code>[[Publisher]]</code>
+
::;<code>Publisher</code>
 
:::Bei einem Resource-Objekt wird dieser Parameter nicht ausgewertet.
 
:::Bei einem Resource-Objekt wird dieser Parameter nicht ausgewertet.
 
:;Rückgabewert
 
:;Rückgabewert
::;[[URL]]
+
::;URL
 
:::Liefert den Inhalt des Feldes <code>external</code>.
 
:::Liefert den Inhalt des Feldes <code>external</code>.
  
;<code>relativeUrl([[Publisher]])</code>
+
;<code>[[URL]] relativeUrl([[Publisher]] publisher)</code>
:Liefert die [[URL]] des Artikels, wenn der Artikel für den angegebenen [[Publisher]] freigegeben ist. Mit dieser Methode wird die [[URL]] relativ zum aktuellen Artikel ausgegeben.
+
:Liefert die URL des Artikels, wenn der Artikel für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL relativ zum aktuellen Artikel ausgegeben.
 
:;Parameter
 
:;Parameter
::;<code>[[Publisher]]</code>
+
::;<code>Publisher</code>
 
:::Bei einem Resource-Objekt wird dieser Parameter nicht ausgewertet.
 
:::Bei einem Resource-Objekt wird dieser Parameter nicht ausgewertet.
 
:;Rückgabewert
 
:;Rückgabewert
::;[[URL]]
+
::;URL
 
:::Liefert den Inhalt des Feldes <code>external</code>.
 
:::Liefert den Inhalt des Feldes <code>external</code>.
  
;<code>publicationState([[Publisher]])</code>
+
;<code>[[PublicationState]] publicationState([[Publisher]] publisher)</code>
:Liefert den [[PublicationState|Publikations-Status]] des Artikels für den angegebenen [[Publisher]].
+
:Liefert den Publikations-Status des Artikels für den angegebenen Publisher.
 
:;Parameter
 
:;Parameter
::;<code>[[Publisher]]</code>
+
::;<code>Publisher</code>
:::Publisher für den der [[PublicationState|Publikations-Status]] ausgegeben werden soll.
+
:::Publisher für den der Publikations-Status ausgegeben werden soll.
 
:;Rückgabewert
 
:;Rückgabewert
::;[[PublicationState]]
+
::;PublicationState
:::[[PublicationState|Publikations-Status]] der Resource für den angegebenen [[Publisher]].
+
:::Publikations-Status der Resource für den angegebenen Publisher.
  
 
<noinclude>
 
<noinclude>
 
[[Category:Objekte]]
 
[[Category:Objekte]]
[[Category:Qualität_der_Sprache_prüfen]]
 
 
[[Category:Qualität_des_Codes_prüfen]]
 
[[Category:Qualität_des_Codes_prüfen]]
 
</noinclude>
 
</noinclude>

Aktuelle Version vom 24. Februar 2010, 13:23 Uhr

Name

Resource - Daten, die nicht von einem Publisher verarbeitet werden können

Beschreibung

Resourcen sind Daten, die nur in der Datenbank vorgehalten werden und nicht von einem Publisher verarbeitet werden können. Resourcen können keine Seiten generieren und benötigen somit auch kein Ausgabe-Template.

Attribute

Attribut Type Beschreibung ab IES Version
id ID ID der Resource 1
original ID ID der Original-Resource, wenn diese Resource nur ein symbolischer Link auf die Original-Resource ist. Ist diese Resource die Original-Resource, sind original und id identisch 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.RESOURCE_ARTICLE Typ des Artikels 1
category system.constants.INFORMATION Typ des Objektes 1
version Date Die Version der Resource entspricht dem Zeitstempel, zu dem dieser Stand erzeugt wurde 1
anchor Anchor Anchor der Resource 1
name String Name des Artikels in der default-Sprache 1
localeName String Sprachenspezifischer Name. Die zu verwendende Sprache, wird über das locale-Attribut der Ausgabe-Tags bestimmt 1
comment String Kommentar zu dem Artikel in der default-Sprache 1
localeComment String Sprachenspezifischer Kommentar. Die zu verwendende Sprache, wird über das locale-Attribut der Ausgabe-Tags bestimmt 1
parent ArticlePool Artikelpool in dem die Ressource liegt 1
stepParents Collection <ArticlePool> Liste der ArticlePools in denen diese Resource über symbolische Links verlinkt ist. Sollte diese Resource ein symbolischer Link sein, ist parent in der Liste nicht enthalten, dafür aber in den Pools der originalen Resource. 1
path Collection <ArticlePool/Resource> Liste aller übergeordneten Artikelpools und diese Resource. Das erste Element der Liste ist der Root-Pool. Das zweitletzte Element der Liste ist parent. Das letzte Element der Liste ist diese Ressource 1
createdBy User Nutzer, der diese Ressource erzeugt hat 1
created Date Datum und Uhrzeit, zu dem diese Ressource erzeugt wurde 1
changedBy User Nutzer, der diese Ressource zuletzt geändert hat 1
changed Date Datum und Uhrzeit, zu dem diese Ressource 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 diese Objekt hat oder das Objekt von einem anderen Nutzer gelockt wurde 1
isElement Boolean ist immer true 1
isPool Boolean ist immer false 1
isSymbolicLink Boolean true, wenn diese Resource nur ein symbolischer Link auf die Original-Resource ist 1
history Collection <HistoryEntry> Liste von HistoryEntry-Objekten, die alle Aktionen auf dieses Objekte beschreiben 1
isEmpty Boolean true, wenn die Resource keine Informations-Objekte enthält 1
all Collection <Information> Liefert eine Liste alle Informations-Objekte 1
flat Collection <Information> Liefert eine Liste aller Informations-Objekte ohne Struktierungs-Objekt wie ListInformations, ListItemInformations oder SubInformations 1
isPublished Boolean Dieses Attribut ist im Out-Modus gültig. Es zeigt an, ob dieser Artikel für den aktuellen Publisher freigegeben ist 1
hasValidUrl (deprecated) Boolean Liefert true, wenn das Feld external gesetzt ist 1
url URL Liefert den Inhalt des Feldes external 1
absoluteUrl URL Liefert den Inhalt des Feldes external 1
relativeUrl URL Liefert den Inhalt des Feldes external 1
publicationStates Collection <PublicationState> Liste von PublicationState-Objekten, die die Stati für jeden Publisher, in denen diese Resource publiziert ist, enhalten 1
publishedIn Collection <Publisher> Liste von Publisher-Objekten, in denen die Resource publiziert ist 2.1.0
referrerLinks Collection <IDLink> Liste von IDLink-Objekten, die die Links auf diese Resource beschreiben. 2.1.0
external String Dieses Feld kann eine externe URL enhalten, die die Resource repräsentiert. Dieses Feld wird auch für hasValidUrl ausgewertet 1
??? ??? Ein Artikel 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. 1

Methoden

Methode Rückgabewert Beschreibung ab IES Version
isPublished(Publisher publisher) Boolean Liefert true, wenn der Artikel für den angegebenen Publisher publiziert ist 1
hasValidUrl(Publisher publisher) Boolean Liefert true, wenn das Feld external gesetzt ist 1
url(Publisher publisher) URL Liefert den Inhalt des Feldes external 1
absoluteUrl(Publisher publisher) URL Liefert den Inhalt des Feldes external 1
relativeUrl(Publisher publisher) URL Liefert den Inhalt des Feldes external 1
publicationState(Publisher publisher) PublicationState Liefert für den angegebenen Publisher den Publikationsstatus 1
Boolean isPublished(Publisher publisher)
Liefert true, wenn die Resource für den angegebenen Publisher publiziert ist.
Parameter
Publisher
Publisher, für den geprüft werden soll, ob die Resource für diesen publiziert ist.
Rückgabewert
Boolean
true, wenn das Feld external gesetzt ist.
Boolean hasValidUrl(Publisher publisher)
Liefert true, wenn das Feld external gesetzt ist.
Parameter
Publisher
Bei einem Resource-Objekt wird dieser Parameter nicht ausgewertet.
Rückgabewert
Boolean
true, wenn das Feld external gesetzt ist.
URL url(Publisher publisher)
Liefert die URL des Artikels, wenn der Artikel für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL beginnend ab dem Dokument-Root (/) ausgegeben.
Parameter
Publisher
Bei einem Resource-Objekt wird dieser Parameter nicht ausgewertet.
Rückgabewert
URL
Liefert den Inhalt des Feldes external.
URL absoluteUrl(Publisher publisher)
Liefert die URL des Artikels, wenn der Artikel für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL mit http://www.domain.de ausgegeben.
Parameter
Publisher
Bei einem Resource-Objekt wird dieser Parameter nicht ausgewertet.
Rückgabewert
URL
Liefert den Inhalt des Feldes external.
URL relativeUrl(Publisher publisher)
Liefert die URL des Artikels, wenn der Artikel für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL relativ zum aktuellen Artikel ausgegeben.
Parameter
Publisher
Bei einem Resource-Objekt wird dieser Parameter nicht ausgewertet.
Rückgabewert
URL
Liefert den Inhalt des Feldes external.
PublicationState publicationState(Publisher publisher)
Liefert den Publikations-Status des Artikels für den angegebenen Publisher.
Parameter
Publisher
Publisher für den der Publikations-Status ausgegeben werden soll.
Rückgabewert
PublicationState
Publikations-Status der Resource für den angegebenen Publisher.