lumis.portal.bigdata

Class StandardDocument

java.lang.Object

lumis.portal.bigdata.Document

lumis.portal.bigdata.StandardDocument

All Implemented Interfaces:

Serializable, Map<String,Serializable>

Direct Known Subclasses:

ContentVersionDocument

@StableMinor(version="12.1",
             sinceVersion="8.1")
public class StandardDocument
extends Document

Document that provides standard fields access.

Since:

8.1.0

Version:

$Revision: 23263 $ $Date: 2019-10-09 21:03:57 +0000 (Wed, 09 Oct 2019) $

See Also:

StandardDocumentType, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StandardDocument.Standard API that provides access to standard fields.

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StandardDocument(StandardDocumentType documentType) Creates a new standard document based on the given type.

Method Summary

Modifier and Type	Method and Description
StandardDocument.Standard	getStandard() Returns an API for accessing the standard fields in this document.

Methods inherited from class lumis.portal.bigdata.Document

clear, containsKey, containsValue, entrySet, get, get, getDocumentType, getId, isEmpty, keySet, newFieldValueProxy, put, put, putAll, remove, setId, size, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

StandardDocument

protected StandardDocument(StandardDocumentType documentType)

Creates a new standard document based on the given type.

Parameters:

documentType - the document type.

Since:

8.1.0

Method Detail

getStandard

public StandardDocument.Standard getStandard()

Returns an API for accessing the standard fields in this document.

If a document field value is modified without using this API, the object previously returned by this method (or its child objects) may no longer reflect the correct data in the document. In this case this method should be called again to obtain another Standard object to be used.

Returns:

the standard fields access API.

Since:

8.1.0

See Also:

StandardDocumentType.StandardFields