Allgemeine Objekt-Methoden und -Eigenschaften - Dateien

Diese Dokumentation beschreibt Methoden und Eigenschaften, die auf Objekte vom Typ Datei anwendbar sind. Neben den hier beschriebenen gelten alle Methoden und Eigenschaften aus Allgemeine Objekt-Methoden und -Eigenschaften - Basis weiterhin.

Bei den Beispielen wird davon ausgegangen, dass Sie bereits ein Objekt geladen haben:

let objects = require('common/objects');
let file = objects.find('<Object.ID oder UUID oder Pfad>');

Enthaltene Methoden und Eigenschaften

• checkOut(versionToCheckout)
• checkIn(comment, versionNumber, isMajorVersion)
• cancelCheckOut()
• checkedOut
• checkedOutByMe
• checkinComment
• versionNumber
• workingCopy
• privateWorkingCopy
• documentText

checkOut(versionToCheckout)

Aufgabe	Datentyp
Checkt eine Datei aus. Das System erstellt im Verzeichnis Home/<user_id>/myFiles/In Bearbeitung eine Arbeitskopie der Datei und sperrt das Original, damit es nicht von anderen Benutzern verändert werden kann. Als Rückgabewert erhalten Sie die Arbeitskopie, in der Sie Änderungen vornehmen können.	Object (Arbeitskopie)

Parameter

Parameter	Datentyp	Beschreibung
versionToCheckout	Object oder null	Wird null übergeben, wird die aktuelle Version ausgecheckt. Wird stattdessen eine Historieninstanz übergeben, wird der Inhalt dieser Historieninstanz in die Arbeitskopie übernommen (Rollback auf eine ältere Version).

Beispiel – aktuelle Version auschecken

let objects = require('common/objects');
let document = objects.find('/agorum/roi/Files/Demo/Willkommen.pdf');

// Check out the current version
let workingCopy = document.checkOut(null);

// Make changes to workingCopy

Beispiel – ältere Version auschecken (Rollback)

let objects = require('common/objects');
let current    = objects.find('/agorum/roi/Files/contract.docx');
let oldVersion = objects.find('<UUID der Historieninstanz>');

// Use the old state as the starting point for the new version
let workingCopy = current.checkOut(oldVersion);

Bedingungen/Ausnahmen

• Schreib- oder Check-out-Rechte notwendig.
• Zum Prüfen, ob das Auschecken überhaupt erlaubt ist, verwenden Sie mayCheckOut (siehe mayCheckOut).

checkIn(comment, versionNumber, isMajorVersion)

Aufgabe	Datentyp
Checkt die Arbeitskopie eines zuvor ausgecheckten Dokuments wieder ein. Dabei wird eine neue Version des Dokuments erzeugt.	Object (eingechecktes Original)

Der Aufruf kann sowohl auf dem Original-Objekt als auch auf der Arbeitskopie erfolgen. Als Rückgabewert erhalten Sie das eingecheckte Original.

Parameter

Parameter	Datentyp	Beschreibung
comment	string	Der Kommentar, den der Bearbeiter zum Check-in eingibt (siehe checkinComment).
versionNumber	null	Bei null berechnet das System die Versionsnummer automatisch nach dem Standardverhalten. Ist keine vorhanden, beginnt die Zählung bei 1.0. Ist isMajorVersion = true, wird die Zahl vor dem Komma hochgezählt (1.0 → 2.0). Ist isMajorVersion = false, wird die Zahl nach dem Komma hochgezählt (1.0 → 1.1).
versionNumber	string	Wird die Versionsnummer als String übergeben, wird genau dieser Wert als Versionsnummer gesetzt. Die Berechnung liegt dann in Ihrer Verantwortung.
isMajorVersion	boolean	Steuert bei automatischer Versionsberechnung, ob eine Hauptversion (true) oder Nebenversion (false) erzeugt wird.

Beispiel – Standardversionierung

let objects = require('common/objects');
let text    = objects.find('/agorum/roi/Files/example.txt');

let workingCopy = text.checkOut(null);
workingCopy.contentString += '\nNoch eine Zeile';

