Open Source Dokumentenmanagement
Dokumentation

Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht

Navigation: Dokumentationen agorum core > agorum core JavaScript-API


GlobalObject

Diese Dokumentation beschreibt die Methoden getter und setter eines GlobalObjects.

Bei den Beispielen wird davon ausgegangen, dass Sie ein Objekt haben. Dieses können Sie etwa folgendermaßen holen:

let objects = require('common/objects');
let object = objects.find('<Object.id>');

Methoden für Ordner


Die hier beschriebenen Methoden gelten nur für Objekte vom Typ Ordner (FOLDEROBJECT).

Ob ein Objekt ein Ordner ist oder nicht, prüfen Sie über die Methode isFolder.

items()

Liefert ein Array aller Objekte in diesem Ordner zurück.


Syntax

object.items().map(item => item.name);

base.items().map(item => item.name);

itemsCount

Enthält die Anzahl der Unterelemente dieses Ordners.


Syntax

object.itemsCount;

itemsNoFolder

Liefert alle Elemente außer Ordner zurück.


Syntax

object.itemsNoFolder;

itemsOnlyFolder

Liefert alle Unterordner zurück.


Syntax

object.itemsOnlyFolder;

.createPath()

Erstellt einen neuen Ordner.


Beispiel

let base = objects.find('/Home/roi/MyFiles');

// Prüfen, ob das Objekt auch ein Ordner ist
if (base.isFolder) {
   base.createPath('Mein neuer Ordner/Mein neuer Unterordner');
}


Rückgabewert

Sie erhalten den untersten Ordner der neu erstellten Struktur zurück.

acl


Aufgabe Datentype
Setzen und holen des ACL des Objekts. AccessControlList

acl setzen

Hier wird die ACL public gesetzt.

object.acl = objects.find('acl:public');

acl lesen

let acl = object.acl;

Bedingungen/Ausnahmen

Schreibrechte notwendig

aclByName


Aufgabe Datentype
Setzen und holen des ACL des Objekts.  

aclByName(string) 

object.aclByName('public');

Bedingungen/Ausnahmen

Schreibrechte notwendig

addAttachment


Aufgabe Datentype
Hinzufügen eines Anhangs an das Objekt.

addAttachament(GlobalObject)

let objects = require('common/objects');

let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js');
let obj3 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test2.js');

object.addAttachment(obj3);

Bedingungen/Ausnahmen

Schreibrechte notwendig

addToPathDateQueue()


Aufgabe Datentype
Function addToPathDateQueue() des Objektes  

addToPathDateQueue()

let xxx = object.addToPathDateQueue()

Bedingungen/Ausnahmen

Schreibrechte notwendig

allAclIDs


Aufgabe Datentype
Holen aller allAclIDs und Scope-ACLs des Objektes. long[]

allAclIDs holen

let allAclIDs = object.allAclIDs;

Bedingungen/Ausnahmen

Leserechte notwendig

allAttachments


Aufgabe Datentype
Holen aller Anhänge des Objektes. GlobalObject []

allAttachments lesen

let objects = require('common/objects');

let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js');
let obj1 = objects.find('/agorum/roi/customers/test-auto-plugin/js/read-meta.json.js');
let obj2 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.js');
let obj3 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test2.js');

let attachments = [obj1, obj2];
object.setAttachments(attachments);
object.addAttachment(obj3);

let allAttachments = object.allAttachments;

Bedingungen/Ausnahmen

Leserechte notwendig

allFolderPath


Aufgabe Datentype
Holen aller Pfade des Objekts. string[] allFolderPath

allFolderPath lesen

let objects = require('common/objects');
let obj2 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.js');

obj2.allFolderPath;

Bedingungen/Ausnahmen

anyFolderPath


Aufgabe Datentype
Holen des anyFolderPath des Objekts.  string

anyFolderPath lesen

let objects = require('common/objects');
let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js');

let anyFolderPath = object.anyFolderPath;

Bedingungen/Ausnahmen

areaName (alt von desk4web)


Der areaName wird noch im Modul desk4web verwendet. Im neuen agorum core hat er keine Bedeutung mehr und sollte auch nicht verwendet werden.

Aufgabe Datentype
Setzen und holen des areaName des Objekts.  string

areaName setzen

object.areaName = 'Das ist der AreaName';

areaName holen

let areaName = object.areaName;

Bedingungen/Ausnahmen

Schreibrechte notwendig

associatedUser


Aufgabe Datentype
Holen des associatedUser des Objekts (zugehöriger Benutzer eines Objekts). DirectoryUserObject

associatedUser holen

let associatedUser = object.associatedUser;

Bedingungen/Ausnahmen

Leserechte notwendig

attachedTo()


Aufgabe Datentype
Holen aller Objekte, an denen das Objekt angehängt ist. GlobalObject []

attachedTo() lesen

let objects = require('common/objects');

let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js');
let obj1 = objects.find('/agorum/roi/customers/test-auto-plugin/js/read-meta.json.js');
let obj2 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.js');
let obj3 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test2.js');

let ret = [];
let attachments = [obj1, obj2];

object.setAttachments(attachments);

object.addAttachment(obj3);

obj3.attachedTo();

Bedingungen/Ausnahmen

Schreibrechte notwendig

attachments()


Aufgabe Datentype
Holen aller Anhänge des Objekts. GlobalObject []

attachments() lesen

let objects = require('common/objects');

let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js');
let obj1 = objects.find('/agorum/roi/customers/test-auto-plugin/js/read-meta.json.js');
let obj2 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.js');
let obj3 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test2.js');

let attachments = [obj1, obj2];
object.setAttachments(attachments);
object.addAttachment(obj3);

attachments = object.attachments();

