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

Packages that use IDProvider

Package	Description
de.espirit.firstspirit.access
de.espirit.firstspirit.access.admin
de.espirit.firstspirit.access.editor
de.espirit.firstspirit.access.editor.value
de.espirit.firstspirit.access.packagepool
de.espirit.firstspirit.access.schedule
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.agency
de.espirit.firstspirit.client.plugin.dataaccess.aspects
de.espirit.firstspirit.event
de.espirit.firstspirit.service.treedata
de.espirit.firstspirit.store.operations

Uses of IDProvider in de.espirit.firstspirit.access

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

Modifier and Type	Method	Description
IDProvider	ClientScriptContext.getElement()	The element this context is operating on.
@Nullable IDProvider	WorkflowContext.getElement()	Returns the element or null for tasks with no context element.
@Nullable IDProvider	GenerationContext.getNavigationContext()	Returns the origin node for relative urls.
@Nullable IDProvider	ReferenceEntry.getReferencedElement()	The referenced node.

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

Modifier and Type	Method	Description
static ServerActionHandle<? extends DeleteProgress,Boolean>	AccessUtil.delete(IDProvider element, boolean ignoreIncomingReferences)	Deprecated. use DeleteOperation instead ; since 5.2.1804
default @NotNull Optional<UrlCreatorProvider>	UrlCreatorProvider.getUrlCreatorProvider(@NotNull IDProvider node)	Provides a UrlCreatorProvider for the remote configuration associated with the given IDProvider.
static ServerActionHandle<? extends ReleaseProgress,Boolean>	AccessUtil.release(IDProvider toRelease, boolean checkOnly)	Deprecated. use ReleaseOperation instead ; since 5.2.180606
static ServerActionHandle<? extends ReleaseProgress,Boolean>	AccessUtil.release(IDProvider releaseStartNode, boolean checkOnly, boolean ensureAccessibility, boolean recursive, IDProvider.DependentReleaseType dependentType)	Deprecated. use ReleaseOperation instead ; since 5.2.180606
static ServerActionHandle<? extends ReleaseProgress,Boolean>	AccessUtil.release(IDProvider releaseStartNode, boolean checkOnly, boolean ensureAccessibility, boolean recursive, IDProvider.DependentReleaseType dependentType, String comment)	Deprecated. use ReleaseOperation instead ; since 5.2.180606
static ServerActionHandle<? extends ReleaseProgress,Boolean>	AccessUtil.release(IDProvider toRelease, boolean checkOnly, String comment)	Deprecated. use ReleaseOperation instead ; since 5.2.180606
static ServerActionHandle<? extends RestoreProgress,Boolean>	AccessUtil.restore(@NotNull IDProvider newParent, @NotNull ElementInfo elementInfo, boolean restoreParentIfNecessary, boolean ignoreMissingReferencedObjects, boolean checkOnlyMode)	Starts a restore action on the server, which restores the deleted element specified by the given elementInfo
static ServerActionHandle<? extends RevertProgress,Boolean>	AccessUtil.revert(IDProvider element, Revision revision, boolean recursive, EnumSet<IDProvider.RevertType> ignoreRevertTypes, boolean ignoreMissingReferencedObjects, boolean checkOnlyMode)	Reverts an element of type IDProvider to a specific revision.

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

Modifier and Type	Method	Description
static ServerActionHandle<? extends DeleteProgress,Boolean>	AccessUtil.delete(Collection<IDProvider> elements, boolean ignoreIncomingReferences)	Deprecated. use DeleteOperation instead ; since 5.2.1804

Uses of IDProvider in de.espirit.firstspirit.access.admin

Methods in de.espirit.firstspirit.access.admin with parameters of type IDProvider

Modifier and Type	Method	Description
void	ProjectStorage.rebuildSearchIndex(IDProvider element)	Refreshes the search index for the given element.

Uses of IDProvider in de.espirit.firstspirit.access.editor