let result = text.checkIn('Kommentar ' + new Date(), null, false);

Beispiel – eigene Versionsnummer

let result = text.checkIn('Kommentar ' + new Date(), 'V17.89.55-987', false);

Beispiel – checkIn auf der Arbeitskopie

let workingCopy = text.checkOut(null);
workingCopy.contentString += '\nEine weitere Änderung';

// checkIn direkt über die Arbeitskopie aufrufen
let result = workingCopy.checkIn('Kommentar ' + new Date(), null, false);

Bedingungen/Ausnahmen

Schreibrechte oder Check-in-Rechte notwendig.

cancelCheckOut()

Aufgabe	Datentyp
Bricht das Auschecken einer Datei ab und verwirft alle bis dahin gemachten Änderungen an der Arbeitskopie. Die Sperre auf dem Original wird aufgehoben.	–

Beispiel

if (document.checkedOut && document.checkedOutByMe) {
  document.cancelCheckOut();
}

Bedingungen/Ausnahmen

• Schreibrechte notwendig.
• Alle Änderungen an der Arbeitskopie gehen verloren.

checkedOut

Aufgabe	Datentyp
Nur lesend. Prüft, ob die Datei ausgecheckt ist.	boolean

Beispiel

if (document.checkedOut) {
  // File is checked out
}

Bedingungen/Ausnahmen

• Leserechte notwendig.
• Um zu prüfen, ob die Datei vom aktuellen Benutzer ausgecheckt wurde, verwenden Sie checkedOutByMe.

checkedOutByMe

Aufgabe	Datentyp
Nur lesend. Prüft, ob die Datei vom aktuellen Benutzer ausgecheckt ist.	boolean

Beispiel

if (document.checkedOutByMe) {
  // File is checked out by the current user
}

Bedingungen/Ausnahmen

Leserechte notwendig.

checkinComment

Aufgabe	Datentyp
Nur lesend. Liefert den Kommentar, der beim letzten Einchecken der Datei angegeben wurde. Hier beschreibt der Änderer typischerweise, was er am Dokument geändert hat.	string

Beispiel

let comment = document.checkinComment;

Bedingungen/Ausnahmen

Leserechte notwendig.

versionNumber

Aufgabe	Datentyp
Nur lesend. Liefert die aktuelle Versionsnummer des Objekts als String zurück (z. B. "1.0", "2.0").	string

Beispiel

let versionNumber = object.versionNumber;

Bedingungen/Ausnahmen

• Leserechte notwendig.
• Eine neu erstellte Datei, die noch nie ein- bzw. ausgecheckt wurde, besitzt noch keine Versionsnummer; in diesem Fall wird null zurückgegeben. Eine Versionsnummer (beginnend bei „1.0“) entsteht erst mit dem ersten Check-in.

workingCopy

Aufgabe	Datentyp
Nur lesend. Liefert die Arbeitskopie eines ausgecheckten Objekts zurück.	Object

Beispiel

let workingCopy = object.workingCopy;

Bedingungen/Ausnahmen

• Leserechte notwendig.

privateWorkingCopy

Aufgabe	Datentyp
Nur lesend. Prüft, ob es sich beim Objekt um eine private Arbeitskopie (PWC) handelt.	boolean

Beispiel

if (object.privateWorkingCopy) {
  // The object is a private working copy
}

Bedingungen/Ausnahmen

Leserechte notwendig.

documentText

Aufgabe	Datentyp
Nur lesend. Liefert das DocumentText-Objekt der Datei zurück. Das DocumentText-Objekt enthält den aus dem Dateiinhalt extrahierten Text, der in den Volltext-Index aufgenommen wird.	DocumentTextObject

Beispiel

let objects = require('common/objects');
let pdf     = objects.find('/agorum/roi/Files/Demo/Willkommen.pdf');

let dto  = pdf.documentText;
let text = dto.contentString;

console.log('Volltext-Index-Inhalt: ' + text);

Bedingungen/Ausnahmen

• Leserechte notwendig.
• Das Objekt muss einen Content besitzen (z. B. ein FileObject).