Bedingungen/Ausnahmen

Schreibrechte notwendig

baseName


Aufgabe Datentype
Nur Lesend. Gibt den Namen des Objektes ohne Extension zurück. string

Syntax

let baseName = object.baseName;

Bedingungen/Ausnahmen

Leserechte notwendig

behaviorName


Aufgabe Datentype
Setzen und holen des behaviorName des Objekts. string

behaviorName schreiben

object.behaviorName = 'bh01';

behaviorName lesen

let behaviorName = object.behaviorName;

Bedingungen/Ausnahmen

belongingObject


Aufgabe Datentype
Holen des belongingObject des Objekts. GlobalObject

belongingObject holen

let belongingObject = object.belongingObject;

Bedingungen/Ausnahmen

Lesrechte notwendig

cancelCheckOut()


Aufgabe Datentype
Bricht das Auschecken eines Objekts ab. 

cancelCheckOut()

object.cancelCheckOut()

Bedingungen/Ausnahmen

checkinComment


Aufgabe Datentype
Holen des checkinComment des Objekts. string

Der checkinComment ist der Kommentar, der beim Einchecken eines Objekts eingegeben wird. Hier schreibt der Änderer einen kurzen Kommentar, was er an dem Dokument geändert hat.

checkinComment holen

let checkinComment = object.checkinComment;

Bedingungen/Ausnahmen

Lesrechte notwendig

checkedOut


Aufgabe Datentype
Prüft, ob das Objekt ausgecheckt ist.

true
Objekt ist ausgecheckt.

false
Objekt ist nicht ausgecheckt.
boolean

checkedOut holen

let checkedOut = object.checkedOut
if (object.checkedOut) {
  // ist ausgechecked
  ..
}
else {
  // ist nicht ausgechecked
  ..
}

Bedingungen/Ausnahmen

checkedOutByMe


Aufgabe Datentype
Prüft, ob das Objekt von Ihnen ausgecheckt ist.

true
Objekt ist von Ihnen ausgecheckt.

false
Objekt ist nicht von Ihnen ausgecheckt.
boolean

checkedOutByMe holen

let checkedOutByMe = object.checkedOutByMe
if (object.checkedOutByMe) {
  // ist von Ihnen ausgechecked
  ..
}
else {
  // ist nicht von Ihnen ausgechecked
  ..
}

Bedingungen/Ausnahmen

checkIn(comment, versionNumber, isMayjorVersion)


Aufgabe Datentype
Checkt die Arbeitskopie eines ausgecheckten Dokuments ein (checkOut). GlobalObject

 Der Aufruf wird auf dem Original-Objekt ausgeführt. Der Rückgabewert entspricht dem Originalobject, das zuvor ausgecheckt wurde.

Parameter

Parameter Datentype Beschreibung
comment string Der Kommentar, den der Bearbeiter beim CheckIn eingibt (checkinComment)
versionNumber null Übergeben Sie bei der Versionsnummer null, wird diese über die Standardberechnung berechnet. Wenn nicht vorhanden, fängt die Nummer bei 1.0 an.

Wenn isMayjorVersion === true, wird die Zahl vor dem Komma hochgezählt.

Beispiel
1.0 - 2.0 - 3.0

Wenn isMayjorVersion === false, wird die Zahl nach dem Komma hochgezählt.

Beispiel
1.0 - 1.1 - 1.2
versionNumber string Wenn Sie die Versionsnummer als String übergeben, wird genau der Inhalt des Strings in die Versionsnummer gesetzt. Jetzt sind Sie für die Berechnung der Versionsnummer selbst verantwortlich.
isMayiorVersion boolean true
Hauptversion

false
keine Hauptversion


Beispiel
Version automatisch berechnet mit dem Standardverhalten:

let objects = require('common/objects');
let text = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.txt');

// checkOut
let co = text.checkOut(null);
// Jetzt wird was geändert
co.contentString += '\nNoch eine Zeile';
let obj = text.checkIn('Kommentar ' + new Date(), null, false);


Beispiel
Version mit eigener Versionsnummer:

let objects = require('common/objects');
let text = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.txt');

// checkOut
let co = text.checkOut(null);
// Jetzt wird was geändert
co.contentString += '\nNoch eine Zeile - xx';

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


Beispiel
checkIn() auf dem ausgecheckten Objekt aufrufen:

let objects = require('common/objects');
let text = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.txt');

// checkOut
let co = text.checkOut(null);
// Jetzt wird was geändert
co.contentString += '\nNoch eine Zeile - yy';
// Jetzt wird checkIn auf der Arbeitskopie aufgerufen.
let obj = co.checkIn('Kommentar ' + new Date(), 'V17.89.55-987', false);

Bedingungen/Ausnahmen

Schreibrechte oder CheckIn-Rechte notwendig.

checkOut(GlobalObject versionToCheckout)


Aufgabe Datentype
Checkt eine Datei aus.  GlobalObject

Beim Auschecken erstellt das System im Verzeichnis Home/{user_id}/myFiles/In Bearbeitung eine Arbeitskopie Ihrer Datei und sperrt das Original, damit das Original von anderen Benutzern nicht verändert werden kann. Der Rückgabewert ist Ihre Arbeitskopie, in der Sie anschließend Ihre Änderungen vornehmen können.​


Beispiel
Eine Datei hat drei Versionen:

Sie können verschiedene Szenarien abbilden, je nachdem, welche Dateiversion Sie auschecken möchten:

/* global sc */ 
let objects = require('common/objects');
let metadata = require('common/metadata');

// Datei (ID) holen, die ausgecheckt werden soll
let versions = {
  current: objects.find(1185750), // aktuelle Version 2.0 der Datei
  version1: objects.find(1414507) // alte Version 1.0 der Datei
};

