All Classes and Interfaces
Class
Description
Abstract implementation providing basic functionalities supporting
value holding SwingGadgets.FIRSTspirit web application interface.
Map for keeping
application aspects in a type safe manner.Type used for identifying specific aspects within a
task application.Definition of a plug-in describing an application connected to FirstSpirit.
The contextual icon type.
Client service to
open tab applicationsConfiguration interface defining the
appearance of the
related application tab.Configuration builder to configure tab appearance.
Usage:
Usage:
The font style types.
Configuration class for
application tabs.Token representing an application type.
Interface for classes supporting aspect provisioning.
A simple map for type safe aspect mapping.
Type token implementation for aspect types.
Definition of an associate for adding to some index.
A simple base context used for firstspirit hotspots like client plugins.
Definition of execution environments.
Deprecated.
Deprecated.
since 5.2.231004 - Use
BiConsumer insteadDefinition for an agent offering access to
SpecialistsBrokers, each of which operates
on a remote projects that is registered for the given symbolic name.Browser application interface to open and control an integrated browser instance.
Configuration builder to configure
browser applications.Interface for listener on browser change events.
The class that is interested in processing a browser event either implements this interface (and all the methods it contains) or extends the abstract
The class that is interested in processing a browser event either implements this interface (and all the methods it contains) or extends the abstract
BrowserListener.Adapter class (overriding only the methods of interest).An abstract adapter class for receiving browser events.
Interface providing utility methods for
element nodes returned byBrowserApplication.getCurrentDocument()Interface providing methods for node based actions.
Handler for browser node based user interaction.
Builder for creating and binding a
BrowserNodeHandler.Interface providing access to drag context.
A drag listener receiving information on drag events.
A drop handler receiving information on drop events.
Decorator for registered elements.
Selection mode for the registered nodes
An identifier for an event bus.
Container value holding an arbitrary number of unique cards.
Single entry of a catalog providing some meta data on the item and a reference to the item itself.
Generation time accessor to the snippets of a catalog.
Deprecated.
since 5.2.23 - use
FormField insteadAspect definition for a gadget that manages its changes.
String type replacement for class names.
Interface for an action.
Example for the creation of a
Example for the creation of a
ClientItem:Properties and identifier constants for the client-side action plugins.
Context for which actions have been requested.
The handler performing the action.
The provider for actions in a specific context.
Example for the implementation of a
Example for the implementation of a
ClientItemsPlugin:Deprecated.
since 5.0.100 use a specific
plug-in type instead (see hierarchy).Deprecated.
since 5.0.103 with no replacement
Token representing a client plugin scope.
Operation providing means to load resources on the client-side.
Definition of a plug-in providing resource urls to be loaded in webedit.
Operation providing means to execute JavaScript on the client-side.
Item providing a native script for client-side execution in the context of inline editing.
Item providing a native script for client-side execution.
Definition of an item targeting media managing providing a native script for client-side execution.
Item providing a native script for client-side execution in the context of webedit reports.
Item providing a native script for client-side execution in the context of toolbar actions.
Definition of an agent offering ability to register client local service instances.
Definition of an agent specialized in creating client urls.
The type of client.
Basic client url builder definition.
The JavaClient url builder.
The connection modes.
The Webedit url builder.
Simple container providing type-based access to transferred commodities.
FirstSpirit WebEdit Javascript Common API, accessible via
Listener for events about changes of the navigation.
Listener for events about changes of the current Preview-Element.
Listener for events about requests for new elements to be displayed
JavaScriptObject which is passed over to the WorkflowTransitionListeners when a workflow transition happens.
Listener for events about workflow transitions in this websession
Operation for comparing two revisions of a
DataProvider element.Super interface for all FIRSTspirit Components.
Exception to notify about a problem occuring during construction of a component.
Error levels, an exception can have.
The component descriptor contains name, type, class and other information of a
Component.The scope describes the place where the component is available: server-wide, project-local or web-local.
Component type.
Interface for configurable
components.This class may be used to extract the current
Connection associated
with a HttpServletRequest.A context used for client plug-in context menu items.
Implementors of this interface enable to contrast their current value with another one.
Operation for cropping resolutions of a media picture.
Utility class to parse CSV files.
Usage:
Usage:
Class representing a single token
Utility class to write CSV files.
Map for keeping
access aspects in a type safe manner.Type used for identifying specific aspects within an
access plug-in.Plug-in allowing access to data managed by some sort of container.
Session providing access to data.
Builder to configure and create a session via aspectable features.
Aspect providing means to associate data with certain identifiers (e.g. group, parent).
Agent providing methods regarding data association.
Handler for element associations.
The type token of the association handler.
Provides objects for display within a report plug-in's results list.
Renders object-specific data for use in individual snippets of report result lists.
Definition of an accessor for snippet information.
Definition of a provider of information used to visually represent objects in form of snippets.
A data stream providing continuous access to fitting data objects.
Builder to configure and create a stream via aspectable features.
Aspect providing extended means for representing information on a data object.
Set of parameters to be used with the given template.
Operation providing means to delete
elements on the server.Interface representing the result of the
delete operation.Provide means to determine which parts of a site (project) should be re-generated respecting the changes between two revisions.
Change set wrapping the calculated changes of a
DeltaGeneration.Info describing a deleted page.
Dependency rules.
Create delta generation instance:
Create an iterator for generated files:
DeploymentUtil.createDeltaGeneration(ScheduleContext).Create an iterator for generated files:
DeploymentUtil.getGeneratedFiles(ScheduleContext).Abstract class that can be used to implement a factory class for deploy target dialogs.
DeployTargetFactory<DTO extends de.espirit.firstspirit.server.scheduler.DeployTargetDTO,T extends de.espirit.firstspirit.admin.AbstractDeployTarget>
Factory for a deploy target task application.
A descriptor for modules or components.
Dialog in FirstSpirit WebEdit style.
Dialog button.
Transport object for a difference description.
Aspect for
ValueEngineers providing means to compute differences between values.Aspect on support for visualising differences.
Operation providing means to display an element in the client.
Marker for client specific configurators, providing means to define client depending settings.
Aspect for a gadget that is able to handle changes in display settings.
Exception thrown during access on nodes of documents delivered via
BrowserApplication.Aspect definition for editable gadgets.
Model for the current selected gui language of the java client related to the language tabs in the editorial area of the java client.
A node identifying an editor's item.
A node identifying an editor component.
This interface represents an
IDProvider during the ExportOperation.Exception indicating an element not being available.
Browser engine type.
An event agent providing means for custom event buses and events.
An executable item to be used in context menus.
Definition of an toolbar item that is executable and additionally provides sub-items.
Item for inline editing providing an executable operation.
Definition of an item targeting media managing providing an executable operation.
Definition of an item providing an executable operation.
Toolbar menu item providing an executable operation.
An executable item to be used in a toolbar.
Exif data holder object.
The exif-tag representation.
Definition of common and specialized vendor specific Exif tags.
Definition of specialized Canon Exif tags.
Definition of specialized Casio Exif tags.
Definition of specialized Casio Exif tags.
Definition of common Exif tags.
Definition of specialized Fuji Exif tags.
Definition of specialized GPS Exif tags.
Definition of specialized Kyocera Exif tags.
Definition of specialized Nikon Exif tags.
Definition of specialized Nikon Exif tags.
Definition of specialized Olympus Exif tags.
Definition of specialized Panasonic Exif tags.
Definition of specialized Pentax Exif tags.
Definition of specialized Sigma Exif tags.
Definition of specialized Sony Exif tags.
Definition of specialized Sony Exif tags.
Marker Interface defining exif data upload hooks.
Value holder for an exif data element.
Format a given object value of type
ExifValueFormatter.getValueType() if ExifValueFormatter.getSupportedTags() return an array of length 0 or
all defined tags returned by ExifValueFormatter.getSupportedTags().A more complex value formatter which could return different types of <S> and <C> where S=simple value
and C is the complex one.
RuntimeException indicating that a valid mapping/
ExifValue for a defined Tag-Type-Hex or Tag-Type (Integer) was not found.This interface represents a single changed element during the
ExportOperation.Type defining the changed
ExportInfo.This interface represents a
FileHandle during the ExportOperation.Operation providing means to export store elements to files in a
Request this operation via
To get a
file system.Request this operation via
OperationAgent: OperationAgent.getOperation(ExportOperation.TYPE).To get a
file system use FileSystemsAgent.Options for configuring the export of an added
channels provider.Container providing access to the result of the export operation.
Options for configuring the export of an added
schema.Represents a status for an
ExportInfo or ExportInfoFileHandle.Context providing information and accessors for external preview items.
Provides access to an external preview service.
Definition of a plug-in providing specific items providing integrations for external preview services.
Definition of a container of an external resource based reference.
Agent providing means to handle content transport features.
A builder for creating a new feature descriptor.
Definition representing the result of a feature
The analyze result provides information about problems which could appear during the
analyze process.The analyze result provides information about problems which could appear during the
installation of a feature.Definition describing a content transport feature related to a specific project.
Definition representing an error of a
feature analyze processError code definition describing the type of the belonging feature error.
The level of this feature error.
Interface representing a feature transport zip file
created on the server.Agent providing means to handle installation of content transport features.
Configuration options for initiating the feature installation process via
FeatureInstallAgent.installFeature(FeatureInstallOptions).A builder for streamlined creation of
FeatureInstallOptions.Definition representing the result of a feature
installation process.Interface representing the content model of a content transport feature.
Definition of an feature reference referencing a dataset.
Definition of an feature reference referencing a store node.
Definition representing a feature reference.
Type of
feature references.Action progress definition representing the progress of a server side feature transport file creation process.
A basic file based implementation of a
UploadFilter.File entry providing information about a file created within a generation process.
Interface for file handles provided by a
FileSystem.Support for file handle operations.
Callback interface to produce file and path names used for storage in the file system.
Interface representing a filesystem and providing means to operate on file handles.
Agent providing means to access file systems.
The type of a file.
Aspect providing means to filter a data stream via parameterization.
A focus area preset available for a specific image.
Builder for a focus area preset.
The context given to a
FocusAreaProviderPlugin providing access to information about the contextual image.A plugin providing capabilities for detecting focus areas inside an image.
A form managing type.
Implementors
collect references stored in a provided form.Agent providing means to operate with forms.
FirstSpirit WebEdit Javascript API - Store-element identifier.
This interface represents the FirstSpirit only related
meta information stored in directory
.FirstSpirit.Global collection of fs resource keys for icons and colors used in different contexts.
Definition for color based resource keys.
Definition representing a color resource key.
Definition for icon based resource keys.
Definition representing an icon resource key.
Definition of an agent specialized in providing access to fs resources.
Definition of a plug-in providing entries for the future timeline of the multi-perspective-preview.
Marker interface for graphical user interface components.
API for context information that is provided to
Important: The context may change during its lifetime, hence, objects retrieved via the context may be altered or replaced.
Gadget implementations on construction.Important: The context may change during its lifetime, hence, objects retrieved via the context may be altered or replaced.
Interface for a factory that is able to produce a
Gadget.Identifier for gadgets providing information to find named form elements in a gadget model.
Implementing Gadgets
provide an identifier.Operation for a synchronous execution of a schedule entry generating a
PageRef.Aspect providing means to access information on a performed generation task.
Agent providing means to support operating on generating tasks.
Deprecated.
since 5.2.231004 - Use
Supplier insteadAdaptation result object.
Identifies a global web-app by it's
id.Definition of the GOM descriptor for the FirstSpirit catalog gadget.
Aspect for enabling GOM based configuration.
Hot-spot interface to provide a list of values for input components.
Definition of the GOM descriptor for the FirstSpirit index gadget.
Definition of a source for an index gadget.
Interface for GOM elements allowing to define their treatment wrt. indexing.
Interface featuring GOM elements to allow defining their relevancy level with respect to searching their value.
Interface representing a group used in the
permission service.A grouping item providing a set of sub menu items.
Definition of an item providing sub-items.
Interface representing a group root model belonging to the groups.xml file specified by the param (DOCUMENT_NAME.path) in service.ini of permission service.
Deprecated.
since 5.2.1502 use
ProjectMembersAgentDefinition for the server-side implementation part of a GWT-based
Gadget.Host that dispatches transfers to registered handlers depending on the transferred commodities types.
Host that dispatches transfers to registered handlers in a bulk manner, i.e., if the targeted object is registered,
and any of the types to be handled are supported by a transfer, all registered types' data will be resolved and handed
to the handler for further processing.
A transfer handler.
A transfer handler.
An aspect making a gadget hidable.
Definition of an agent offering highlighting capabilities.
Definition of a plug-in providing entries for the historical timeline of the multi-perspective-preview.
Aspect to enable an application to provide an icon.
Definition of form data container that is identified by its ID.
Aspect supporting to identify data objects.
Definition of a IdProvider reference holding container.
Provides an image object for visualization.
Factory for creation of different
Image types.Agent providing image containers.
Generic utility to provide image related operations.
Container of information on an element being imported.
Operation providing means to import store elements from files in a
file system.Deprecated.
since 5.2.513 - use
LayerMapper insteadDeprecated.
since 5.2.513 - use
LayerMapper insteadContainer providing access to the result of the import operation.
Types for inclusion of value ranges in option editors.
Container value holding an arbitrary number of records referring to some data.
Single entry of an index providing some meta data on the item and a reference to the item itself.
Generation time accessor to the value of an index.
Deprecated.
since 5.2.23 - use
FormField insteadDefines an extended preset mode for initial value providing editors.
Aspect for
ValueEngineers providing an initial value.Object providing information and accessors about the context in which inline editing items have been requested.
Definition of an item targeting inline editing.
Aspect providing means to execute a (simple) data integrity validation.
Integrity problem descriptor.
Exception informing about an invalid form definition.
General (abstract) definition of a pluggable FirstSpirit item.
Optional interface for a
Item to support a customized identifier.General type definition of plug-ins providing an arbitrary number of items of a specific item type.
Api object which will be injected as javascript proxy object in the browser apps of FirstSpirit (e.g.
An item to be used in context menus of the java client.
Definition of a plug-in providing specific items for the "new" sub-menu of context menus of the java client.
Definition of a plug-in providing specific items targeting the plugins menu of the java client.
Configurator for java client specific settings on the
display element operation.Definition of a plug-in providing specific items targetting the editorial toolbar of the java client.
Definition of an item providing an executable operation in the java client.
An executable item to be used in java client reports.
JavaClient plug-in providing items.
A marker for a FirstSpirit plug-in that is to run permanently, i.e., throughout a java client's lifetime.
Deprecated.
since 5.1.100 use a specific
plug-in type instead (see hierarchy).Definition of an item targeting the toolbar of the javaclient.
Agent providing access to the overall information of the active job.
The interface for json arrays.
A value class for representing a boolean value in JSON.
This class represents a JSON value that is a date.
Root interface for any kind of value that could be part of a json object.
Interface representing a specialized version of the
GenerationContext for json.The JsonGenerationContext is used to hold and distribute all information regarding the rendering of a JSON document.Logger interface used in the
JsonGenerationContext.Interface for converting any object to a specific type of
JsonElement.A value class representing a null value in JSON.
A value class for representing a numeric value in JSON.
The root interface for json objects.
An interface for representing a json key/value pair containing of a key and a
JsonElement.A value class for representing a String value in JSON.
Specialized
JsonHandler interface for ValueEngineers providing means to transform the related value to JSON.Specialized
JsonHandler interface for DataAccessSessions providing means to transform the related value to JSON.An aspect providing access to a gadget's label.
Aspect for a gadget that might want to hide its label.
Basic renderer of a label for some object types.
Definition for an agent offering information about project persistency languages.
Mapper providing
This mapper is used in
layers to be used for transported Schema instances.This mapper is used in
content transport and
external sync.Default implementation based on a given map mapping from source layer name to target layer name.
Mapping context providing access to the transported
schema and the source layer name.Default implementation of a layer mapper using a given map mapping schema uid
to target layer name.
Legacy api just to provide useful and necessary methods.
Component descriptor for a library referenced and used by a module.
Service for accessing license features and modules.
Interface that describes a general logger that is capable of logging with different severity levels.
A LogLevel is used to describe the severity of an event that is being logged.
The Logging is used to log messages for a given class.
Listener for log events.
This agent is used to control active maintenance mode tasks.
Provides current information about an active
MaintenanceModeTask.A task of this type puts the server into maintenance mode after a customizable period of time.
Describes if other tasks may be executed while the maintenance mode is active.
When the maintenance mode starts, existing sessions may be quit or kept alive.
The maintenance mode may only affect certain projects or the whole FirstSpirit server.
A maintenance mode task consists of up to five stages, from an initial preparation period up to activating the actual maintenance mode.
The notification that a maintenance is imminent may be displayed to the users in different ways.
This class hides and serves as a substitute for the underlying logging system's MDC (mapped diagnostic context)
implementation.
The kinds of marks.
Aspect for
ValueEngineers supporting indexing and searching.This Exception will be thrown if a media constraint setting is violated.
Definition of the exception variant type.
Context providing information and accessors for media managing items.
Definition of an item targeting media managing.
Definition of a plug-in providing specific items for media management.
Interface for listeners on model changes.
Abstract super class for all model types.
Interfaces for modifiable classes providing an indicator on their modification state.
Interface for listeners on modification events.
Interface for a FirstSpirit
module class.Agent providing administrative methods for maintaining FirstSpirit modules and components.
The module installation/update result containing the installed/upgraded module descriptor
and the process log message.
Interface for a class that brokers a class loader instance which is capable of loading public classes.
FirstSpirit Module (FSM) descriptor, containing all information of a specific module and its components.
Module related runtime exception.
This interface represents a single viewport in the multi-perspective preview.
Builder to configure and create a
MPPViewport.A viewport icon type used to symbolize the viewport.
Definition of an agent offering capabilities to modify the viewports of the multi-perspective preview (MPP).
This interface represents a container for viewports.
FirstSpirit JavaScript MPP API, accessible via "MPP_API".
Listener for events about changes of the preview parametrization.
Listener for events about changes of custom parameters.
Listener for events about changes of date / time in MPP.
MultiApplication interface to open and control multiple applications.
Configuration builder to configure
multi applications.Operation for creating new sections.
A node has a
name, attributes ( Node.getAttribute(String), Node.setAttribute(String,String)), and either a textual value or children.Exception thrown when trying to access a component not being available.
Host definition providing means for notification about various events emitted by a
Gadget.Generic utility to provide null-safe operations.
Configurable operation providing means to compare two textual sources.
Operation providing means to open an element's data form.
Operation providing means to open an element's meta data form.
Configurable operation providing means to merge two textual sources.
Definition of an agent specialized in providing access to application operations.
Exception thrown when an operation cannot be performed with the given setup.
Parameter definition for a
Due to limitations of the ContentCreator (webclient), it is not possible to use your own implementations of this interface, use
ReportPlugin.Due to limitations of the ContentCreator (webclient), it is not possible to use your own implementations of this interface, use
Parameter.Factory instead.Deprecated.
since 5.1.5 - use
Parameter insteadFactory for creation of different
Parameter types.Boolean parameter definition.
Deprecated.
since 5.1.5 - use
ParameterBoolean insteadDefinition for objects taking a generic key-mapped collection of parameters.
An object that maps
Parameter to values.Each parameter must have an unique identifier represented by Parameter.getName().Deprecated.
since 5.1.5 - use
ParameterMap insteadSelection parameter definition.
Deprecated.
since 5.1.5 - use
ParameterSelect insteadDefinition for a selectable item.
Definition for a selectable item.
String parameter definition.
Deprecated.
since 5.1.5 - use
ParameterText insteadThe
Although the FirstSpirit internal mechanisms are used, the encryption is not compatible to the password property encryption used by the FirstSpirit server.
PasswordAgent provides access to the internal mechanisms of FirstSpirit which allow to encrypt and
decrypt password strings.Although the FirstSpirit internal mechanisms are used, the encryption is not compatible to the password property encryption used by the FirstSpirit server.
With a path lookup you could
lookup predefined paths for nodes.This script context is available via variable 'context' in serverside scripts executed in the
permission service.General type of FirstSpirit plug-ins.
FirstSpirit WebEdit Javascript Preview API, accessible via
Listener for events about reloaded elements in the preview document.
Operation providing means to control the preview in the original client.
Object containing a map of parameters configured in the Multi-Perspective-Preview,
accessible via
PreviewParameter.Factory.from(Object) on the webserver.Factory providing methods for getting a
PreviewParameter instance.An Agent that is able to create preview urls for
StoreElements.The preview url builder for
Media nodes.Basic preview url builder definition.
Agent offering means to start an external process.
Each ProcessBuilder instance manages a collection of process attributes.
The listener interface for receiving events that associated with progress changes.
Definition of an agent offering access to project specific information.
FirstSpirit project application interface.
Descriptor for a
project app.Task for archiving project repository files.
Version history archiving mode.
Project based server environment.
Agent providing access to user and group information.
Handler to define further options for a project.
Option handler to further restrict a type within a project.
Interface representing the properties of a project in the office import module.
Agent to recalculate the reference graph of
a single element or
the complete project.Aspect to override the application's tasks project requirement.
A restriction defining which and how a project shall be applied.
Interface providing means to configure properties transport in
content transport or
file system sync.Enum describing types available for properties transport.
Aspect defining property processing objects.
Exception indicating that the value given is not valid for the targeted property.
Exception indicating that the requested propery is not available.
Implementors provide values for named properties.
Exception to be thrown in case of an unknown property was requested.
This interface represents an
PropertiesTransportOptions.ProjectPropertyType during the ExportOperation.Marker interface for the public hot spot of FirstSpirit.
Public implementations can be defined in the module.xml of a FirstSpirit module:
Public implementations can be defined in the module.xml of a FirstSpirit module:
A component descriptor for defining a public class.
Agent providing means to answer queries for project-related FirstSpirit elements stored in its repository.
Aspect for
ValueEngineers supporting reference-aware indexing and full text searching.Agent providing means to create reference holding containers for
store elements, data sets, and
external URLs.Aspect for reference containing
ValueEngineers.Generic super type for reference holding containers.
Definition of a callback on changes in a referenced element.
Agent providing means to transform reference holding containers to their persistency form and vice versa.
Support for reference types and prefixes.
Enumeration of options defining a relevancy level.
Interface definition for form data containers providing remote, generic access to transported values and form
information.
Thrown to indicate that a field is not accessible.
Language specific property container of a form's field.
Agent to perform content rendering of FirstSpirit elements.
Rendering result.
Listener which is called when a link to a media is generated.
Node specific renderer, use
RenderingAgent.Renderer.render() or RenderingAgent.Renderer.getResult() to get the rendered template output.An intermediate instance which has to be enriched with a link root before further usage.
Rendering mode, either
RenderingAgent.RenderMode.PREVIEW, RenderingAgent.RenderMode.WEBEDIT, or RenderingAgent.RenderMode.DEFAULT.Rendering result.
FirstSpirit WebEdit Javascript Report API, accessible via
Context providing information and accessors for report plugin items.
Aspect providing means to show data in a public report within a client.
Item for report plugin providing an executable operation.
Aspect for providing items operating on a report's entries.
Adapter for implementation convenience.
Interface for report plug-ins integrated in both clients ContentCreator and SiteArchitect.
Deprecated.
since 5.1.5 - use
DataProvider insteadDeprecated.
since 5.1.5 - use
DataRenderer insteadAspect providing means to match requests.
Operation providing means to select from a set of answers.
Definition of an answer object.
The kind of the operation.
Marker aspect for resizable gadgets.
Definition for an agent offering access to resolution information defined for the underlying project.
Aspect for enabling revision aware sessions.
FirstSpirit server run level with increasing level.
Agent providing information about the current FirstSpirit server
RunLevel.Agent providing access to all available
ScheduleTaskFactorys.Definition of an application providing persistency and execution means for a schedule task.
Type used for identifying specific aspects within a
running task.Container providing means to control a task.
Agent providing control handles on a job's tasks.
Interface for a container of custom task data.
Container providing means to access a task's definition.
Context for a task definition, providing specific, task- and job-related agents to access their information.
Agent providing information on the defined tasks within the context's job.
Helper definition for creating and opening a dialog for a schedule task.
Factory to create a task dialog.
Execution context for a task execution, providing specific, task- and job-related agents to access their information.
Executor providing means to execute and validate a scheduled task's operation.
Module class to hook new schedule task types into FirstSpirit.
Marker interface for task data transfer and persistence object.
Definition of a form for configuring a related schedule task.
Container holding configuration information of a schedule task.
Factory for forms allowing to configure a schedule task's data.
Wizard dialog for creating schedule entries.
Factory to create a wizard dialog for schedule entries.
Interface representing the or schema model.
Definition of an agent offering capabilities to modify the settings for the search indexer.
Provider type for query segments.
Simple model for a single
IDProvider selection, used in different selection contexts of the
java-client (e.g.Operation for a lightweight selection of a list of simple options.
Highly configurable operation providing means to select one or more store elements.
A selection container providing access to the selected element and remote project name.
Selection user interface variants.
Aspect type providing means to edit a gadget component in a separate window/dialog.
An item used as separator in java client context menus.
Aspect providing an API to highlight textual sequences.
Aspect definition for providing serialization means for value's of a specific type.
Environment definition for server operations.
FirstSpirit service interface.
A component descriptor for defining a service.
A service proxy is an optional, client-side service implementation.
Map for keeping
session aspects in a type safe manner.Type used for identifying specific aspects within an
access plug-in.Map for keeping
session building aspects in a type safe manner.Type used for identifying specific aspects within an
session builder.Locator to look up services.
Agent providing means to durably store job related settings.
Exception stating that there is no setting with a requested name.
Operation enabling to show a form as a dialog.
Exception informing about an invalid ruleset definition.
Configurable operation providing means to open and refresh a plugin based report.
Singlelineable aspect for a swing gadget, whose component supports a single line layout.
Interface definition for a form data container containing sitestore variables.
Broker for requesting services or providers, specialized on (small) tasks or information.
Token representing a specialist type.
Aspect for providing static items for a data access report.
Listener on steps, their states and their progress.
Definition for an agent offering access to FirstSpirit's stores.
Definition for an agent offering direct access to store elements by referencing information.
Map for keeping
stream building aspects in a type safe manner.Type used for identifying specific aspects within a
stream builder.Generic utility to provide stream related operations.
Aspect providing means to represent its value as localized string.
Aspect providing means to represent its value type as localized string.
Generic utility to provide string related operations.
Host that enables transfers from registered suppliers.
Host that enables transfers from registered suppliers.
A supplier providing a specific type of commodity that further enables to request to take the supplied
commodities out of the supplier's value (realizing a cut operation in two steps).
A supplier providing a specific commodity type.
A supplier providing a specific commodity type.
Swingapplication interface to open and control a swing application.
Configuration builder to configure
swing applications.Factory to create a
component.Defines a provider of a swing component.
Aspect for swing based gadgets that provide a focusable component.
Handler providing means to actually give the focus to a focusable.
View mode for gadgets.
The base type for all swing gadget objects in the pluggable FirstSpirit module/component architecture.
Context container for swing based gadgets.
Definition for a factory providing means to
create a specific SwingGadget.Synchronizes the
bodies of all pages referencing a PageTemplate by
Creating bodies that are defined in the template but missing in the page
Removing bodies that are defined in the page but removed from the template
Setting the "hidden" attribute as defined in the template
Interface representing the result of the
synchronize operation.This
SyncOperationException may be thrown when using ExternalSync API.This interface can be used to be informed about tab changes of a specific
application tab inside the tab application area.An abstract adapter class for receiving tablistener events.
Definition for an entry in the timeline of the multi-perspective-preview.
Factory for creation of
TimelineEntry.Provides entries for the timeline of the multi-perspective-preview.
FirstSpirit client interface for hierarchically organized data.
Definition of an item providing a toggleable state.
Listener to inform about selection change events.
A toggleable item to be used in a toolbar.
A context used for client plugin toolbar items.
Agent providing means to gather and collect statistical, timing and usage information.
This kind of event is thrown whenever a tracking point has been hit, e.g. with
TrackingAgent.track(UUID, String, String).Definition for an agent providing means to produce transfer relevant objects.
Exception thrown if consuming a commodity failed.
Handler for transfer supplying.
Host that enables transfers from registered suppliers.
A supplier providing a specific commodity type.
Aspect for providing support of transfer handling.
Aspect providing means to handle transfers.
Aspect providing means to handle transfers.
Host that dispatches transfers to registered handlers in a bulk manner, i.e., if the targeted object is registered,
and any of the types to be handled are supported by a transfer, all registered types' data will be resolved and handed
to the handler for further processing.
A transfer handler.
Aspect for providing support of transfer supply.
Aspect providing generic means to supply transfers by arbitrary sources.
Transfer type, a typed wrapper for data flavors.
Aspect providing generic means to validate transfers by arbitrary sources in depth.
Interface representing the transformation rules defined in office import module.
The translation context.
Host that dispatches translation requests to registered handlers.
Handler providing means to translate a certain type of content.
Operation providing means to open a translation view on the client-side.
Definition of a plug-in providing access to translation services.
Content type, a typed wrapper for translatable content flavors.
Options for how to treat associations wrt. indexing.
Agent providing UI related functionality.
Indicators for the UI's status.
Deprecated.
since 5.2.231004 - Use
Function insteadDeprecated.
since 5.2.231004 - Use
Consumer insteadException thrown for unsupported type's of gadgets.
Aspect providing means to update DAP parameters from within a DAP.
The interface Upload filter.
Media upload hook hot spot interface of FirstSpirit.
This exception indicates a media insertion/upload into the repository has been rejected.
Definition for an agent offering information about the projects seo und short urls.
Each instance of this interface represents an
UrlAgent.UrlEntry for a MediaFolder.Each instance of this interface represents an
UrlAgent.UrlEntry for a Media.Each instance of this interface represents an
UrlAgent.UrlEntry for a PageRefFolder.Each instance of this interface represents an
UrlAgent.UrlEntry for a PageRef.This interface represents a single url entry.
Replacement for the FirstSpirit v4 interface
UrlCreator.Factory to transform a legacy
UrlCreator implementation into a new
UrlCreator instance.The different flavours an url can be created in.
Specification container for url creator.
An event that is fired when a stored URL is changed.
Allows for distinguishing different event types.
Factory producing URLs for
media and
content producers.Context to be given to the
UrlFactory.The context in which an URL will be request using the
UrlSupporting aspect.Builder for an
UrlGenerationContext.Aspect providing means to support URLs for data objects.
Interface representing a user used in the
permission service.Definition for an agent providing access to current user information.
Interface representing a users model belonging to the users.xml file specified by the param (DOCUMENT_NAME.users) in service.ini of permission service.
Definition for an agent providing access to user statistics.
Agent providing means to validate form data against defined rules.
Validation scope, either
ValidationAgent.ValidationScope.SAVE or ValidationAgent.ValidationScope.RELEASE.Aspect for
ValueEngineers supporting value validation.Instances emit an
InvalidValueException whenValidationSupporting.Emitter.signalInvalidValue(String) is called.Host that enables transfers from registered suppliers.
A commodities validator.
Aspect providing means to compare one value to another one in terms of equal meaning.
Engineer operating on values.
Type token for
value engineer aspect types.Context container for value engineers.
A factory that is able to create a
ValueEngineer.Aspect definition for a persistency object holder of a specified type of value.
An indexer on field based values.
Aspect providing means to support indexing.
Aspect providing means to liken its value to another one.
Service providing a value based on parameterization.
View mode for list components.
FirstSpirit web application interface.
A descriptor for a
web app.Contains filter definition based on an include and exclude list of paths.
The scope describes the place where the component is available: global or project-local webapps.
Identifier for
global or project-local web applications.Factory for
WebAppId objects.Colors compatible with the Webedit color theme.
Provides information of which elements should be available for workflow actions and in which release state is a given element.
Factory to
create a WorkflowGroup.Kind of release state of a given element.
Definition of an item providing an executable operation in the web client.
An executable item to be used in web client reports.
Definition of a plug-in providing specific items for inline editing.
Webedit plug-in providing items.
A marker for a FirstSpirit plug-in that is to run permanently throughout a WebEdit session's lifetime.
Deprecated.
since 5.1.5 - use
ReportPlugin insteadObject definition for a status information in webedit.
Builder for a
WebeditStatusNote.Provides context information useful for creating statue notes with
WebeditStatusNoteContext.createNote().Item definition for a status information in webedit.
Definition of a plug-in providing specific items for status information in webedit.
This interface maps a given
SiteStoreFolder to a (maybe new) PageFolder and is used
during create and move operations in the FirstSpirit WebClient.Plug-in definition targeting the 'Actions' drop-down menu of the WebClient toolbar to provide customized,
project-specific actions.
Item definition for the toolbar in Webedit.
Agent providing specific information of the webedit UI.
A web based project environment.
In which web scope is the component available: preview, staging, live, webedit or global.
Definition of a pluggable gadget providing means to a build web-technology based form element on server side.
Definition for factories producing custom client-side gadgets using web-technologies (i.e., HTML, JavaScript, and CSS).
Definition of the host providing means to access and communicate with a web gadget's framework environment.
Definition of a web server component.
A component descriptor for defining a web server.
Optional aspect defining this gadget component to have a fixed width indicator.
Generic utility to provide windows related operations.
Exception thrown if a timeout occurred.
Context representing a manual activity in the corresponding workflow process.
A workflow group contains elements for common workflow actions.
BiFunctioninstead