Parameterelemente für Dateien

Auf Dateien kann man mit Funktionselementen zugreifen. Mit dem obj-get-Element können beispielsweise die Werte sämtlicher Dateiparameter ermittelt werden. Welche Parameter ausgelesen oder gesetzt werden sollen, spezifiziert man mit Hilfe von Parameterelementen. Im Folgenden werden die Parameterelemente für Dateien aufgeführt.

archivedContents
Bedeutung: Liefert die Liste der IDs der archivierten Versionen der Datei.

Definition:

<!ELEMENT archivedContents ((content)* | (listitem)*)>
<!ELEMENT content (%cm.content-get;)>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>

cm.content-get: siehe <content-where> <content-get> oder CRUL als DTD.

children
Bedeutung: Liste der IDs der Dateien in einem Ordner.

Definition:

<!ELEMENT children ((obj)* | (listitem)*)>
<!ELEMENT obj (%cm.obj-get;)>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>

cm.obj-get: siehe <obj-where> <obj-get> oder CRUL als DTD.

committedContentId
Bedeutung: Liefert die ID der eingereichten Version einer Datei, sofern sie eine solche Version hat.

Definition:

<!ELEMENT committedContentId (%cm.atom; | %cm.content-get;)*>

cm.content-get: siehe <content-where> <content-get> oder CRUL als DTD.

contentIds
Bedeutung: Liefert die Liste der IDs aller Versionen der Datei.

Definition:

<!ELEMENT contentIds ((content)* | (listitem)*)>
<!ELEMENT content (%cm.content-get;)>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>

cm.content-get: siehe <content-where> <content-get> oder CRUL als DTD.

contents
Bedeutung: Liefert die Liste der IDs aller Versionen der Datei.

Definition:

<!ELEMENT contents ((content)* | (listitem)*)>
<!ELEMENT content (%cm.content-get;)>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>

cm.content-get: siehe <content-where> <content-get> oder CRUL als DTD.

exportContent
Bedeutung: Liefert die ID der Exportversion einer Datei. Wird als Attributwert von wantReleased der Wert 1 angegeben, so liefert exportContent die ID der freigegebenen Version. Gibt es keine freigegebene Version, so wird die ID der eingereichten Version zurückgegeben. Existiert auch diese nicht, wird die ID der Arbeitsversion geliefert. Wird der Attributwert 0 oder kein Attributwert angegeben, so wird die ID der Arbeitsversion geliefert. Falls diese nicht existiert, wird die ID der eingereichten Version und wenn auch diese nicht vorhanden ist, die ID der freigegebenen Version zurückgegeben.
exportContent kann ferner verwendet werden, um Eigenschaften der Exportversion abzufragen.

Definition:

<!ELEMENT exportContent (%cm.atom; | %cm.content-get;)*>
<!ATTLIST exportContent
          wantReleased (0 | 1) #IMPLIED
>

cm.content-get: siehe <content-where> <content-get> oder CRUL als DTD.

Bedeutung der Attribute:

  • wantReleased: gibt an, ob die ID der freigegebenen Version ermittelt werden soll.

Beispiel:

<cm-request...>
  <obj-where>
    <id>21463</id>
  </obj-where>
  <obj-get>
    <exportContent wantReleased="1"/>
  </obj-get>
</cm-request>

<cm-response...>
  <cm-code numeric="0" phrase="ok">
    <obj>
      <exportContent wantReleased="1">21463.35</exportContent>
    </obj>
  </cm-code>
</cm-response>
editedContent
Bedeutung: Liefert die ID der Arbeitsversion einer Datei, sofern sie eine solche Version hat.

Definition:

<!ELEMENT editedContent (%cm.atom; | %cm.content-get;)*>

cm.content-get: siehe <content-where> <content-get> oder CRUL als DTD.

editedContentId
Bedeutung: Liefert die ID der Arbeitsversion einer Datei, sofern sie eine solche Version hat.

Definition:

<!ELEMENT editedContentId (%cm.atom; | %cm.content-get;)*>

cm.content-get: siehe <content-where> <content-get> oder CRUL als DTD.

exportMimeType
Bedeutung: Der Mime-Typ zur Dateiendung der freigegebenen (oder, falls diese nicht existiert, der Arbeits-) Version.

Definition:

<!ELEMENT exportMimeType (%cm.atom;)>
getKeys
Bedeutung: Die Liste der mit obj-get abfragbaren Parameter.

Definition:

<!ELEMENT getKeys (listitem)*>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>
hasChildren
Bedeutung: Gibt an, ob die Datei ein Ordner ist, der Dateien enthält.

Definition:

<!ELEMENT hasChildren (%cm.atom;)>
hasSuperLinks
Bedeutung: Gibt an, ob auf die Datei mit Links verwiesen wird, die in der Linkverwaltung erfasst sind.

Definition:

<!ELEMENT hasSuperLinks (%cm.atom;)>
hierarchy
Bedeutung: Liefert die unterhalb der Datei liegende Dateihierarchie zurück.

Definition:

<!ELEMENT hierarchy (%cm.listitem;)*>
<!ATTLIST hierarchy
          maxDepth CDATA #IMPLIED
          maxLines CDATA #IMPLIED
          document (0 | 1) #IMPLIED
          generic (0 | 1) #IMPLIED
          image (0 | 1) #IMPLIED
          publication (0 | 1) #IMPLIED
          template (0 | 1) #IMPLIED>

Bedeutung der Attribute:

  • maxDepth: gibt die maximale Tiefe an, die die ermittelte Hierarchie aufweisen darf.
  • maxLines: gibt die Anzahl der Dateien an, die maximal in der Hierarchie enthalten sein dürfen.
  • document: gibt an, ob die Hierachie Dateien vom Typ Dokument enthalten soll oder nicht.
  • generic: gibt an, ob die Hierachie Dateien vom Typ Ressource enthalten soll oder nicht.
  • image: gibt an, ob die Hierachie Dateien vom Typ Bild enthalten soll oder nicht.
  • publication: gibt an, ob die Hierachie Dateien vom Typ publication enthalten soll oder nicht. Fehlt der Typ publication, so ergibt sich keine Hierarchie.
  • template: gibt an, ob die Hierachie Dateien vom Typ template enthalten soll oder nicht.

Beispiel:

<cm-request...>
  <obj-where>
    <id>7657</id>
  </obj-where>
  <obj-get>
    <hierarchy maxDepth="2" document="1" publication="1" template="0"/>
  </obj-get>
</cm-request>

<cm-response...>
  <cm-code numeric="0" phrase="ok">
    <obj>
      <hierarchy maxDepth="2">
        <listitem>0</listitem>
        <listitem>
          <listitem>87243</listitem>
        </listitem>
        <listitem>
          <listitem>
            <listitem>12654</listitem>
          </listitem>
        </listitem>
      </hierarchy>
    </obj>
  </cm-code>
</cm-response>
id
Bedeutung: Die Datei-ID. Der Wert dieses Feldes kann auch ohne Dateileserecht abgefragt werden.

Definition:

<!ELEMENT id (%cm.atom;)>
isCommitted
Bedeutung: Gibt an, ob die Datei eine eingereichte Version hat.

Definition:

<!ELEMENT isCommitted (%cm.atom;)>
isEdited
Bedeutung: Gibt an, ob die Datei eine Arbeitsversion hat.

Definition:

<!ELEMENT isEdited (%cm.atom;)>
isExportable
Bedeutung: Gibt an, ob die Datei eine freigegebene und zeitlich gültige Version hat (prüft validFrom und validUntil).

Definition:

<!ELEMENT isExportable (%cm.atom;)>
isGoodDestination
Bedeutung: Liefert 1, wenn die Datei ein zulässiges Ziel des Links mit der als Argument angegebenen ID ist. Andernfalls liefert sie 0.

Definition:

<!ELEMENT isGoodDestination (%cm.atom;)>
<!ATTLIST isGoodDestination
          linkId CDATA #REQUIRED
>

Bedeutung der Attribute:

  • linkId: spezifiziert einen Link.

Beispiel:

<cm-request...>
  <obj-where>
    <id>56432</id>
  </obj-where>
  <obj-get>
    <isGoodDestination linkId="66311.35.4"/>
  </obj-get>
</cm-request>

<cm-response...>
  <cm-code numeric="0" phrase="ok">
    <obj>
      <isGoodDestination linkId="66311.35.4"/>1</isGoodDestination>
    </obj>
  </cm-code>