// Checkout durchführen
if (versions.current.historyObject) {

  // Checkt die aktuelle Version 2.0 aus
  return versions.version1.belongingObject.checkOut(null);
}

  // Checkt die alte Version 1.0 aus
  return versions.version1.belongingObject.checkOut(versions.version1);
}

// Checkt die aktuelle Version 2.0 aus
return versions.current.checkOut(null);

//  Checkt die alte Version 1.0 aus
return versions.current.checkOut(versions.version1);

Bedingungen/Ausnahmen

Schreibrechte oder Checkout-Rechte notwendig, um den Checkout durchführen zu können.

convertablePDF


Aufgabe Datentype
Holen des convertablePDF des Objekts. boolean

convertablePDF holen

let convertablePDF = object.convertablePDF;

Bedingungen/Ausnahmen

Lesrechte notwendig

createDate


Aufgabe Datentype
Setzen und holen des createDate des Objekts. date

Dieses Datum gibt an, wann das Objekt angelegt wurde. Im Normalfall wird dieses Datum intern gesetzt, wenn das Objekt angelegt wird.

createDate setzen

object.createDate = new Date();

createDate holen

let createDate = object.createDate;

Bedingungen/Ausnahmen

Schreibrechte notwendig

creator


Aufgabe Datentype
Setzen und holen des creator des Objekts. DirectoryUserObject

Der creator gibt an, welcher Benutzer das Objekt angelegt hat. Im Normalfall wird der creator intern gesetzt, wenn das Objekt angelegt wird.

creator setzen

object.creator = objects.find('user:rolf.lang');

creator holen

let creator = object.creator;

Bedingungen/Ausnahmen

Schreibrechte notwendig

creatorByName


Aufgabe Datentype
Setzen des creator des Objekts anhand des Benutzernamens.

creatorByName(string)

object.creatorByName('rolf.lang');

Bedingungen/Ausnahmen

Schreibrechte notwendig

delete()


Aufgabe Datentype
Löscht das Objekt endgültig.

Achtung: Datenverlust durch Aufruf der Funktion. Das Objekt kann nicht mehr aus dem Serverpapierkorb wiederhergestellt werden. Löschen Sie das Objekt mit diesem Aufruf nur, wenn Sie es wirklich nicht mehr benötigen.

Möchten Sie, dass das Objekt nach dem Löschen im Serverpapierkorb verbleibt, verwenden Sie den Aufruf trash.

delete()

object.delete()

Bedingungen/Ausnahmen

Schreibrechte notwendig

deleteAllScopeAcls()


Aufgabe Datentype
Löscht alle Scope-ACL eines Objektes.

deleteAllScopeAcls()

object.deleteAllScopeAcls()

Bedingungen/Ausnahmen

Schreibrechte notwendig

deleteScopeAcl(acl)


Aufgabe Datentype
Löscht einen Scope-ACL eines Objekts.

deleteScopeAcl(acl)

object.deleteScopeAcl(acl)

Bedingungen/Ausnahmen

Administrative Rechte notwendig.

deleted


Aufgabe Datentype
Holen des Flags deleted des Objekts. boolean

deleted holen

let deleted = object.deleted;

Bedingungen/Ausnahmen

Leserechte notwendig

deleteDeferred


Aufgabe Datentype
Function deleteDeferred des Objekts.

deleteDeferred

let xxx = object.deleteDeferred

Bedingungen/Ausnahmen

Schreibrechte notwendig

deleteDocumentText()


Aufgabe Datentype
Löscht den DokumentText eines Objekts.

deleteDocumentText()

let xxx = object.deleteDocumentText()

Bedingungen/Ausnahmen

deletor


Aufgabe Datentype
Setzen und holen des deletor des Objekts. DirectoryUserObject

deletor(DirectoryUserObject?) setzen

object.deletor(DirectoryUserObject?) = 

deletor(DirectoryUserObject?) holen

let deletor(DirectoryUserObject?) = object.deletor(DirectoryUserObject?);

Bedingungen/Ausnahmen

Schreibrechte notwendig

description


Aufgabe Datentype
Setzen und holen der Objekt-Beschreibung. string

description schreiben

object.description = 'Das ist die Beschreibung des Objekts';

description lesen

let description = object.description;

Bedingungen/Ausnahmen

displayableObject


Aufgabe Datentype
Holen der displayableObject eines Objekts. GlobalObject

displayableObject lesen

let displayableObject = object.displayableObject;

Bedingungen/Ausnahmen

Leserechte notwendig

displayName


Aufgabe Datentype
Holen des Displayname des Objekts. string

displayName lesen

let displayName = object.displayName

Bedingungen/Ausnahmen

Leserechte notwendig

documentText


Aufgabe Datentype
Holen des DokumentText-Objektes des Objekts. DocumentTextObject

documentText holen

let pdf = objects.find('/agorum/roi/customers/test-auto-plugin/test/Willkommen.pdf');
let dto = pdf.documentText;

throw 'Das ist der Text, der in den Volltext-Index kommt:\n\n' + dto.contentString;

Bedingungen/Ausnahmen

ensureHistory


Ab welcher Version nutzbar?
agorum core 9.5.1

Aufgabe Datentype
Erzwingt das Erzeugen einer Historie bei der nächsten Aktion mit diesem Objekt.

Wird bei einer Änderung kein ensureHistory verwendet, kann es sein, dass die letzte Änderung innerhalb der letzten Minute war und somit nicht erneut eine Historie erzeugt wird.

Name ändern und vorher eine Historie erzeugen

obj.ensureHistory().name = 'neuer-name.pdf';

