openDocument

Code

IDocumentResult DocumentUtils.openDocument(String documentPk)

Beschreibung

Öffnet ein Dokument zum Lesen basierend auf dem vorgegebenen Primärschlüssel eines Dokumentensatzes.

Parameter

• documentPk
  Primärschlüssel des zu öffnenden Dokuments

Rückgabe
Ergebnis des Öffnens des angebebenen Dokuments
Folgende Methoden stehen in dem Rückgabeobjekt IDocumentResult zur Verfügung

• String getPk()
  Liefert den übergebenen Primärschlüssel, der an die Methode übergeben wurde.

• boolean isSuccessful()
  War das Öffnen des Dokuments erfolgreich?

• String getErrorCode()
  Liefert den Fehlercode, falls das Öffnen des Dokuments nicht erfolgreich war. Die Fehlercodes stehen als Konstanten in der Klasse DocumentUtils zur Verfügung, z.B. DocumentUtils.DOC_ERRORCODE_GENERAL. Mit Hilfe der Fehlercodes können individuelle Ausgaben im Skripting hinterlegt werden. Folgende Fehlercodes können auftreten:
  

  • DocumentUtils.DOC_ERRORCODE_DATA_EMPTY_ENTITYPK
    Der Parameter 'documentPk' darf nicht leer sein.

  • DocumentUtils.DOC_ERRORCODE_DATA_INVALID_ENTITYPK
    Zu dem angegebenen Parameter 'documentPk' konnte kein Dokumentensatz gefunden werden.

  • DocumentUtils.DOC_ERRORCODE_GENERAL
    Das Öffnen des Dokuments wurde wegen eines Fehlers abgebrochen.

Beispiele

IDocumentResult result = DocumentUtils.openDocument("2no2stm18232qeieDo");
if (!result.isSuccessful())
{
if (ScriptUtils.equal(DocumentUtils.DOC_ERRORCODE_GENERAL, result.getErrorCode()))
{
...Error handling...
}
}