Package lumis.portal.activitystream

Class ActivityDocument

java.lang.Object

lumis.portal.bigdata.Document

lumis.portal.activitystream.ActivityDocument

All Implemented Interfaces:

java.io.Serializable, java.util.Map<java.lang.String,java.io.Serializable>

@StableMinor(version="17.0",
             sinceVersion="8.2")
public class ActivityDocument
extends Document

Activities are stored on portal big data as this document.

Activity documents are generated by the activity stream framework and should not be modified manually. Activity framework clients should use this document only for reading data.

Since:

8.2.0

Version:

$Revision$ $Date$

See Also:

ActivityDocumentType, ManagerFactory.getBigDataManager(), IBigDataManager.getDefaultRepository(), Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ActivityDocument.IActivity	Contains data in an ActivityDocument that corresponds to an Activity.
static interface	ActivityDocument.IActivityActor	Contains data in an ActivityDocument that corresponds to an ActivityActor.
static interface	ActivityDocument.IActivityDocumentPriority	Contains information about a priority to be applied to different principals, stored in a ActivityDocument .
static interface	ActivityDocument.IActivityDocumentPriorityIncludedEntry	Contains information about which principals a priority applies to.
static interface	ActivityDocument.IActivityObject	Contains data in an ActivityDocument that corresponds to an ActivityObject.

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

java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ActivityDocument(DocumentType documentType)

Method Summary

Modifier and Type	Method	Description
ActivityDocument.IActivity	getActivity()	Returns an API for accessing the activity 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

ActivityDocument

protected ActivityDocument(DocumentType documentType)

Method Detail

getActivity

public ActivityDocument.IActivity getActivity()

Returns an API for accessing the activity 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 ActivityDocument.IActivity object to be used.

Returns:

the activity fields access API.

Since:

8.2.0