Inhalt einer Datei mit dem Inhalt einer anderen Datei überschreiben

Der Inhalt eines Quellobjekts (srcObj) kann hierdurch auf ein Zielobjekt (dstObject) geschrieben werden. Verwenden Sie diese Art von content stream bevorzugt, da das System im Hintergrund direkt Optimierungen vornimmt, Stichwort dedup. Vor Setzen des Contents wird eine Historie erzeugt.

srcObj.streamContent(dstObj.ensureHistory());

Metadaten setzen

metadata({
  xx: 'yy'
}).save(obj.ensureHistory());

expirationDate


Aufgabe Datentype
  • Setzen und holen des expirationDate des Objekts.
  • Löscht das Objekt automatisch an diesem Datum endgültig.

    Tipp: Setzen Sie zuerst das expirationDate und anschließend Systemflags.

date

expirationDate setzen

let date = new Date();
date.setFullYear(date.getFullYear() + 11);
object.expirationDate = date;

Zurücksetzen, wenn es gesetzt ist und wieder weggenommen werden soll:

object.expirationDate = new Date(0);

expirationDate holen

let expirationDate = object.expirationDate;

Bedingungen/Ausnahmen

firstParent


Aufgabe Datentype
(nur lesend) Gibt das erste übergeordnete Objekt des Objektes zurück. GlobalObject

firstParent lesen

let objects = require('common/objects');

let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js');

let nameFirstParent = object.firstParent.name;

Bedingungen/Ausnahmen

Leserechte notwendig

flags


Aufgabe Datentype
Setzen und holen der Flags des Objekts.  long

flags setzen

object.flags = 2;

flags holen

let flags = object.flags = 2 ;

Bedingungen/Ausnahmen

Schreibrechte notwendig

getAllFolderPath( [ folder-Id ] )


Aufgabe Datentype
Holen aller Pfade, unter denen das Objekt verknüpft ist.  string[]

Optional können Sie der Funktion eine Folder-ID übergeben, damit das System die Pfade relativ zu diesem Ordner ausgibt.

getAllFolderPath()

let objects = require('common/objects');
let obj2 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.js');

obj2.getAllFolderPath();

getAllFolderPath(folder.ID)

let objects = require('common/objects');
let obj2 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.js');

// relativ zu dem übergebenen Ordner holen
obj2.getAllFolderPath(objects.find('/agorum/roi/customers').getId());

Bedingungen/Ausnahmen

getId()


Aufgabe Datentype
Holen der eindeutigen Objekt-ID des Objekts. long

getId() holen

let id = object.getId();

Bedingungen/Ausnahmen

getParent(name)


Aufgabe Datentype
Holen des Parent des Objekts mit einem bestimmten Namen.  GlobalObject

Der Parent ist ein Ordner, an dem das Objekt mit einem FolderPathRelation verknüpft ist.

getParent(name)

let objects = require('common/objects');
let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js');

let parentJs = object.getParent('js');

Bedingungen/Ausnahmen

Leserechte notwendig

hasAttachments


Aufgabe Datentype
Prüft, ob das Objekt Anhänge besitzt.

true
Objekt hat Anhänge.

false
Objekt hat keine Anhänge.
boolean

hasAttachments

if(object.hasAttachments()) { ??
   ...
}

Bedingungen/Ausnahmen

Schreibrechte notwendig

hasOwnAttachments


Aufgabe Datentype
Prüft, ob das Objekt eigene Anhänge besitzt.

true
Objekt hat eigene Anhänge.

false
Objekt hat keine eigenen Anhänge.
boolean

hasOwnAttachments lesen

object.hasOwnAttachments()

Bedingungen/Ausnahmen

Leserechte notwendig

hasParents()


Aufgabe Datentype
Prüft, ob das Objekt Parents hat.

true
Objekt hat Parents.

false
Objekt hat keine Parents.
boolean

hasParents()

let hasParents = object.hasParents();

Bedingungen/Ausnahmen

Leserechte notwendig

historyCount


Aufgabe Datentype
Holen des HistoryCounters des Objekts. int

Der HistoryCount gibt an, wie viele Historien das Objekt besetzt.

historyCount holen

let historyCount = object.historyCount;

Bedingungen/Ausnahmen

Leserechte notwendig

historyObject


Aufgabe Datentype
Prüft, ob es sich bei diesem Objekt um ein History-Objekt handelt.

true
Es handlet sich um ein History-Objekt.

false
Es handlet sich nicht um ein History-Objekt.
boolean

historyObject

let historyObject = object.historyObject;

Bedingungen/Ausnahmen

Leserechte notwendig

ID


Aufgabe Datentype
Holen der ID des Objekts. string

ID holen

let ID = object.ID;

Bedingungen/Ausnahmen

Leserechte notwendig

immutable


Aufgabe Datentype
Holen des immutable des Objekts. boolean

immutable holen

let immutable = object.immutable;

Bedingungen/Ausnahmen

Leserechte notwendig

indexAble


Aufgabe Datentype
Holen des indexAble des Objekts. boolean

indexAble holen

let indexAble = object.indexAble;

Bedingungen/Ausnahmen

Leserechte notwendig

inTrash


Aufgabe Datentype
Prüft, ob das Objekt im Serverpapierkorb liegt.

true
Objekt liegt im Serverpapierkorb.

false
Objekt liegt nicht im Serverpapierkorb.
boolean

inTrash holen

let inTrash = object.inTrash;

Bedingungen/Ausnahmen

Leserechte notwendig

isAttached()


Aufgabe Datentype
Prüft, ob das Objekt an einem anderen Objekt angehängt ist.

true
Objekt ist an einem anderen Objekt angehängt. 