Methods in de.espirit.firstspirit.access.editor with parameters of type IDProvider

Modifier and Type	Method	Description
@NotNull Collection<Activity>	PermissionsAgent.getActivities(IDProvider element)	Provides activities for the given element containing permissions as defined in the meta data field of the fieldname configured in the project.
@NotNull Collection<Activity>	PermissionsAgent.getActivities(IDProvider element, String fieldname)	Provides activities for the given element containing permissions as defined in the meta data field of the given fieldname.

Uses of IDProvider in de.espirit.firstspirit.access.editor.value

Methods in de.espirit.firstspirit.access.editor.value that return IDProvider

Modifier and Type	Method	Description
@Nullable IDProvider	TargetReference.get()	Get the reference of the element currently set in this TargetReference.

Methods in de.espirit.firstspirit.access.editor.value with parameters of type IDProvider

Modifier and Type	Method	Description
static BinaryMedium.Type	BinaryMedium.Type.fromElement(IDProvider element)	Gets the binary medium type for the specified element.
static String	BinaryMedium.Type.getNameFor(IDProvider element)	Get the name of the binary medium for the specified element.
abstract boolean	BinaryMedium.Type.isTypeOf(IDProvider element)	Checks if medium is instance of given element.
String	BinaryMedium.Type.nameFor(IDProvider element)	Returns the name for the given element combined with the prefix.
static TargetReference	TargetReference.TargetReferences.newInstance(@Nullable Language language, IDProvider reference, @Nullable String remoteName)	Create a new TargetReference.
void	TargetReference.resetTo(IDProvider reference, @Nullable String remote)	Reset the reference and the remote information and infer settings for UID and UidType.
void	TargetReference.set(IDProvider reference)	Set a new element reference of type IDProvider and infer settings for UID and UidType.

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

Methods in de.espirit.firstspirit.access.packagepool that return IDProvider

Modifier and Type	Method	Description
IDProvider	ImportInfo.getConflictNode(int index)	Returns the conflicted node at the specified index. Call ImportInfo.setUserService(de.espirit.firstspirit.access.UserService) with your local userservice before calling this method.
IDProvider	ImportInfo.getNewNode(int index)	Returns the added node at the specified index. Call ImportInfo.setUserService(de.espirit.firstspirit.access.UserService) with your local userservice before calling this method.
IDProvider	ImportInfo.getRemovedNode(int index)	Returns the removed node at the specified index. Call ImportInfo.setUserService(de.espirit.firstspirit.access.UserService) with your local userservice before calling this method.
IDProvider	ImportInfo.getUpdatedNode(int index)	Returns the updated node at the specified index. Call ImportInfo.setUserService(de.espirit.firstspirit.access.UserService) with your local userservice before calling this method.

Methods in de.espirit.firstspirit.access.packagepool that return types with arguments of type IDProvider

Modifier and Type	Method	Description
Collection<IDProvider>	Subscription.getExclusionNodeList()	Returns a read-only list of StoreElement's which are excluded from the list of startnodes in the belonging Package of this subscription.
Collection<IDProvider>	Package.getStartNodes()	Returns a read-only List of StoreElement's of start nodes existing in this package.
Collection<IDProvider>	Package.getStartNodes(Store.Type storeType)	Returns a read-only List of StoreElement's of start nodes existing in this package from the given Store type.

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

Modifier and Type	Method	Description
void	Package.addStartNode(IDProvider storeElement)	Deprecated. since 5.2.305 - use PackagePoolItem.addToPackage(Package)
boolean	Package.containsStartNode(IDProvider node)	Checks if the given start node is existing in the underlying start node list of this package.
void	Subscription.excludeNode(IDProvider storeElement)	Excludes the given storeelement from the list of nodes which will be imported from the package.
void	Subscription.includeNode(IDProvider storeElement)	Includes the given storeelement to the list of nodes which will be imported from the package.
void	Package.removeStartNode(IDProvider storeElement)	Deprecated. since 5.2.305 - use PackagePoolItem.removeFromPackage(Package)