</cm-response>
isGoodParent
Bedeutung: Liefert 1, wenn die Vorlage der Datei eine der erlaubten Vorlagen für Dateien in dem Ordner mit der angegebenen ID ist. Andernfalls ist der Rückgabewert 0.

Definition:

<!ELEMENT isGoodParent (%cm.atom;)>
<!ATTLIST isGoodParent
          objectId CDATA #REQUIRED
          operation (move | copy) #REQUIRED
>

Bedeutung der Attribute:

  • objectId: spezifiziert eine Datei.
  • operation: spezifiziert die Operation (kopieren oder verschieben), die für die Datei ausgeführt werden soll.

Beispiel:

<cm-request...>
  <obj-where>
    <nameLike>Art</nameLike>
  </obj-where>
  <obj-get>
    <isGoodParent objectId="76576" operation="move"/>
  </obj-get>
</cm-request>

<cm-response...>
  <cm-code numeric="0" phrase="ok">
    <obj>
      <isGoodParent objectId="76576" operation="move"/>1</isGoodParent>
    </obj>
  </cm-code>
</cm-response>
isReleased
Bedeutung: Gibt an, ob die Datei eine freigegebene Version hat.

Definition:

<!ELEMENT isReleased (%cm.atom;)>
isRoot
Bedeutung: Gibt an, ob die Datei der Basisordner ist.

Definition:

<!ELEMENT isRoot (%cm.atom;)>
name
Bedeutung: Der Name der Datei. Der Wert dieses Feldes kann auch ohne Dateileserecht abgefragt werden.

Definition:

<!ELEMENT name (%cm.atom;)>
next
Bedeutung: Die ID der Datei, die in dem darüber liegenden Ordner der Nachfolger der spezifizierten Datei ist.

Definition:

<!ELEMENT next (%cm.atom;)>
objClass
Bedeutung: Der Name der Vorlage der Datei.

Definition:

<!ELEMENT objClass (%cm.atom; | %cm.objClass-get;)*>

cm.objClass-get: siehe <objClass-where> <objClass-get> oder CRUL als DTD.

objType
Bedeutung: Der Dateityp.

Definition:

<!ELEMENT objType (%cm.atom;)>
objectsToRoot
Bedeutung: Die Liste der IDs der Dateien, die auf dem Pfad von der Datei zum Basisordner liegen (jeweils einschließlich).

Definition:

<!ELEMENT objectsToRoot ((obj)* | (listitem)*)>
<!ELEMENT obj (%cm.obj-get;)>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>

cm.obj-get: siehe <obj-where> <obj-get> oder CRUL als DTD.

parent
Bedeutung: Die ID der Datei, in der die spezifizierte Datei direkt enthalten ist.

Definition:

<!ELEMENT parent (%cm.atom; | %cm.obj-get;)*>

cm.obj-get: siehe <obj-where> <obj-get> oder CRUL als DTD.

path
Bedeutung: Der Pfad der Datei (gebildet aus den Namen der darüber liegenden Dateien). Der Wert dieses Feldes kann auch ohne Dateileserecht abgefragt werden.

Definition:

<!ELEMENT path (%cm.atom;)>
permission
Bedeutung: Liefert die Liste der Gruppen, die das angegebene Recht für den Zugriff auf die Datei haben.

Definition:

<!ELEMENT permission ((group)* | (%cm.listitem;)*)>
<!ATTLIST permission
              permission (permissionCreateChildren |
                          permissionWrite | 
                          permissionRead | 
                          permissionRoot |
                          permissionLiverServerRead) #REQUIRED
>
<!ELEMENT group (%cm.group-get;)>

cm.group-get: siehe <group-where> <group-get> oder CRUL als DTD.

Bedeutung der Attribute:

  • permission: spezifiziert ein dateispezifisches Recht.

Beispiel:

<cm-request...>
  <obj-where>
    <title>newsArticlexyz</title>
  </obj-where>
  <obj-get>
    <permission permission="permissionWrite"/>
  </obj-get>
</cm-request>

<cm-response...>
  <cm-code numeric="0" phrase="ok">
    <obj>
      <permission permission="permissionWrite">
        <group>
          <name>NewsMasters</name>
        </group>
      </permission>
    </obj>
  </cm-code>
</cm-response>
permissionGrantedTo
Bedeutung: Prüft, ob ein Benutzer oder eine Gruppe das angegebene Recht für den Zugriff auf die Datei hat (1 = hat das Recht; 0 = hat das Recht nicht).

