Uses of Interface
de.espirit.firstspirit.access.store.StoreElement

Packages that use StoreElement

Package	Description
de.espirit.firstspirit.access
de.espirit.firstspirit.access.packagepool
de.espirit.firstspirit.access.store
de.espirit.firstspirit.access.store.contentstore
de.espirit.firstspirit.access.store.globalstore
de.espirit.firstspirit.access.store.mediastore
de.espirit.firstspirit.access.store.pagestore
de.espirit.firstspirit.access.store.sitestore
de.espirit.firstspirit.access.store.templatestore
de.espirit.firstspirit.access.store.templatestore.gom
de.espirit.firstspirit.store.operations
de.espirit.firstspirit.workflow

Uses of StoreElement in de.espirit.firstspirit.access

Methods in de.espirit.firstspirit.access with type parameters of type StoreElement

Modifier and Type	Method	Description
static <T extends StoreElement> T	AccessUtil.copyStoreElement(T element, StoreElement parent)	Creates a copy of the given element below the parent.
static <T extends StoreElement> T	AccessUtil.copyStoreElement(T element, StoreElement parent, boolean checkRules)	Creates a copy of the given element below the parent.

Methods in de.espirit.firstspirit.access that return StoreElement

Modifier and Type	Method	Description
StoreElement	ClientScriptContext.getStoreElement()	Deprecated, for removal: This API element is subject to removal in a future version. since 5.1.104, use ClientScriptContext.getElement().
@Nullable StoreElement	WorkflowContext.getStoreElement()	Deprecated, for removal: This API element is subject to removal in a future version. since 5.0.207 use WorkflowContext.getElement() instead

Methods in de.espirit.firstspirit.access with parameters of type StoreElement

Modifier and Type	Method	Description
static <T extends StoreElement> T	AccessUtil.copyStoreElement(T element, StoreElement parent)	Creates a copy of the given element below the parent.
static <T extends StoreElement> T	AccessUtil.copyStoreElement(T element, StoreElement parent, boolean checkRules)	Creates a copy of the given element below the parent.
Task	UserService.createTask(StoreElement storeElement, Workflow workflow, Task task)	Clone a existing task on a StoreElement.
Task	UserService.createTask(StoreElement storeElement, Workflow workflow, String comment)	Create task on StoreElement.
Task	UserService.createTask(StoreElement storeElement, Workflowable flowable, Workflow workflow, String comment)	Create task on Workflowable.
void	UserService.exportStoreElements(OutputStream out, StoreElement[] elements, @Nullable ExportHandler exportHandler)	Exports the given store elements.
void	UserService.importStoreElements(ZipFile exportFile, StoreElement parent, ImportHandler importHandler)	Import of a file with store elements.

Uses of StoreElement in de.espirit.firstspirit.access.packagepool

Methods in de.espirit.firstspirit.access.packagepool with parameters of type StoreElement

Modifier and Type	Method	Description
boolean	ContentPackage.isValidNodeType(StoreElement node)	Only accepts nodes from pagestore, sitestore, or mediastore.
boolean	Package.isValidNodeType(StoreElement node)	Validates the given node's type.
boolean	TemplatePackage.isValidNodeType(StoreElement node)	Only validates true for nodes from templatestore, contentstore, and mediastore

Uses of StoreElement in de.espirit.firstspirit.access.store

Subinterfaces of StoreElement in de.espirit.firstspirit.access.store

Modifier and Type	Interface	Description
interface	ContentProducer
interface	IDProvider
interface	LanguageInfo	This interface provides language specific infos
interface	PackagePoolItem	All items which may be added to a package implement this.
interface	Previewable	Deprecated. since 5.2.190105, please use PreviewUrlAgent.getContentProducerBuilder() or PreviewUrlAgent.getMediaBuilder() to create preview urls.
interface	Referenceable	Interface for IDProviders that support referencing.
interface	Store	These are the valid store types: Store.Type.PAGESTORE Store.Type.MEDIASTORE Store.Type.CONTENTSTORE Store.Type.SITESTORE Store.Type.TEMPLATESTORE Store.Type.GLOBALSTORE