false
Objekt ist nicht an einem anderen Objekt angehängt.
boolean

isAttached()

if(object.isAttached()) { 
   ...
}

Bedingungen/Ausnahmen

Leserechte notwendig

isFolder


Aufgabe Datentype
Prüft, ob das Objekt ein Ordner ist.

true
Objekt ist ein Ordner.

false
Objekt ist kein Ordner.
boolean

isFolder lesen

if(object.isFolder) {
   ...
}

Bedingungen/Ausnahmen

Leserechte notwendig

isLocked()


Aufgabe Datentype
Prüft, ob das Objekt gesperrt ist.

true
Objekt ist gesperrt.

false
Objekt ist nicht gesperrt.
boolean

isLocked()

let isLocked = object.isLocked();

Bedingungen/Ausnahmen

Leserechte notwendig

isOrdinaryFolder()


Aufgabe Datentype


true


false
boolean

isOrdinaryFolder()

if(object.isOrdinaryFolder()) {
   ...
}

Bedingungen/Ausnahmen

Leserechte notwendig

isTemporary()


Aufgabe Datentype
Prüft, ob das Objekt nur ein temporäres Objekt ist.

true
Objekt ist ein temporäres Objekt.

false
Objekt ist kein temporäres Objekt.
boolean

isTemporary()

let isTemporary = object.isTemporary();

Bedingungen/Ausnahmen

Leserechte notwendig

lastModifier


Aufgabe Datentype
Setzen und holen des lastModifier des Objekts. DirectoryUserObject

Der lastModifier gibt an, welcher Benutzer das Objekt zuletzt geändert hat. Im Normalfall wird der lastModifier intern gesetzt, wenn das Objekt geändert wird.

lastModifier setzen

object.lastModifier = objects.find('user:rolf.lang');

lastModifier holen

let lastModifier = object.lastModifier;

Bedingungen/Ausnahmen

Schreibrechte notwendig

lastModifierByName


Aufgabe Datentype
Setzen des lastModifier des Objektes anhand des Benutzernamens.

lastModifierByName(string)

object.lastModifierByName('rolf.lang');

Bedingungen/Ausnahmen

Schreibrechte notwendig

lastModifyDate


Aufgabe Datentype
Setzen und holen des lastModifyDate des Objekts. date

Das lastModifyDate gibt an, wann das Objekt zuletzt geändert wurde. Im Normalfall wird dieses Datum intern gesetzt, wenn sich das Objekt geändert hat.

lastModifyDate setzen

object.lastModifyDate = new Date();

lastModifyDate holen

let lastModifyDate = object.lastModifyDate;

Bedingungen/Ausnahmen

leftwardRelations


Aufgabe Datentype
  • Holen der leftwardRelations des Objekts.
  • Gibt alle RelationObjects, die linksseitig am Objekt hängen, zurück.
RelationObject []

leftwardRelations holen

let objects = require('common/objects');
let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js');

object.leftwardRelations;

Bedingungen/Ausnahmen

leftwardRelationObjects


Aufgabe Datentype
  • Holen der leftwardRelationObjects des Objekts.
  • Gibt die GlobalObjects, die linksseitig am Object hängen, zurück.
GlobalObject []

leftwardRelationObjects holen

let objects = require('common/objects');
let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js');

object.leftwardRelationObjects;

Bedingungen/Ausnahmen

linked


Aufgabe Datentype
Prüft, ob ein Objekt verlinkt ist. Dies bedeutet, dass ein Objekt mehr wie einen Parent hat.

true
Objekt ist verlinkt.

false
Objekt ist nicht verlinkt.
boolean

linked holen

let linked = object.linked;

Bedingungen/Ausnahmen

Leserechte notwendig

linkedNotVisible


Aufgabe Datentype
  • Prüft, ob ein Objekt unsichtbare Links hat.
  • Prüft die für den Benutzer unsichtbaren Links.

true
Objekt besitzt unsichtbare Links.

false
Objekt besitzt keine unsichtbaren Links.
boolean

linkedNotVisible holen

let linkedNotVisible = object.linkedNotVisible;

Bedingungen/Ausnahmen

Leserechte notwendig

lock()


Aufgabe Datentype
Sperrt ein Objekt für den aktuellen Benutzer.

lock()

object.lock();

Bedingungen/Ausnahmen

Schreibrechte notwendig

lockedBy


Aufgabe Datentype
Holen der Benutzer, für die dieses Objekt gesperrt ist.  

lockedBy holen

let lockedBy = obj2.lockedBy;

Bedingungen/Ausnahmen

Leserechte notwendig

lockedFor


Aufgabe Datentype
Holen der SessionId, für die dieses Objekt gesperrt ist.

> 0
Definiert die SessionId, für die dieses Objekt gesperrt ist.

-1
Wurde für keine Session gesperrt. Dies bedeutet, die Sperre bleibt auch über ein Log-out und über einen neuen Systemstart bestehen.
long

lockedFor holen

let lockedFor = object.lockedFor;

Bedingungen/Ausnahmen

Leserechte notwendig

lockedForSession


Aufgabe Datentype
Prüft, ob auf dem Objekt ein Sessionlock ist.

true
Objekt besitzt einen Sessionlock.

false
Objekt besitzt keinen Sessionlock.
boolean

lockedForSession holen

let lockedForSession = object.lockedForSession;

Bedingungen/Ausnahmen

Leserechte notwendig

lockState


Aufgabe Datentype
Setzen und holen des Lockstate.

0
Nicht gelockt

1
Hardlock

4
SessionLock
int

lockState setzen

object.lockState = 0

lockState(int?) holen

let lockState = object.lockState;

Bedingungen/Ausnahmen

Schreibrechte notwendig