Definition:

<!ELEMENT permissionGrantedTo (%cm.atom;)>
<!ATTLIST permissionGrantedTo
          permission (permissionCreateChildren |
                      permissionWrite | 
                      permissionRead | 
                      permissionRoot |
                      permissionLiverServerRead) #REQUIRED
          user CDATA #IMPLIED
          group CDATA #IMPLIED
>

Bedeutung der Attribute:

  • permission: spezifiziert ein dateispezifisches Recht.
  • user: spezifiziert den Anmeldenamen eines Benutzers.
  • group: spezifiziert den Namen einer Benutzergruppe.

Beispiel:

<cm-request...>
  <obj-where>
    <id>853875</id>
  </obj-where>
  <obj-get>
    <permissionGrantedTo permission="permissionWrite" user="elton"/>
  </obj-get>
</cm-request>

<cm-response...>
  <cm-code numeric="0" phrase="ok">
    <obj>
      <permissionGrantedTo permission="permissionWrite" user="elton">1
      </permissionGrantedTo>
    </obj>
  </cm-code>
</cm-response>
prefixPath
Bedeutung: Der Pfad der Datei, bei Ordnern mit einem „/" am Ende.

Definition:

<!ELEMENT prefixPath (%cm.atom;)>
previous
Bedeutung: Die ID der Datei, die in dem darüber liegenden Ordner der Vorgänger der spezifizierten Datei ist.

Definition:

<!ELEMENT previous (%cm.atom; | %cm.obj-get;)*>

cm.obj-get: siehe <obj-where> <obj-get> oder CRUL als DTD.

releasedContent
Bedeutung: Liefert die ID der freigegebenen Version einer Datei, sofern sie eine solche Version hat.

Definition:

<!ELEMENT releasedContent (%cm.atom; | %cm.content-get;)*>

cm.content-get: siehe <content-where> <content-get> oder CRUL als DTD.

releasedContentId
Bedeutung: Liefert die ID der freigegebenen Version einer Datei, sofern sie eine solche Version hat.

Definition:

<!ELEMENT releasedContentId (%cm.atom; | %cm.content-get;)*>

cm.content-get: siehe <content-where> <content-get> oder CRUL als DTD.

releasedVersions
Bedeutung: Die Liste der IDs aller bereits freigegebenen Versionen der Datei (aktuelle freigegebene Version und alle archivierten Versionen).

Definition:

<!ELEMENT releasedVersions ((content)* | (listitem)*)>
<!ELEMENT content (%cm.content-get;)>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>

cm.content-get: siehe <content-where> <content-get> oder CRUL als DTD.

rootPermissionFor
Bedeutung: Prüft, ob ein Benutzer oder eine Gruppe das Administrationsrecht für die Datei hat oder Superuser ist. Bei Erfolg wird 1 zurückgegeben; andernfalls 0.

Definition:

<!ELEMENT rootPermissionFor (%cm.atom;)>
<!ATTLIST rootPermissionFor user CDATA #IMPLIED group CDATA #IMPLIED>

Bedeutung der Attribute:

  • user: spezifiziert den Anmeldenamen eines Benutzers.
  • group: spezifiziert den Namen einer Benutzergruppe.

Beispiel:

<cm-request...>
  <obj-where>
    <id>7345</id>
  </obj-where>
  <obj-get>
    <rootPermissionFor user="sam"/>
  </obj-get>
;</cm-request>

<cm-response...>
  <cm-code numeric="0" phrase="ok">
    <obj>
      <rootPermissionFor user="sam">1</rootPermissionFor>
    </obj>
  </cm-code>
</cm-response>
setKeys
Bedeutung: Die Liste der mit obj-set setzbaren Parameter.

Definition:

<!ELEMENT setKeys (listitem)*>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>
sortValue
Bedeutung: Der Wert, nach dem die Dateien in dem Ordner, zu dem sie gehören, sortiert werden. Wird durch den Sortierschlüssel des darüber liegenden Ordners bestimmt.

Definition:

<!ELEMENT sortValue (%cm.atom;)>
superLinks
Bedeutung: Die Liste aller IDs der Links, die auf die Datei verweisen.

Definition:

<!ELEMENT superLinks ((link)* | (listitem)*)>
<!ELEMENT link (%cm.link-get;)>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>

