getDocument

Retrieves a document specified by its ID.

Syntax

<syntaxhighlight lang="java" enclose="div">

Result result = Functions.getDocument(String documentID); </syntaxhighlight>

Parameters

documentID - The ID of a document stored in the platform.

Returns

Result object that contains the document in the form of a PlatformFileBean.

Usage

1. Use result.getParameters() to get the params from the Result object.
2. Call getPlatformFileBean() on the params, passing the document ID as a string.
3. If needed, call getBytes() on the PlatformFileBean to get document content in a byte array.

Example

This example logs the size and name associated with a document.

<syntaxhighlight lang="java" enclose="div">

Result result = Functions.getDocument(documentId); Parameters params = result.getParameters(); PlatformFileBean file = params.getPlatformFileBean(documentId); byte[] bytes = file.getBytes(); String msg = "Name:"+file.getName()+", size:"+file.getEncodedFileContent().length(); Logger.info(msg, "Document"); </syntaxhighlight>