mainObj


Aufgabe Datentype
Holen des MainObjects des Objekts. GlobalObject

Das MainObject verweist auf das Hauptobjekt. Dies bedeutet, das Objekt, das auf ein anderes Objekt verweist, ist nur ein Teil des gesamten Objekts. Wenn ein Objekt keinen Verweis auf ein Hauptobjekt hat, ist im MainObject immer das Objekt selbst eingetragen.

mainObj lesen

let mainObj = object.mainObj;

Bedingungen/Ausnahmen

Leserechte notwendig

mayBeDeleted()


Aufgabe Datentype
Holen des mayBeDeleted des Objekts. boolean

mayBeDeleted

let mayBeDeleted = object.mayBeDeleted();

Bedingungen/Ausnahmen

Leserechte notwendig

mayCheckOut


Aufgabe Datentype
  • Holen des mayCheckOut des Objektes.
  • Prüft, ob Sie das Objekt auschecken dürfen.

true
Objekt darf ausgecheckt werden.

false
Objekt darf nicht ausgecheckt werden.
boolean

mayCheckOut holen

let mayCheckOut = object.mayCheckOut;

Bedingungen/Ausnahmen

Leserechte notwendig

mayDelete


Aufgabe Datentype
  • Holen des mayDelete des Objekts.
  • Prüft, ob Sie das Objekt löschen dürfen.

true
Objekt darf gelöscht werden.

false
Objekt darf nicht gelöscht werden.
boolean

mayDelete holen

let mayDelete = object.mayDelete;

Bedingungen/Ausnahmen

Leserechte notwendig

mayInsert


Aufgabe Datentype
  • Holen des mayInsert des Objekts.
  • Prüft, ob Sie das Objekt in einen Ordner ablegen dürfen.

true
Objekt darf in den Ordner abgelegt werden.

false
Objekt darf nicht in den Ordner abgelegt werden.
boolean

mayInsert holen

let mayInsert = object.mayInsert;

Bedingungen/Ausnahmen

Leserechte notwendig

mayModify


Aufgabe Datentype
  • Holen des mayModify des Objekts.
  • Prüft, ob Sie die Attribute des Objekts ändern dürfen.

true
Attribute des Objekts dürfen geändert werden.

false
Attribute des Objekts dürfen nicht geändert werden.
boolean

mayModify holen

let mayModify = object.mayModify;

Bedingungen/Ausnahmen

Leserechte notwendig

mayObjectBeMoved


Aufgabe Datentype
  • Holen des mayObjectBeMoved des Objekts.
  • Prüft, ob Sie das Objekt verschieben dürfen.

true
Objekt darf verschoben werden.

false
Objekt darf nicht verschoben werden.
boolean

mayObjectBeMoved holen

let mayObjectBeMoved = object.mayObjectBeMoved;

Bedingungen/Ausnahmen

Leserechte notwendig

mayRemove


Aufgabe Datentype
  • Holen des mayRemove des Objekts.
  • Prüft, ob Sie das Objekt abhängen dürfen.

true
Objekt darf abgehängt werden.

false
Objekt darf nicht abgehängt werden.
boolean

mayRemove holen

let mayRemove = object.mayRemove;

mayRemove(parent)


Prüft zusätzlich, ob das Objekt noch über den Ordner geschützt ist. Diese Methode ist der Methode mayRemove vorzuziehen.

Aufgabe Datentype
  • Holen des mayRemove des Objekts.
  • Prüft, ob Sie das Objekt abhängen dürfen.

true
Objekt darf abgehängt werden.

false
Objekt darf nicht abgehängt werden.
boolean

mayRemove holen

let mayRemove = object.mayRemove(parent);

Bedingungen/Ausnahmen

Leserechte notwendig

mailAttachment


Aufgabe Datentype
  • Holen des mailAttachment des Objekts.
  • Prüft, ob Sie das Objekt ein Mailattachment besitzt.

true
Objekt besitzt ein Mailattachment.

false
Objekt besitzt kein Mailattachment.
boolean

mailAttachment holen

let mailAttachment = object.mailAttachment;

Bedingungen/Ausnahmen

Leserechte notwendig

mailBody


Aufgabe Datentype
  • Holen des mailBody des Objekts.
  • Prüft, ob Sie das Objekt einen Mailbody besitzt.

true
Objekt besitzt einen Mailbody​​​​​​.

false
Objekt besitzt keinen Mailbody .
boolean

mailBody holen

let mailBody = object.mailBody;

Bedingungen/Ausnahmen

Leserechte notwendig

mailMsg


Aufgabe Datentype
  • Holen des mailMsg des Objekts.
  • Prüft, ob das Objekt einen Mailmsg besitzt.

true
Objekt besitzt einen Mailmsg.

false
Objekt besitzt keinen Mailmsg.
boolean

mailMsg holen

let mailMsg = object.mailMsg;

Bedingungen/Ausnahmen

Leserechte notwendig

mutable


Aufgabe Datentype
  • Holen des mutable des Objekts.
  • Prüft, ob Sie die Attribute des Objekts ändern dürfen.

true
Attribute des Objekts dürfen geändert werden.

false
Attribute des Objekts dürfen nicht geändert werden.
boolean

mutable holen

let mutable = object.mutable;

Bedingungen/Ausnahmen

Leserechte notwendig

name


Aufgabe Datentype
Setzen oder holen des Namens des Objekts. string

name setzen

object.name = 'Neuer name.txt';

name lesen

let name = object.name;

Bedingungen/Ausnahmen

nameExtension


Aufgabe Datentype
Holen des nameExtension des Objekts.  string

nameExtension holen

let nameExtension = object.nameExtension;

