ro.sync.ecss.extensions.api.access

Class EditingSessionContext

java.lang.Object

ro.sync.ecss.extensions.api.access.EditingSessionContext

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public abstract class EditingSessionContext
extends java.lang.Object

The editing session context. An editing session correspond to an user editing a document in the editor. Custom attributes can be registered from the API which can include information about the context of the editing, e.g. the user that performs the edit, the project in whose scope the editing session was started, etc. The session context is serializable and it serializes only the attributes whose value is serializable. The rest of the attributes are ignored.

Since:

15.2

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

Constructor Summary

Constructors

Constructor and Description
EditingSessionContext()

Method Summary

Methods

Modifier and Type	Method and Description
abstract java.lang.Object	getAttribute(java.lang.String attr) Gets the value of a custom attribute.
abstract java.util.Set<java.lang.String>	getAttributes() Returns the set of all attributes.
abstract void	setAttribute(java.lang.String attr, java.lang.Object value) Sets a custom attribute for the editing session.

Methods inherited from class java.lang.Object

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

Constructor Detail

EditingSessionContext

public EditingSessionContext()

Method Detail

setAttribute

public abstract void setAttribute(java.lang.String attr,
                java.lang.Object value)

Sets a custom attribute for the editing session. If the attribute is already set it overrides the previous value.

Parameters:

attr - The attribute name.

value - The attribute value.

getAttribute

public abstract java.lang.Object getAttribute(java.lang.String attr)

Gets the value of a custom attribute.

Parameters:

attr - The attribute name.

Returns:

The attribute value or null if the attribute was not set.

getAttributes

public abstract java.util.Set<java.lang.String> getAttributes()

Returns the set of all attributes.

Returns:

The set of all attributes.