Resource (Objekt)
Version vom 1. Juli 2008, 12:55 Uhr von Veltrup (Diskussion | Beiträge)
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, ist original mit id identisch
|
1 |
| withoutType | Number | ID-Teil ohne Typ-Definition | 1 |
| 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. Welche Sprache verwendet wird, wird über das locale-Attribute der Ausgabe-Tags bestimmt
|
1 |
| comment | String | Kommentar zu dem Artikel in der default-Sprache | 1 |
| localeComment | String | Sprachenspezifischer Kommentar. Welche Sprache verwendet wird, wird über das locale-Attribute 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. Ist diese Resource ein symbolischer Link, ist parent in der Liste nicht enthalten, dafür aber der Pools der originalen Resource.
|
1 |
| path | Collection <ArticlePool/Resource> | Liste aller übergeordenten Articlepools und diese Ressource. 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 Ressource 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 Attribute 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 |
| 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 Feldexternalgesetzt ist.
Boolean hasValidUrl(Publisher publisher)- Liefert
true, wenn das Feldexternalgesetzt ist.- Parameter
-
Publisher- Bei einem Resource-Objekt wird dieser Parameter nicht ausgewertet.
- Rückgabewert
-
- Boolean
true, wenn das Feldexternalgesetzt 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.deausgegeben.- 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.