Methods in de.espirit.firstspirit.access.store with type parameters of type StoreElement

Modifier and Type	Method	Description
static <T extends StoreElement> StoreElementFilter	StoreElementFilter.create(Class<T> type)
static <T extends StoreElement> StoreElementFilter	StoreElementFilter.create(Class<T> type, Filter<StoreElement> filter)
<T extends StoreElement> Listable<T>	StoreElement.getChildren(@NotNull Class<T> type)	Get the element's direct children that are instances of the given type.
<T extends StoreElement> Listable<T>	StoreElement.getChildren(@NotNull Class<T> type, boolean recurse)	Get the element's children that are instances of the given type.
<T extends StoreElement> Listable<T>	StoreElement.getChildren(Filter.TypedFilter<T> filter, boolean recurse)	Get the element's children passing the given typed filter.

Methods in de.espirit.firstspirit.access.store that return StoreElement

Modifier and Type	Method	Description
@Nullable StoreElement	StoreElementFilter.filter(Object element)	Filter the given element and return either an object of this classes type T or null, if the element does not match the filter as defined by Filter.accept(Object).
@Nullable StoreElement	StoreElement.getFirstChild()	Provides the first child node.
@Nullable StoreElement	StoreElement.getNextSibling()	Provides the next sibling store element.
@Nullable StoreElement	StoreElement.getParent()	Return parent StoreElement which is null for deleted elements or store-roots.
@Nullable StoreElement	StoreElement.getPreviousSibling()	Provides the previous store element.
StoreElement	Permission.getStoreElement()	Returns the underlying element.
StoreElement	StoreElement.importStoreElement(ZipFile exportFile, @Nullable ImportHandler importHandler)	Imports the first root node from the given zip exportfile.
StoreElement	Store.restore(ElementInfo elementInfo, @Nullable IDProvider parent)	Restore the element defined by the given information.

Methods in de.espirit.firstspirit.access.store that return types with arguments of type StoreElement

Modifier and Type	Method	Description
Listable<StoreElement>	StoreElement.getChildren()	Get the element's direct children.
@NotNull Class<StoreElement>	StoreElementFilter.getType()	Get the filter type.
Listable<StoreElement>	StoreElement.importStoreElements(ZipFile exportFile, @Nullable ImportHandler importHandler)	Imports all root nodes from the given zip exportfile.

Methods in de.espirit.firstspirit.access.store with parameters of type StoreElement

Modifier and Type	Method	Description
void	StoreListener.addedToScope(StoreElement storeElement)	Called if the given storeElement was inserted.
void	ImportHandler.afterAdjustAttributes(StoreElement storeElement)	Called after adjusting the StoreElement attributes
void	ExportHandler.afterExport(StoreElement storeElement)
void	ImportHandler.afterExternalAttributeImport(StoreElement storeElement)	Called after restoring the external attributes of the StoreElement
void	ImportHandler.afterImportData(StoreElement storeElement)	Called after importing custom data of the StoreElement
void	ImportHandler.afterStoreElementImport(StoreElement storeElement)	Called after the StoreElement has been constructed
void	StoreElement.appendChild(StoreElement child)	Deprecated. since 4.2.204 - use IDProvider#moveChild(child)
void	StoreElement.appendChildBefore(@NotNull StoreElement child, @Nullable StoreElement nextsibling)	Deprecated. since 4.2.204 - use IDProvider#moveChild(child, nextsibling)
void	ExportHandler.beforeExport(StoreElement storeElement)
void	StoreListener.elementChanged(StoreElement storeElement)	Called if the given storeElement was changed.
void	StoreListener.elementMoved(StoreElement storeElement, StoreElement oldParent)	Called if an element is moved.
int	StoreElement.getChildIndex(StoreElement child)
void	PermissionListener.permissionChanged(StoreElement storeElement, Permission permission)	Notifies about a permission change.
void	StoreElement.removeChild(StoreElement child)	Removes the given child from this element.
void	StoreListener.removedFromScope(StoreElement storeElement, StoreElement parent)	Called if the given storeElement was removed.
void	StoreElement.replaceChild(StoreElement oldChild, StoreElement newChild)	Replaces an element's child by another child.
void	StoreListener.structureChanged(StoreElement storeElement)	Called if the path of the given storeElement was changed.

