Package de.espirit.firstspirit.access

Interface BaseContext

All Superinterfaces:

SpecialistsBroker

All Known Subinterfaces:

ClientScriptContext, Content2ScriptContext, ContextMenuContext, ExternalPreviewContext, GenerationContext, GenerationScriptContext, GuiScriptContext, InlineEditContext, MediaManagementContext, PermissionServiceScriptContext, ProjectScriptContext, ReportContext<T>, ScheduleContext, ScheduleTaskExecutionContext, ScriptContext, ToolbarContext, UrlFactoryContext, WebeditStatusNoteContext, WorkflowAgent.WorkflowProcessContext, WorkflowScriptContext

public interface BaseContext
extends SpecialistsBroker

A simple base context used for firstspirit hotspots like client plugins.

Since:

4.2.417

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BaseContext.Env	Definition of execution environments.

Method Summary

Modifier and Type	Method	Description
boolean	is(BaseContext.Env env)	Returns true if the given env matches the contexts execution environment, false otherwise. Note: There may be defined multiple environments for a context.
void	logDebug(String message)	Logs the given message as debug message.
void	logError(String message)	Logs the given message as error message.
void	logError(String message, Throwable ex)	Logs the given message and the trace of the throwable as error message.
void	logInfo(String message)	Logs the given message as info message.
void	logWarning(String message)	Logs the given message as warning.

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

requestSpecialist, requireSpecialist

Method Details

logDebug

void logDebug(String message)

Logs the given message as debug message.

Parameters:

message - the debug message

Since:

4.2.417

logInfo

void logInfo(String message)

Logs the given message as info message.

Parameters:

message - the info message

Since:

4.2.417

logWarning

void logWarning(String message)

Logs the given message as warning.

Parameters:

message - the warn message

Since:

4.2.417

logError

void logError(String message)

Logs the given message as error message.

Parameters:

message - the error message

Since:

4.2.417

logError

void logError(String message,
 Throwable ex)

Logs the given message and the trace of the throwable as error message.

Parameters:

message - the error message

ex - the exception to log

Since:

4.2.417

is

boolean is(BaseContext.Env env)

Returns true if the given env matches the contexts execution environment, false otherwise.
Note: There may be defined multiple environments for a context.

Parameters:

env - The environment to check for.

Returns:

true if the given env matches the contexts execution environment, false otherwise.

Since:

5.0.100