Uses of IDProvider in de.espirit.firstspirit.access.schedule

Methods in de.espirit.firstspirit.access.schedule that return IDProvider

Modifier and Type	Method	Description
@Nullable IDProvider	WebServerConfiguration.getStartNode()	Deprecated. since 5.0 - no replacement

Methods in de.espirit.firstspirit.access.schedule that return types with arguments of type IDProvider

Modifier and Type	Method	Description
@NotNull List<IDProvider>	GenerateTask.getStartNodes()	Returns a modifyable list of start nodes for a partial generate.

Methods in de.espirit.firstspirit.access.schedule with parameters of type IDProvider

Modifier and Type	Method	Description
void	WebServerConfiguration.setStartNode(@Nullable IDProvider value)	Deprecated. since 5.0 - no replacement

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

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

Modifier and Type	Interface	Description
interface	ContentProducer
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.The builder can be used to create preview urls for elements of type Page, PageRef or DocumentGroup.
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 that return IDProvider

Modifier and Type	Method	Description
@Nullable IDProvider	IDProvider.getInRevision(@NotNull Revision revision)	Get this element in the state of the given revision.
@Nullable IDProvider	IDProvider.getParent()	Return parent IDProvider which is null for deleted elements or store-roots.
@Nullable IDProvider	Store.getStoreElement(long id)
@Nullable IDProvider	Store.getStoreElement(@NotNull String uid, @NotNull IDProvider.UidType uidType)	Get an element of this store by it's unique identifier and unique type or null if no child exists with the given parameter. Keep in mind, that some IDProvider doesn't support uids (e.g.
@Nullable IDProvider	Store.getStoreElement(@NotNull String attributeName, @NotNull String attributeValue)	Get a child of this store by the value of a attribute or null if no child exists with the given parameter
@Nullable IDProvider	Store.getStoreElement(Long id)	Get a child by it's node id.

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

Modifier and Type	Method	Description
List<? extends IDProvider>	Store.getElements(Collection<Long> ids)	Get a list of IDProvider identified by given ids. Attention: List could contain null entries for ids no element could be found for (e.g. deleted).

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

Modifier and Type	Method	Description
@NotNull Set<de.espirit.firstspirit.storage.Contrast>	IDProvider.contrastWith(IDProvider reference)	Contrast the element with another one.
void	IDProvider.moveChild(IDProvider child)	Insert child at last position.
void	IDProvider.moveChild(IDProvider child, int nextSiblingIndex)	Insert child at index position.
StoreElement	Store.restore(ElementInfo elementInfo, @Nullable IDProvider parent)	Restore the element defined by the given information.

Constructors in de.espirit.firstspirit.access.store with parameters of type IDProvider

Modifier	Constructor	Description
	ElementDeletedException(IDProvider idProvider)

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

Subinterfaces of IDProvider 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 IDProvider in de.espirit.firstspirit.access.store.globalstore

Subinterfaces of IDProvider 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 IDProvider

Modifier and Type	Method	Description
int	URLProperties.resetStoredUrls(@NotNull IDProvider node)	Reset the stored URLs for the specified node.

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

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

Modifier and Type	Interface	Description
interface	Media	This interface provides methods to handle a media object from the MediaStore.
interface	MediaFolder	This interface provides methods to handle the MediaStore-folder
interface	MediaStoreRoot	This interface provides methods to handle the MediaStore-Root

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

Subinterfaces of IDProvider 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 IDProvider in de.espirit.firstspirit.access.store.sitestore

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

Modifier and Type	Interface	Description
interface	DocumentGroup	A DocumentGroup groups DocumentGroupLink's as their child nodes (see StoreElement.getChildren()).
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 that return IDProvider

Modifier and Type	Method	Description
IDProvider	DocLink.getTarget(boolean release)	Gets the target referenced by this element link.
IDProvider	DocLink.getTarget(Store store)	Provides the target element.

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

Modifier and Type	Method	Description
DocLink	DocumentGroup.addLink(IDProvider target)	Adds a link to the given target element.
@NotNull PageRefFolder	SiteStoreFolder.createPageRefFolder(String uid, Map<Language,String> lang2DisplayName, boolean unifyNameOnServer, IDProvider nextSibling)	Create a new PageRefFolder as child of this folder and place it before the given next sibling.

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

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

Modifier and Type	Interface	Description
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	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	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	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	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 IDProvider

Modifier and Type	Method	Description
IDProvider	TemplateStoreElement.getSubRootInStore(UserService us, boolean release)	Provides the owning sub root wrt. the given store context information.

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

Methods in de.espirit.firstspirit.access.store.templatestore.gom that return IDProvider

Modifier and Type	Method	Description
@Nullable IDProvider	GomCheckable.Context.getElement()	Provides the operational store element for this context.

Uses of IDProvider in de.espirit.firstspirit.agency

Methods in de.espirit.firstspirit.agency that return IDProvider

Modifier and Type	Method	Description
@Nullable IDProvider	SnippetContext.getContextualElement()	Provide a FirstSpirit element to retrieve further information for snippet building.
@NotNull IDProvider	ElementValidationReport.getElement()	Deprecated. since 5.0.311, use ElementValidationReport.getElement(SpecialistsBroker) instead.
@NotNull IDProvider	ElementValidationReport.getElement(SpecialistsBroker broker)	Get the element this report is generated for.

Methods in de.espirit.firstspirit.agency with parameters of type IDProvider

Modifier and Type	Method	Description
@NotNull SnippetProvider	SnippetAgent.getSnippetProvider(@NotNull IDProvider element)	Hands out a snippet provider for the given element or null, if no snippet provider is available.
@NotNull SnippetProvider	SnippetAgent.getSnippetProvider(@NotNull IDProvider element, @NotNull SnippetAgent.Fallback fallback)	Hands out a snippet provider for the given element applying the given fallback strategy.
@Nullable Image<?>	SnippetAgent.getTypeIcon(@NotNull IDProvider element)	Provides a type image resource for the given element.
void	SnippetContext.setElement(@Nullable IDProvider element)	Sets the element to be used as context information source for snippet building.

Uses of IDProvider in de.espirit.firstspirit.client.plugin.dataaccess.aspects

Methods in de.espirit.firstspirit.client.plugin.dataaccess.aspects with parameters of type IDProvider

Modifier and Type	Method	Description
void	ModelReferencesJournal.addModelElement(@NotNull IDProvider element)	Adds the given FirstSpirit element as model reference to this journal.
void	ValueReferencesJournal.addReferenceToElement(@NotNull IDProvider element)	Adds a reference to a FirstSpirit element to this journal.

Uses of IDProvider in de.espirit.firstspirit.event

Methods in de.espirit.firstspirit.event that return IDProvider

Modifier and Type	Method	Description
@NotNull IDProvider	IDProviderChange.getElement()	Get the element the of this change operation.

Uses of IDProvider in de.espirit.firstspirit.service.treedata

Methods in de.espirit.firstspirit.service.treedata with parameters of type IDProvider

Modifier and Type	Method	Description
R	TNodeProvider.createRequest(@NotNull IDProvider element, @Nullable Map<String,String> properties)	Creates a request object.

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

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

Modifier and Type	Method	Description
@NotNull ReleaseOperation.ReleaseResult	ReleaseOperation.perform(@NotNull IDProvider... elements)	Performs the operation and releases the given elements on the server.

Method parameters in de.espirit.firstspirit.store.operations with type arguments of type IDProvider

Modifier and Type	Method	Description
@NotNull ReleaseOperation.ReleaseResult	ReleaseOperation.perform(@NotNull Collection<IDProvider> elements)	Performs the operation and releases the given Collection of elements on the server.