Package de.espirit.firstspirit.access

Interface ClientScriptContext

All Superinterfaces:

BaseContext, ProjectScriptContext, ScriptContext, SpecialistsBroker

All Known Subinterfaces:

Content2ScriptContext, GuiScriptContext, WorkflowScriptContext

public interface ClientScriptContext
extends ProjectScriptContext

Script context providing the current user and a context element.

Since:

3.1.170

Nested Class Summary

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.BaseContext

BaseContext.Env

Method Summary

Modifier and Type	Method	Description
IDProvider	getElement()	The element this context is operating on.
StoreElement	getStoreElement()	Deprecated, for removal: This API element is subject to removal in a future version. since 5.1.104, use getElement().
User	getUser()	Provides the user object for this context.
Group[]	getUserGroups()	Provides the array of groups for this context.

Methods inherited from interface de.espirit.firstspirit.access.BaseContext

is

Methods inherited from interface de.espirit.firstspirit.access.project.ProjectScriptContext

getProject, getUserService

Methods inherited from interface de.espirit.firstspirit.access.ScriptContext

getConnection, getProperties, getProperty, logDebug, logError, logError, logInfo, logWarning, removeProperty, setProperty

Methods inherited from interface de.espirit.firstspirit.agency.SpecialistsBroker

requestSpecialist, requireSpecialist

Method Details

getUser

User getUser()

Provides the user object for this context.

Returns:

The user object.

Since:

3.1.170

getUserGroups

Group[] getUserGroups()

Provides the array of groups for this context.

Returns:

The array of user groups.

Since:

3.1.170

getStoreElement

@Deprecated(forRemoval=true)
StoreElement getStoreElement()

Deprecated, for removal: This API element is subject to removal in a future version.

since 5.1.104, use getElement().

Since:

3.1.170

getElement

IDProvider getElement()

The element this context is operating on. In contrast to getStoreElement() this method returns instances of Dataset where getStoreElement() returns an instances of Content2.

Returns:

the context element.

Since:

5.1.104