Bedingungen/Ausnahmen

notes


Aufgabe Datentype
Holen aller Notizen des Objekts. NoteObject[]

notes holen

let notes = object.notes;

Bedingungen/Ausnahmen

Leserechte notwendig

notesRelation


Aufgabe Datentype
Holen des notesRelation des Objekts. RelationObject[]

notesRelation holen

let notesRelation = object.notesRelation;

Bedingungen/Ausnahmen

Leserechte notwendig

objectTextKey


Aufgabe Datentype
  • Setzen oder holen des objectTextKey des Objekts.
  • Übersetzt einen Ordnernamen.
string

objectTextKey setzen

object.objectTextKey = 'agorum.textkey.file.private';

objectTextKey lesen

let objectTextKey = object.objectTextKey;

Bedingungen/Ausnahmen

owner


Aufgabe Datentype
Setzen und holen des Owners des Objekts. DirectoryUserObject

owner setzen

object.owner = objects.find('user:rolf.lang');

owner holen

let owner = object.owner;

Bedingungen/Ausnahmen

ownerByName()


Aufgabe Datentype
Setzen des Owners des Objekts anhand des Namens.

ownerByName(string)

object.ownerByName('rolf.lang');

Bedingungen/Ausnahmen

Schreibrechte notwendig

parents()


Aufgabe Datentype
• Holen der parents des Objekts.
• Gibt alle Ordner zurück, in denen das Objekt verknüpft ist.
GlobalObject []

parents holen

let objects = require('common/objects');
let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js');

let parents = object.parents();
let ret = [];
parents.forEach(function(parent){
  ret.push(parent.name);
});
ret;

Bedingungen/Ausnahmen

previewable


Aufgabe Datentype
Holen des previewable des Objekts. boolean

previewable holen

let previewable = object.previewable;

Bedingungen/Ausnahmen

Leserechte notwendig

privateWorkingCopy


Aufgabe Datentype
Prüft, ob das Objekt eine PWC (privat working copy) ist.

true
Objekt ist eine PWC.

false
Objekt ist keine PWC.
boolean

privateWorkingCopy holen

let privateWorkingCopy = object.privateWorkingCopy;

Bedingungen/Ausnahmen

Leserechte notwendig

pWCFolder


Aufgabe Datentype
Holen des pWCFolder des Objekts. FolderObject

pWCFolder holen

let pWCFolder = object.pWCFolder;

Bedingungen/Ausnahmen

Leserechte notwendig

read


Aufgabe Datentype
Holen des read des Objekts. boolean

read holen

let read = object.read;

Bedingungen/Ausnahmen

Leserechte notwendig

reIndex()


Aufgabe Datentype
Reindiziert das Objekt / legt das Objekt nochmals in den Index.

reIndex()

object.reIndex()

Bedingungen/Ausnahmen

Schreibrechte notwendig

related


Aufgabe Datentype
Holen des related des Objekts. boolean

related holen

let related = object.related;

Bedingungen/Ausnahmen

Leserechte notwendig

removeAttachments


Aufgabe Datentype
Löscht Anhänge eines Objekts.

removeAttachments(GlobalObject [])

let objects = require('common/objects');

let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js');
let obj1 = objects.find('/agorum/roi/customers/test-auto-plugin/js/read-meta.json.js');
let obj2 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.js');
let obj3 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test2.js');

let removeAttachments = [obj1, obj2, obj3];
object.removeAttachments(removeAttachments);

Bedingungen/Ausnahmen

Schreibrechte notwendig

restoreObject(FolderObject target)


Aufgabe Datentype
Function restoreObject(FolderObject target) des Objekts.  

restoreObject(FolderObject target)

let xxx = object.restoreObject(FolderObject target)

Bedingungen/Ausnahmen

Schreibrechte notwendig

rightwardRelations


Aufgabe Datentype
  • Holen der rightwardRelations des Objekts.
  • Gibt alle RelationObjects zurück, die rechtsseitig am Objekt hängen.
RelationObject []

rightwardRelations holen

let objects = require('common/objects');
let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js');

object.rightwardRelations;

Bedingungen/Ausnahmen

rightwardRelationObjects


Aufgabe Datentype
  • Holen der rightwardRelationObjects des Objekts.
  • Gibt alle GlobalObjects zurück, die rechtsseitig am Objekt hängen.
GlobalObject []

rightwardRelationObjects holen

let objects = require('common/objects');
let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js');

object.rightwardRelationObjects;

Bedingungen/Ausnahmen

rawText


Aufgabe Datentype
Holen des rawText des Objekts. string

rawText holen

let rawText = object.rawText;

Bedingungen/Ausnahmen

Leserechte notwendig

scopeAcl


Aufgabe Datentype
Setzen des scopeAcl des Objekts (ACL oder ACL[])  ACL[]

scopeAcl setzen

object.scopeAcl = acl;


Beispiel 1

let acl = objects.find('acl:NameDesAcls');
irgendEinObject.scopeAcl = acl;


Beispiel 2

let acls = [ objects.find('acl:NameDesAcls1'), objects.find('acl:NameDesAcls2') ];
irgendEinObject.scopeAcl = acls;

Bedingungen/Ausnahmen

scopeAclNames


Aufgabe Datentype
Holen des scopeAclNames des Objekts.  string[]

scopeAclNames holen

let scopeAclNames = object.scopeAclNames;

Bedingungen/Ausnahmen

Leserechte notwendig

scopeAcls


Aufgabe Datentype
Holen des scopeAcls des Objekts.  ACL[]

scopeAcls holen

let scopeAcls = object.scopeAcls;

Bedingungen/Ausnahmen

Leserechte notwendig

sessionController