cm.link-get: siehe <link-where> <link-get> oder CRUL als DTD.

superObjects
Bedeutung: Die Liste aller IDs der Dateien, die Links auf die Datei enthalten.

Definition:

<!ELEMENT superObjects ((obj)* | (listitem)*)>
<!ELEMENT obj (%cm.obj-get;)>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>

cm.obj-get: siehe <obj-where> <obj-get> oder CRUL als DTD.

suppressExport
Bedeutung: Gibt an, ob die Datei exportiert werden kann (1 = Export elaubt; 0 = Datei darf nicht exportiert werden).

Definition:

<!ELEMENT suppressExport (%cm.atom;)>
toclist
Bedeutung: Nur für Ordner verfügbar! Die Liste der IDs der Dateien in einem Ordner, die in einer toclist (<NPSOBJ list="toclist"></NPSOBJ>) erscheinen (alle zeitlich gültigen Ordner und Dokumente mit freigegebener Version, bei denen suppressExport nicht gesetzt ist).

Definition:

<!ELEMENT toclist ((obj)* | (listitem)*)>
<!ELEMENT obj (%cm.obj-get;)>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*> 

cm.obj-get: siehe <obj-where> <obj-get> oder CRUL als DTD.

validControlActionKeys
Bedeutung: Die Namen der Aktionen, die für die Datei und den jeweiligen Benutzer ausführbar sind - Untermenge aus {edit, commit, release, unrelease, revert, reject}.

Definition:

<!ELEMENT validControlActionKeys (listitem)*>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>
validCreateObjClasses
Bedeutung: Die Liste der Namen der Vorlagen, die der Benutzer beim Anlegen von Dateien im aktuellen Ordner verwenden darf. (Dies entspricht der Liste validSubObjClasses, die in der Vorlage der Datei spezifiziert sind, für die der Benutzer die entsprechenden Dateierzeugungsrechte hat.).

Definition:

<!ELEMENT validCreateObjClasses ((objClass)* | (listitem)*)>
<!ELEMENT objClass (%cm.atom; | %cm.objClass-get;)*>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>

cm.objClass-get: siehe <objClass-where> <objClass-get> oder CRUL als DTD.

validObjClasses
Bedeutung: Die Liste der Namen der Vorlagen, die der Benutzer der aktuellen Datei zuweisen darf. (Dies entspricht den validSubObjClasses des darüber liegenden Ordners, die den gleichen Dateityp haben).

Definition:

<!ELEMENT validObjClasses ((objClass)* | (%cm.listitem;)*)>
<!ELEMENT objClass (%cm.atom; | %cm.objClass-get;)*>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>

cm.objClass-get: siehe <objClass-where> <objClass-get> oder CRUL als DTD.

validPermissions
Bedeutung: Die Liste aller für die Datei verfügbaren Rechte.

Definition:

<!ELEMENT validPermissions (listitem)*>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>
version
Bedeutung: Die Revision der Datei.

Definition:

<!ELEMENT version (%cm.atom;)>
visibleExportTemplates
Bedeutung: Die Liste der IDs der Layouts, die von der Datei aus sichtbar sind und für einen Export in Frage kommen.

Definition:

<!ELEMENT visibleExportTemplates ((obj)* | (listitem)*)>
<!ELEMENT obj (%cm.obj-get;)>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>

cm.obj-get: siehe <obj-where> <obj-get> oder CRUL als DTD.

visibleName
Bedeutung: Der Name der Datei, ergänzt um die Dateiendung als Extension (außer bei Ordnern). Der Wert dieses Feldes kann auch ohne Dateileserecht abgefragt werden.

Definition:

<!ELEMENT visibleName (%cm.atom;)>
visiblePath
Bedeutung: Der Pfad der Datei, ergänzt um die Dateiendung als Extension (bei Ordnern wird "/index.<contentType>" angehängt). Der Wert dieses Feldes kann auch ohne Dateileserecht abgefragt werden.

Definition:

<!ELEMENT visiblePath (%cm.atom;)>
workflowName
Bedeutung: Der Name des Workflows, der der Datei zugeordnet ist.

Definition:

<!ELEMENT workflowName (%cm.atom; | %cm.workflow-get;)*>

cm.workflow-get: siehe <workflow-where> <workflow-get> oder CRUL als DTD.