Method parameters in de.espirit.firstspirit.access.store with type arguments of type StoreElement

Modifier and Type	Method	Description
static StoreElementFilter	StoreElementFilter.create(Filter<StoreElement> filter)
static <T extends StoreElement> StoreElementFilter	StoreElementFilter.create(Class<T> type, Filter<StoreElement> filter)

Constructor parameters in de.espirit.firstspirit.access.store with type arguments of type StoreElement

Modifier	Constructor	Description
	StoreElementFilter(Class<StoreElement> type)

Uses of StoreElement in de.espirit.firstspirit.access.store.contentstore

Subinterfaces of StoreElement in de.espirit.firstspirit.access.store.contentstore

Modifier and Type	Interface	Description
interface	Content2	Interface providing means to operate on content2 elements.
interface	ContentFolder	This interface provides methods to handle the ContentStore-folder
interface	ContentStoreRoot	This interface provides method to get ContentStore-table object for given ContentStore-table name
interface	Dataset	Interface providing means to operate on datasets.

Uses of StoreElement in de.espirit.firstspirit.access.store.globalstore

Subinterfaces of StoreElement in de.espirit.firstspirit.access.store.globalstore

Modifier and Type	Interface	Description
interface	GCABody	Interface representing a body in globalstore.
interface	GCAFolder	This interface represents folders in globalstore
interface	GCAPage	Interface providing means to operate on global store pages.
interface	GCASection	Interface providing means top operate on global store sections.
interface	GlobalContentArea	Root node for global content.
interface	GlobalStoreRoot	Interface providing methods to handle global store root and short access to specific children (e.g.
interface	ProjectProperties	Interface providing means to operate on project properties.
interface	URLProperties	Provide stored URLs for media, content producer, or folder nodes.
interface	UserProperties

Methods in de.espirit.firstspirit.access.store.globalstore with parameters of type StoreElement

Modifier and Type	Method	Description
GCAPage[]	GlobalStoreRoot.getAllPages(StoreElement root)	Deprecated. since 5.0.100 - use getChildren(GCAPage.class) instead

Uses of StoreElement in de.espirit.firstspirit.access.store.mediastore

Subinterfaces of StoreElement in de.espirit.firstspirit.access.store.mediastore

Modifier and Type	Interface	Description
interface	File	This interface provides methods to handle a media object of type FILE from the MediaStore.
interface	Media	This interface provides methods to handle a media object from the MediaStore.
interface	MediaElement	Marker element for media objects.
interface	MediaFolder	This interface provides methods to handle the MediaStore-folder
interface	MediaStoreRoot	This interface provides methods to handle the MediaStore-Root
interface	Picture	This interface provides methods to handle a media object of type PICTURE from the MediaStore.
interface	PictureResolution	This interface provides methods to get the specification of a PictureResolution for a medium from the MediaStore.

Uses of StoreElement in de.espirit.firstspirit.access.store.pagestore

Subinterfaces of StoreElement in de.espirit.firstspirit.access.store.pagestore

Modifier and Type	Interface	Description
interface	Body	This interface provides methods to handle the bodys of pages in the PageStore.
interface	Content2Section	This is a section which renders new content.
interface	DataProvider	Interface providing methods for data access. Ensure to call DataProvider.setData(de.espirit.firstspirit.access.store.Data) after modifications of the provided data object.
interface	Page	This interface provides methods to handle the Pages in the PageStore
interface	PageFolder	This interface provides methods to handle the PageStore-folder
interface	PageStoreRoot	This interface represents the PageStore-Root node.
interface	Section<T extends SectionTemplate>	This interface provides methods to handle the sections of Pages in the PageStore.
interface	SectionReference<T extends SectionTemplate>	Interface providing means to operate on section references.

Uses of StoreElement in de.espirit.firstspirit.access.store.sitestore

Subinterfaces of StoreElement in de.espirit.firstspirit.access.store.sitestore

Modifier and Type	Interface	Description
interface	Content2Params	Parameters container for use with database referencing elements.
interface	DocLink	This interface represents a document link.
interface	DocumentGroup	A DocumentGroup groups DocumentGroupLink's as their child nodes (see getChildren()).
interface	FolderLangSpec	This interface provides methods to handle the FolderSpecification (language dependent properties of the folder at SiteStore)
interface	PageGroup	This interface provides methods to handle the page-groups in the SiteStore For creating a page-group see de.espirit.firstspirit.access.store.sitestore.SiteStoreRoot
interface	PageLangSpec	This interface provides methods to handle the PageSpecification (language dependent properties of a site at SiteStore)
interface	PageRef	This interface provides methods to handle the pagereferences in the SiteStore
interface	PageRefFolder	This interface provides methods to handle the SiteStore-folder
interface	SiteStoreFolder	Interface providing means to operate on site store folders.
interface	SiteStoreRoot	This interface provides methods to handle the SiteStore-Root
interface	StartNode	This interface combines elements which could be start nodes in sitestore.

Methods in de.espirit.firstspirit.access.store.sitestore with parameters of type StoreElement

Modifier and Type	Method	Description
void	DocumentGroup.appendChild(StoreElement child)	Appends a child element to this group, which must be an instance of either DocLink whith a PageRef or SiteStoreFolder.
void	DocumentGroup.appendChildBefore(@NotNull StoreElement child, @Nullable StoreElement before)	Appends a child element to this group, inserting it before a reference element.
boolean	DocumentGroup.containsElement(StoreElement element)	Indicates whether the given element is part of this document group.
void	DocumentGroup.replaceChild(StoreElement oldChild, StoreElement newChild)	Replaces a child element with another.

Uses of StoreElement in de.espirit.firstspirit.access.store.templatestore

Subinterfaces of StoreElement in de.espirit.firstspirit.access.store.templatestore

Modifier and Type	Interface	Description
interface	Allowed	This interface represents the allowed element which is a child of a page template.
interface	ChannelSourceProvider	This interface provides comprehensive methods for all elements which provides channel specific (belonging to a template set) source content.
interface	FormatTemplate	Definition of a template specialized for formatting tasks.
interface	FormatTemplateChannel	Definition of a container for channel specifica of a FormatTemplate.
interface	FormatTemplateContainer	This interface provides methods to handle FormatTemplateContainer in TemplateStore, a container for FormatTemplates
interface	FormatTemplateFolder	This interface provides methods to handle FormatTemplateFolder in TemplateStore
interface	FormatTemplates	This interface represants the subroot for format templates in templatestore.
interface	GomSourceProvider	The GOM (gui object model) describes the input form presented to the end user (editor).
interface	LinkTemplate	A link template is a container for the rendering template for links.
interface	LinkTemplates	This interface represants the subroot for linktemplates in templatestore.
interface	MasterTemplate	Mastertemplates are used to create nodes in pagestore (pages, sections, content sections)
interface	PageTemplate	Interface providing means to operate on page templates.
interface	PageTemplates	This interface provides methods to handle templates of type section in the TemplateStore
interface	PreviewImageProvider	Interface providing means to access and change elements preview image.
interface	Query	Definition of a query description container.
interface	Schema	Definition of a database schema description.
interface	SchemaContainer	Interface providing methods for elements which can have schemas as children.
interface	SchemaFolder	Definition of a container having schema entries.
interface	Schemes	This interface represants the subroot for schemas in templatestore.
interface	Script	This interface provides methods to handle the scripts in the TemplateStore
interface	ScriptContainer	Interface providing methods for elements which can have scripts as children.
interface	ScriptFolder	Definition of a container that holds scripts.
interface	Scripts	This interface represants the subroot for scripts in templatestore.
interface	SectionTemplate	Interface providing means to operate on section templates.
interface	SectionTemplates	This interface provides methods to handle templates of type section in the TemplateStore
interface	StyleTemplate	Interface providing means to operate on style templates.
interface	StyleTemplateLink	Definition for defining a link to a style template from a rendering component.
interface	TableFormatTemplate	Interface providing means to operate on table format templates.
interface	TableTemplate	Interface for templates defining GUI for content store.
interface	Template	This interface provides methods to handle templates.
interface	TemplateBody	Definition of a container providing information about a body that is part of a page.
interface	TemplateContainer<T extends Template>	Interface providing methods for elements which can have templates as children.
interface	TemplateContentProvider	Interface for nodes which provide a template document
interface	TemplateExtension	This interface provides methods to handle TemplateExtensions for Page- and Section-Templates
interface	TemplateFolder<T extends Template>	This interface provides methods to handle the TemplateStore-folder like setting the name, creating sub folders, and creating templates.
interface	TemplateProvider<T extends Template>	This interface is implemented by all elements which have a template.
interface	TemplateStoreElement	Interface for nodes which are elements of the TemplateStore and belong to a specific sub root (e.g.
interface	TemplateStoreRoot	This interface provides methods for the TemplateStore root node, i.e. access to the sub root nodes, getting a template by its 'template id' (TemplateStoreRoot.getTemplateById(long), and getting a workflow by its 'workflow id' (TemplateStoreRoot.getWorkflowById(long)).
interface	Workflow	Definition of a workflow element.
interface	WorkflowContainer	Interface providing methods for elements which can have workflows and WorkflowFolder as children.
interface	WorkflowFolder	This interface represents a workflow folder in templatestore.
interface	Workflows	This interface represants the subroot for workflows in templatestore.

Methods in de.espirit.firstspirit.access.store.templatestore that return StoreElement

Modifier and Type	Method	Description
StoreElement	WorkflowScriptContext.getStoreElement()	Deprecated, for removal: This API element is subject to removal in a future version. since 5.1.104, use ClientScriptContext.getElement()

Uses of StoreElement in de.espirit.firstspirit.access.store.templatestore.gom

Methods in de.espirit.firstspirit.access.store.templatestore.gom that return types with arguments of type StoreElement

Modifier and Type	Method	Description
List<Class<? extends StoreElement>>	GomFilterEntry.FilterType.getExcludes()	Excludes act as a blacklist.

Methods in de.espirit.firstspirit.access.store.templatestore.gom with parameters of type StoreElement

Modifier and Type	Method	Description
static boolean	GomFilterEntry.FilterType.WildCardFilterTypesRegistry.isAssignableFromWildCardList(StoreElement element, Class<?> elementType)	Indicates if the given class is assignable from a wildcard list

Method parameters in de.espirit.firstspirit.access.store.templatestore.gom with type arguments of type StoreElement

Modifier and Type	Method	Description
boolean	GomFilterEntry.FilterType.isBlacklisted(Class<? extends StoreElement> element)	Indicates if the given element is blacklisted

Uses of StoreElement in de.espirit.firstspirit.store.operations

Methods in de.espirit.firstspirit.store.operations with parameters of type StoreElement

Modifier and Type	Method	Description
void	SaveOperation.perform(@NotNull StoreElement element)	Performs this operation on the given element.

Uses of StoreElement in de.espirit.firstspirit.workflow

Methods in de.espirit.firstspirit.workflow with parameters of type StoreElement

Modifier and Type	Method	Description
boolean	WorkflowAgent.isTransitionAllowed(@NotNull Task task, @NotNull StoreElement element, @NotNull Transition transition, @NotNull User user)	Returns whether or not a Transition is allowed for a given Task performed by a User on a StoreElement