Aufgabe Datentype
Holen des sessionController des Objekts.  sessionController

sessionController holen

let sessionController = object.sessionController;

Bedingungen/Ausnahmen

sessionLockWithTimer(long)


Aufgabe Datentype
Setzen des sessionLockWithTimer(long) des Objekts.

sessionLockWithTimer(long) setzen

object.sessionLockWithTimer(long) = 

Bedingungen/Ausnahmen

Schreibrechte notwendig

setAttachments


Aufgabe Datentype
Setzen von Anhängen an das Objekt.

setAttachments(GlobalObject [])

let objects = require('common/objects');

let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js');
let obj1 = objects.find('/agorum/roi/customers/test-auto-plugin/js/read-meta.json.js');
let obj2 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.js');

let attachments = [obj1, obj2];

object.setAttachments(attachments);

Bedingungen/Ausnahmen

Schreibrechte notwendig

setExpirationDateSilent


Aufgabe Datentype
Setzen des expirationDate des Objekts, ohne dass die Updatedates gesetzt werden.

setEexpirationDateSilent(date)

let dae = new Date();
date.setFullYear(date.getFullYear() + 11);
object.setExpirationDateSilent(date);

Bedingungen/Ausnahmen

setNote(NoteObject)


Aufgabe Datentype
Setzen des setNote(NoteObject) des Objekts.

setNote(NoteObject) setzen

object.setNote(NoteObject) = 

Bedingungen/Ausnahmen

Schreibrechte notwendig

specificParents


Aufgabe Datentype
Holen des specificParents des Objekts.  GlobalObject[]

specificParents(className)

let subObjects = object.specificParents('');

Bedingungen/Ausnahmen

Leserechte notwendig

subObjects


Aufgabe Datentype
Holen des subObjects des Objekts. GlobalObject[]

subObjects holen

let subObjects = object.subObjects;

Bedingungen/Ausnahmen

Leserechte notwendig

supportsPreview


Aufgabe Datentype
Holen des supportsPreview des Objekts. boolean

supportsPreview holen

let supportsPreview = object.supportsPreview;

Bedingungen/Ausnahmen

Leserechte notwendig

systemFlag


Aufgabe Datentype
Holen des systemFlags des Objekts.  long

systemFlag holen

object.systemFlags = 28;
let systemFlag = object.systemFlag;


Ergebnis

[4, 8, 16]

Bedingungen/Ausnahmen

systemFlags


Aufgabe Datentype
Setzen und holen der systemFlags des Objekts. long

systemFlags(long) setzen

object.systemFlags = 28

systemFlags holen

let systemFlags = object.systemFlags;

Bedingungen/Ausnahmen

text


Aufgabe Datentype
Holen des text des Objekts. string

text holen

let text = object.text;

Bedingungen/Ausnahmen

Leserechte notwendig

textAvailable


Aufgabe Datentype
Prüft, ob Text am Objekt verfügbar ist.

true
Text ist verfügbar.

false
Text ist nicht verfügbar.
boolean

textAvailable holen

let textAvailable = object.textAvailable;

Bedingungen/Ausnahmen

Leserechte notwendig

timePhasedAction


Aufgabe Datentype
Setzen und holen der timePhasedAction des Objekts. string

timePhasedAction setzen

object.timePhasedAction = 'StartDocFormRobot';

timePhasedAction holen

let timePhasedAction = object.timePhasedAction;

Bedingungen/Ausnahmen

Schreibrechte notwendig

timePhasedActionDate


Aufgabe Datentype
Setzen und Holen des timePhasedActionDate des Objekts. date

timePhasedActionDate setzen

object.timePhasedActionDate = new Date();

timePhasedActionDate holen

let timePhasedActionDate = object.timePhasedActionDate;

Bedingungen/Ausnahmen

Schreibrechte notwendig

unlock()


Aufgabe Datentype
Funktion unlock() des Objekts

unlock()

let xxx = object.unlock()

Bedingungen/Ausnahmen

Schreibrechte notwendig

UUID


Aufgabe Datentype
Setzen und holen der UUID des Objekts. string

Die UUID wird normalerweise automatisch vergeben. Sie können sie auch gezielt auf eine vorgegebene UUID setzen.

UUID setzen

object.UUID = '0e3a3c00-d104-11e5-a821-080027cddacf';

UUID holen

let UUID = object.UUID;

Bedingungen/Ausnahmen

Schreibrechte notwendig

updateDate


Aufgabe Datentype
Setzen und holen des updateDate des Objekts. Dieses Datum gibt an, wann das Objekt zuletzt geändert wurde. date

updateDate setzen

object.updateDate = new Date();

updateDate holen

let updateDate = object.updateDate;

Bedingungen/Ausnahmen

Schreibrechte notwendig

versionNumber


Aufgabe Datentype
Holen der versionNumber des Objekts.  string

versionNumber holen

let versionNumber = object.versionNumber;

Bedingungen/Ausnahmen

Leserechte notwendig

workingCopy


Aufgabe Datentype
Holen der workingCopy des Objekts.  GlobalObject

workingCopy holen

let workingCopy = object.workingCopy;

Bedingungen/Ausnahmen

Leserechte notwendig

writable


Aufgabe Datentype
  • Holen des writable des Objekts.
  • Prüft, ob Sie auf das Objekt Schreibrechte besitzen.

true
Sie besitzen Schreibrechte.

false
Sie besitzen keine Schreibrechte.
boolean

writable holen

let writable = object.writable;

Bedingungen/Ausnahmen

Leserechte notwendig

xml


Aufgabe Datentype
Holen des xml des Objekts.  string

xml holen

let xml = object.xml;

Bedingungen/Ausnahmen

Leserechte notwendig