Package org.ametys.plugins.repository.activities

Class Activity

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

org.ametys.plugins.repository.jcr.SimpleAmetysObject<ActivityFactory>

org.ametys.plugins.repository.activities.Activity

All Implemented Interfaces:

AmetysObject, DataAwareAmetysObject, ModelLessDataAwareAmetysObject, ModifiableModelLessDataAwareAmetysObject, DataHolder, ModelLessDataHolder, ModifiableDataHolder, ModifiableModelLessDataHolder, JCRAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableAmetysObject, RemovableAmetysObject

public class Activity
extends SimpleAmetysObject<ActivityFactory>
implements ModifiableModelLessDataAwareAmetysObject

Object representing an activity (such as the creation of content)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTIVITY_ID_KEY	key used to store the activity id when serialized
static final String	ACTIVITY_NAME_KEY	key used to store the activity name when serialized

Constructor Summary

Constructors

Constructor	Description
Activity(javax.jcr.Node node, String parentPath, ActivityFactory factory)	Creates an Activity.

Method Summary

Modifier and Type	Method	Description
ActivityType	getActivityType()	Get the type of the activity from the event type stored in the activity
UserIdentity	getAuthor()	Get the author of the activity
ModifiableModelLessDataHolder	getDataHolder()	Returns the DataHolder of this AmetysObject.
ZonedDateTime	getDate()	Get the date of the activity
String	getEventType()	Get the event type that generated this activity
Map<String,Object>	toJSONForClient()	Serialize the activity as a JSON
void	toSAX(ContentHandler contentHandler)	Generate SAX event to represent all the activity

Methods inherited from class org.ametys.plugins.repository.jcr.SimpleAmetysObject

_getFactory, _invalidateName, _invalidateParentPath, getId, getMetadataHolder, getName, getNode, getParent, getParentPath, getPath, needsSave, remove, rename, revertChanges, saveChanges

Methods inherited from class org.ametys.plugins.repository.AbstractAmetysObject

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, getId, getName, getParent, getParentPath, getPath, hashCode

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.DataAwareAmetysObject

copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getDataNames

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModelLessDataAwareAmetysObject

dataToJSON, dataToSAX, getModelItemTypeExtensionPoint, getType, getValue, getValue, getValueOfType, getValueOfType, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModelLessDataHolder

dataToJSON, dataToSAX, hasValue, hasValueOrEmpty

Methods inherited from interface org.ametys.plugins.repository.ModifiableAmetysObject

needsSave, rename, revertChanges, saveChanges

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModifiableModelLessDataAwareAmetysObject

getComposite, getComposite, getParentDataHolder, getRepositoryData, getRootDataHolder, removeValue, setValue, setValue, synchronizeValues

Field Details

ACTIVITY_ID_KEY

public static final String ACTIVITY_ID_KEY

key used to store the activity id when serialized

See Also:

• Constant Field Values

ACTIVITY_NAME_KEY

public static final String ACTIVITY_NAME_KEY

key used to store the activity name when serialized

See Also:

• Constant Field Values

Constructor Details

Activity

public Activity(javax.jcr.Node node,
 String parentPath,
 ActivityFactory factory)

Creates an Activity.

Parameters:

node - the node backing this Activity

parentPath - the parentPath in the Ametys hierarchy

factory - the factory which created the activity

Method Details

getDataHolder

public ModifiableModelLessDataHolder getDataHolder()

Description copied from interface: DataAwareAmetysObject

Returns the DataHolder of this AmetysObject.

Specified by:

getDataHolder in interface DataAwareAmetysObject

Specified by:

getDataHolder in interface ModelLessDataAwareAmetysObject

Specified by:

getDataHolder in interface ModifiableModelLessDataAwareAmetysObject

Returns:

the DataHolder of this AmetysObject

getActivityType

public ActivityType getActivityType()

Get the type of the activity from the event type stored in the activity

Returns:

the activity type

getEventType

public String getEventType()

Get the event type that generated this activity

Returns:

the event id

getDate

public ZonedDateTime getDate()

Get the date of the activity

Returns:

the date time

getAuthor

public UserIdentity getAuthor()

Get the author of the activity

Returns:

the author identity

toSAX

public void toSAX(ContentHandler contentHandler)
           throws SAXException

Generate SAX event to represent all the activity

Parameters:

contentHandler - the targeted contentHandler

Throws:

SAXException - if an error occurred

toJSONForClient

public Map<String,Object> toJSONForClient()

Serialize the activity as a JSON

Returns:

the JSON