Difference between revisions of "GetDocument"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
Line 15: | Line 15: | ||
;Parameters: | ;Parameters: | ||
:; | :;documentID:The ID of a document stored in the platform. | ||
;Returns: | ;Returns: |
Revision as of 04:04, 16 January 2014
Description...
- Syntax
- <syntaxhighlight lang="java" enclose="div">
Result result = Functions.__apiName__(String objectName, String fields, String criteria); Result result = Functions.__apiName__(String objectName, String fields, String criteria
[, Parameters params] );
Result result = Functions.__apiName__(String objectName, String fields, String criteria); Result result = Functions.__apiName__(String objectName, String fields, String criteria,
String sortBy, String sortOrder, String sortBy2, String sortOrder2, int offset, int numberOfRows);
</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
-
- Use result.getParameters() to get the params from the Result object.
- Call getPlatformFileBean() on the params, passing the document ID as a string.
- 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 = 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>