StoreElement (FirstSpirit Access-API)

All Superinterfaces:

Comparable<StoreElement>, Workflowable

All Known Subinterfaces:

Allowed, Body, ChannelSourceProvider, Content2, Content2Params, Content2Section, ContentFolder, ContentProducer, ContentStoreRoot, DataProvider, Dataset, DocLink, DocumentGroup, File, FolderLangSpec, FormatTemplate, FormatTemplateChannel, FormatTemplateContainer, FormatTemplateFolder, FormatTemplates, GCABody, GCAFolder, GCAPage, GCASection, GlobalContentArea, GlobalStoreRoot, GomSourceProvider, IDProvider, LanguageInfo, LinkTemplate, LinkTemplateFolder, LinkTemplates, MasterTemplate, Media, MediaElement, MediaFolder, MediaStoreRoot, PackagePoolItem, Page, PageFolder, PageGroup, PageLangSpec, PageRef, PageRefFolder, PageStoreRoot, PageTemplate, PageTemplates, Picture, PictureResolution, Previewable, PreviewImageProvider, ProjectProperties, Query, Referenceable, Schema, SchemaContainer, SchemaFolder, Schemes, Script, ScriptContainer, ScriptFolder, Scripts, Section<T>, SectionReference<T>, SectionTemplate, SectionTemplates, SiteStoreFolder, SiteStoreRoot, StartNode, Store, StyleTemplate, StyleTemplateLink, TableFormatTemplate, TableTemplate, Template, TemplateBody, TemplateContainer<T>, TemplateContentProvider, TemplateExtension, TemplateFolder<T>, TemplateProvider<T>, TemplateStoreElement, TemplateStoreRoot, URLProperties, UserProperties, Workflow, WorkflowContainer, WorkflowFolder, Workflows
```
public interface StoreElement
extends Workflowable, Comparable<StoreElement>
```
Since:

2.3

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`appendChild(StoreElement child)` Deprecated. since 4.2.204 - use `IDProvider#moveChild(child)`
`void`	`appendChildBefore(StoreElement child, StoreElement nextsibling)` Deprecated. since 4.2.204 - use `IDProvider#moveChild(child, nextsibling)`
`void`	`delete()` Deletes this storeelement.
`void`	`exportStoreElement(OutputStream out, ExportHandler exportHandler)` Exports this storeelement as zip file to the given outputstream.
`int`	`getChildCount()`
`int`	`getChildIndex(StoreElement child)`
`Listable<StoreElement>`	`getChildren()` Get the element's direct children.
`<T extends StoreElement> Listable<T>`	`getChildren(Class<T> type)` Get the element's direct children that are instances of the given type.
`<T extends StoreElement> Listable<T>`	`getChildren(Class<T> type, boolean recurse)` Get the element's children that are instances of the given type.
`<T extends StoreElement> Listable<T>`	`getChildren(Filter.TypedFilter<T> filter, boolean recurse)` Get the element's children passing the given typed filter.
`WorkflowPermission`	`getCreateWorkflowPermission(Workflow workflow)` Return workflow permission object for the given workflow.
`List<Principal>`	`getDefinedPrincipalPermissions()` Returns a list of `Principal's` for which permissions are defined at this storeelement.
`User`	`getEditor()`
`String`	`getElementType()`
`StoreElement`	`getFirstChild()`
`ReferenceEntry[]`	`getIncomingReferences()` Returns all incoming references of this `StoreElement`.
`List<Principal>`	`getInheritedPrincipalPermissions()` Returns a list of `Principal's` for which permissions are defined at this storelement including the inherited permissions on parent path.
`long`	`getLastChanged()`
`String`	`getName()`
`StoreElement`	`getNextSibling()`
`ReferenceEntry[]`	`getOutgoingReferences()` Returns all outgoing references of this `StoreElement`.
`StoreElement`	`getParent()` Return parent `StoreElement` which is `null` for `deleted` elements or `store-roots`.
`Permission`	`getPermission()` Returns the permission object for the `current user` even if permission checking is turned off.
`Permission`	`getPermission(Group group)` Returns the correct permission object even if permission checking is turned off.
`Permission`	`getPermission(User user)` Returns the correct permission object even if permission checking is turned off.
`Project`	`getProject()` Returns the belonging project of this storeelement.
`String`	`getReferenceName()`
`Set<ReferenceEntry>`	`getReferences()` Returns current outgoing references of this store element.
`Store`	`getStore()`
`de.espirit.firstspirit.store.access.PermissionMap`	`getTreePermission()` Return permissions combined from defined and inherited permissions for current user.
`WorkflowPermission`	`getWorkflowPermission(Workflow workflow)` Return workflow permission object for the given workflow.
`WorkflowPermission[]`	`getWorkflowPermissions()` Return all existing workflow permissions.
`boolean`	`getWriteLock()` A write lock is a flag to prevent changes e.g. during a workflow is active for this element.
`boolean`	`hasIncomingReferences()` Returns `true` if this `StoreElement` has incoming references.
`boolean`	`hasPermissions()` Indicates whether for this element permissions are defined or not.
`StoreElement`	`importStoreElement(ZipFile exportFile, ImportHandler importHandler)` Imports the first root node from the given zip exportfile.
`Listable<StoreElement>`	`importStoreElements(ZipFile exportFile, ImportHandler importHandler)` Imports all root nodes from the given zip exportfile.
`boolean`	`inheritWorkflowPermission()` Returns a `boolean` state, whether the workflow permissions should be inherited for this `StoreElement` or not.
`boolean`	`isDeleted()` Returns the state of deletion. true if element is deleted and false if its not
`boolean`	`isExportSupported()`
`boolean`	`isFolder()`
`boolean`	`isImportSupported()`
`boolean`	`isLocked()` Checks if this node is locked by this session.
`boolean`	`isLockedOnServer(boolean allSessions)` Checks if this storeelement is locked on the server.
`boolean`	`isLockSupported()`
`boolean`	`isPermissionSupported()` Indicates whether this element supports permissions or not.
`boolean`	`isWorkflowAllowed(Workflow workflow, User user)` Returns `true` if `workflow` is not `null` and is explicitly allowed to be started on this element by given `user` or `workflow` is `null` and any workflow is allowed to be started on this element by given `user`.
`boolean`	`isWorkflowSupported()`
`void`	`refresh()` Refreshs this storeelement against the actual server version
`void`	`removeAllWorkflowPermissions()`
`void`	`removeChild(StoreElement child)` Removes the given child from this element.
`void`	`removePermission(Group group)`
`void`	`removePermission(User user)`
`void`	`removePermission(User[] users)`
`void`	`removeWorkflowPermission(Workflow workflow)`
`void`	`replaceChild(StoreElement oldChild, StoreElement newChild)`
`void`	`save()` Saves the node and all childs, shortcut for `save(null, true)`.
`void`	`save(String comment)` Saves the node and all childs.
`void`	`save(String comment, boolean saveChilds)` Saves this node.
`void`	`setInheritWorkflowPermission(boolean inherit)` Sets a `boolean` flag to enable or disable the inheritance of workflow permissions for this `StoreElement`.
`void`	`setLock(boolean lock)` Lock or unlock this store element and all childs.
`void`	`setLock(boolean lock, boolean recursive)` Lock or unlock this store element, if `recursive == true` all children are also locked or unlocked.
`void`	`setPermission(Group group, Permission permission)`
`void`	`setPermission(User[] users, Permission permission)`
`void`	`setPermission(User user, Permission permission)`
`void`	`setWorkflowPermission(WorkflowPermission permission)`
`void`	`setWorkflowPermissions(WorkflowPermission[] permissions)`
`void`	`setWriteLock(boolean lock)` A write lock is a flag to prevent changes e.g. during a workflow is active for this element.
`String`	`toXml()`
`String`	`toXml(boolean includeChilds)`
`String`	`toXml(boolean includeChildren, boolean prettyPrinting)`
`void`	`update(ZipFile exportFile, ImportHandler importHandler)` Deprecated. since 4.2.406 - no replacement, always throws UnsupportedOperationException

Methods inherited from interface de.espirit.firstspirit.access.Workflowable
getColor, getTask, hasTask, removeTask, setColor, setTask

Methods inherited from interface java.lang.Comparable
compareTo

- Method Detail
  - getName
```
@NotNull
String getName()
```
    Since:
    
    2.3.11
  - getChildren
```
Listable<StoreElement> getChildren()
```
    Get the element's direct children.
    
    Returns:
    A listable on this element's direct children.
    Since:
    
    4.0
  - getChildren
```
<T extends StoreElement> Listable<T> getChildren(@NotNull
                                               Class<T> type)
```
    Get the element's direct children that are instances of the given type.
    
    Parameters:
    type - The type to find instances of.
    
    Returns:
    A listable on matching children.
    Since:
    
    4.0
  - getChildren
```
<T extends StoreElement> Listable<T> getChildren(@NotNull
                                               Class<T> type,
                                               boolean recurse)
```
    Get the element's children that are instances of the given type.
    
    Parameters:
    type - The type to find instances of.
    recurse - If true, recursively collects children.
    
    Returns:
    A listable on matching children.
    Since:
    
    4.0
  - getChildren
```
<T extends StoreElement> Listable<T> getChildren(@NotNull
                                               Filter.TypedFilter<T> filter,
                                               boolean recurse)
```
    Get the element's children passing the given typed filter.
    
    Parameters:
    filter - The filter to be used.
    recurse - If true, recursively collects children.
    
    Returns:
    A listable on matching children.
    Since:
    
    4.0
    
    Example:
    Usage example with a StoreElementFilter.
  - appendChild
```
@Deprecated
void appendChild(StoreElement child)
```
    Deprecated. since 4.2.204 - use IDProvider#moveChild(child)
    
    Calls appendChildBefore(child, null).
    
    Throws:
    
    IllegalArgumentException - if child is not a child node fo this node.
    Since:
    
    3.0
    
    See Also:
    appendChildBefore(StoreElement, StoreElement)
  - appendChildBefore
```
@Deprecated
void appendChildBefore(@NotNull
                                StoreElement child,
                                @Nullable
                                StoreElement nextsibling)
```
    Deprecated. since 4.2.204 - use IDProvider#moveChild(child, nextsibling)
    Appends the given child to the children list before the given nextsibling element.
    If you want to append a child from a different parent, use moveChild(child) or moveChild(child, nextSiblingIndex)
    Attention: It's necessary to lock and save all parts of the operation (parent and child)
    You need permission can change and can append leaf (if given child is a leaf node) or can append folder (if given child is a folder)
    
    Example 1 (position ordering - same parent):
```
 parent.setLock(true, false); // non recursive lock
 move.setLock(true, false);   // non recursive lock -> avoid concurrent change
 try {
         parent.removeChild(moveNode);
         parent.appendChildBefore(moveNode, nextSibling);  // append 'moveNode' before 'nextSibling'
         parent.save("position changed", false);           // non recursive save
         // it's not necessary to save 'moveNode' because parent hasn't changed
 } finally {
         move.setLock(false, false);   // non recursive unlock
         parent.setLock(false, false); // non recursive unlock
 }
 
```
    Parameters:
    child - the child to append to the children list of this element
    nextsibling - the child will be appended before the nextsibling node
    
    Throws:
    
    IllegalArgumentException - if child is not a child node fo this node.
    Since:
    
    3.0.3
    
    See Also:
    removeChild(StoreElement), IDProvider.moveChild(IDProvider), IDProvider.moveChild(IDProvider, int)
  - removeChild
```
void removeChild(StoreElement child)
```
    Removes the given child from this element. If the given element isn't in the children list of this element, nothing will happen.
    If you want to move a child to a different parent, is recommended to use moveChild(child) or moveChild(child, nextSiblingIndex)
    Attention: It's necessary to lock and save all parts of the operation (parent and child)
    You need permission can change and can delete (if given child is a leaf node) or can delete folder (if given child is a folder)
    
    Example 1 (position ordering - same parent):
```
 parent.setLock(true, false);                       // non recursive lock
 move.setLock(true, false);                         // non recursive lock -> avoid concurrent change
 try {
        parent.removeChild(moveNode);
        parent.appendChildBefore(moveNode, nextSibling);  // append 'moveNode' before 'nextSibling'
        parent.save("position changed", false);           // non recursive save
        // it's not necessary to save 'moveNode' because parent hasn't changed
 } finally {
        move.setLock(false, false);                       // non recursive unlock
        parent.setLock(false, false);                     // non recursive unlock
 }
 
```
    Example 2 (move to another folder -> it's recommended to use move(child) instead):
```
 parent.setLock(true, false);                 // non recursive lock
 move.setLock(true, false);                   // non recursive lock
 newParent.setLock(true, false);              // non recursive lock
 try {
        parent.removeChild(moveNode);
        newParent.appendChild(moveNode);            // move 'moveNode' to 'newparent'
        parent.save("removed", false);              // non recursive save
        newParent.save("moveNode added", false);    // non recursive save
        moveNode.save("parent changed", false);     // non recursive save
 } finally {
        parent.setLock(false, false);               // non recursive unlock
        move.setLock(false, false);                 // non recursive unlock
        newParent.setLock(false, false);            // non recursive unlock
 }
 
```
    Parameters:
    child - the child to remove
    Since:
    
    3.0.7
    
    See Also:
    appendChild(StoreElement), appendChildBefore(StoreElement, StoreElement), IDProvider.moveChild(IDProvider), IDProvider.moveChild(IDProvider, int)
  - replaceChild
```
void replaceChild(StoreElement oldChild,
                StoreElement newChild)
```
    Since:
    
    3.0.7
  - getChildCount
```
int getChildCount()
```
    Since:
    
    3.0.115
  - getChildIndex
```
int getChildIndex(StoreElement child)
```
    Since:
    
    3.0.115
  - getParent
```
@Nullable
StoreElement getParent()
```
    Return parent StoreElement which is null for deleted elements or store-roots.
    
    Returns:
    parent StoreElement which is null for deleted elements or store-roots.
    Since:
    
    2.3
  - getNextSibling
```
@Nullable
StoreElement getNextSibling()
```
    Returns:
    the next sibling store element or null if there is none
    Since:
    
    4.0.17
  - getFirstChild
```
@Nullable
StoreElement getFirstChild()
```
    Returns:
    the first child node or null if there are no childs
    Since:
    
    4.0.17
  - getStore
```
@NotNull
Store getStore()
```
    Since:
    
    2.3
  - isFolder
```
boolean isFolder()
```
    Since:
    
    3.0
  - isPermissionSupported
```
boolean isPermissionSupported()
```
    Indicates whether this element supports permissions or not.
    
    Returns:
    true if this element supports permissions, false otherwise
    Since:
    
    2.3
  - hasPermissions
```
boolean hasPermissions()
```
    Indicates whether for this element permissions are defined or not.
    
    Returns:
    true if this element has defined permissions, false otherwise
    Since:
    
    4.0.17
  - getPermission
```
Permission getPermission()
```
    Returns the permission object for the current user even if permission checking is turned off.
    
    Since:
    
    2.3
  - getPermission
```
Permission getPermission(User user)
```
    Returns the correct permission object even if permission checking is turned off.
    
    Since:
    
    2.3
  - getPermission
```
Permission getPermission(Group group)
```
    Returns the correct permission object even if permission checking is turned off.
    
    Since:
    
    2.3
  - setPermission
```
void setPermission(User user,
                 Permission permission)
```
    Since:
    
    2.3
  - setPermission
```
void setPermission(User[] users,
                 Permission permission)
```
    Since:
    
    2.3
  - setPermission
```
void setPermission(Group group,
                 Permission permission)
```
    Since:
    
    2.3
  - removePermission
```
void removePermission(User user)
```
    Since:
    
    2.3
  - removePermission
```
void removePermission(User[] users)
```
    Since:
    
    2.3
  - removePermission
```
void removePermission(Group group)
```
    Since:
    
    2.3
  - getTreePermission
```
de.espirit.firstspirit.store.access.PermissionMap getTreePermission()
```
    Return permissions combined from defined and inherited permissions for current user.
    
    Returns:
    the permission object
    Since:
    
    3.0.59
  - getDefinedPrincipalPermissions
```
@NotNull
List<Principal> getDefinedPrincipalPermissions()
```
    Returns a list of Principal's for which permissions are defined at this storeelement.
    
    Returns:
    list of Principal's
    Since:
    
    3.1.187
  - getInheritedPrincipalPermissions
```
@NotNull
List<Principal> getInheritedPrincipalPermissions()
```
    Returns a list of Principal's for which permissions are defined at this storelement including the inherited permissions on parent path.
    
    Returns:
    list of Principal's
    Since:
    
    3.1.187
  - getLastChanged
```
long getLastChanged()
```
    Since:
    
    2.3
  - getEditor
```
@Nullable
User getEditor()
```
    Since:
    
    2.3
  - isWorkflowSupported
```
boolean isWorkflowSupported()
```
    Since:
    
    3.0.1
  - getWorkflowPermissions
```
WorkflowPermission[] getWorkflowPermissions()
```
    Return all existing workflow permissions.
    
    Since:
    
    3.0.1
  - getWorkflowPermission
```
WorkflowPermission getWorkflowPermission(Workflow workflow)
```
    Return workflow permission object for the given workflow. Use null as parameter for all workflows. If no permissions exist null is returned.
    
    Since:
    
    3.0.1
  - getCreateWorkflowPermission
```
WorkflowPermission getCreateWorkflowPermission(Workflow workflow)
```
    Return workflow permission object for the given workflow. Use null as parameter for all workflows. If no permissions exist a new empty permission object is created. You have to call setWorkflowPermission abterwards to save your changes.
    
    Since:
    
    4.0.120
  - setWorkflowPermission
```
void setWorkflowPermission(WorkflowPermission permission)
```
    Since:
    
    3.0.1
  - setWorkflowPermissions
```
void setWorkflowPermissions(WorkflowPermission[] permissions)
```
    Since:
    
    3.0.1
  - removeWorkflowPermission
```
void removeWorkflowPermission(Workflow workflow)
```
    Since:
    
    3.0.1
  - removeAllWorkflowPermissions
```
void removeAllWorkflowPermissions()
```
    Since:
    
    3.0.1
  - isWorkflowAllowed
```
boolean isWorkflowAllowed(@Nullable
                        Workflow workflow,
                        User user)
```
    Returns true if
    - workflow is not null and is explicitly allowed to be started on this element by given user or
    - workflow is null and any workflow is allowed to be started on this element by given user.
    , false otherwise.
    Since:
    
    3.0.1
  - inheritWorkflowPermission
```
boolean inheritWorkflowPermission()
```
    Returns a boolean state, whether the workflow permissions should be inherited for this StoreElement or not.
    If true the WorkflowPermissions of parent StoreElement used, false otherwise.
    
    Note:
    Store has no parent and return always false
    
    Returns:
    true for workflow permission inheritance, false otherwise.
    Since:
    
    3.0.1
  - setInheritWorkflowPermission
```
void setInheritWorkflowPermission(boolean inherit)
```
    Sets a boolean flag to enable or disable the inheritance of workflow permissions for this StoreElement.
    If true the WorkflowPermissions of parent StoreElement used, false otherwise.
    
    Note:
    Store has no parent and inheritWorkflowPermission() return always false
    
    Parameters:
    inherit - true for workflow permission inheritance, false otherwise.
    Since:
    
    3.0.1
  - setWriteLock
```
void setWriteLock(boolean lock)
```
    A write lock is a flag to prevent changes e.g. during a workflow is active for this element.
    
    Parameters:
    lock - true to signal changes on this element should be prevented
    Since:
    
    3.0.4
    
    See Also:
    getWriteLock()
  - getWriteLock
```
boolean getWriteLock()
```
    A write lock is a flag to prevent changes e.g. during a workflow is active for this element.
    
    Returns:
    true if the element is locked to prevent changes
    Since:
    
    3.0.4
    
    See Also:
    setWriteLock(boolean)
  - isLockSupported
```
boolean isLockSupported()
```
    Returns:
    true if this node supports locks
    Since:
    
    2.3
    
    See Also:
    setLock(boolean), isLocked(), isLockedOnServer(boolean)
  - setLock
```
void setLock(boolean lock)
             throws LockException,
                    ElementDeletedException
```
    Lock or unlock this store element and all childs. Same as setLock(lock, true).
    
    Throws:
    
    LockException
    
    ElementDeletedException
    Since:
    
    2.3
  - setLock
```
void setLock(boolean lock,
           boolean recursive)
             throws LockException,
                    ElementDeletedException
```
    Lock or unlock this store element, if recursive == true all children are also locked or unlocked.
    
    Throws:
    
    LockException
    
    ElementDeletedException
    Since:
    
    4.0.17
  - isLocked
```
boolean isLocked()
```
    Checks if this node is locked by this session.
    
    Returns:
    true if this node is locked
    
    Throws:
    
    UnsupportedOperationException - if isLockSupported() is false
    Since:
    
    3.1.158
    
    See Also:
    setLock(boolean), isLockSupported(), isLockedOnServer(boolean)
  - isLockedOnServer
```
boolean isLockedOnServer(boolean allSessions)
```
    Checks if this storeelement is locked on the server.
    
    Parameters:
    allSessions - true all sessions are checked, false only current session is checked
    
    Returns:
    true wether this object is locked on the server, false otherwise
    Since:
    
    3.1.158
  - save
```
void save()
```
    Saves the node and all childs, shortcut for save(null, true).
    Use isLockSupported() to check if save operation is supported.
    
    Since:
    
    2.3
    
    See Also:
    save(String)
  - save
```
void save(String comment)
```
    Saves the node and all childs.
    Use isLockSupported() to check if save operation is supported.
    
    Parameters:
    comment - comment for the revision which is created during save
    Since:
    
    4.0
  - save
```
void save(String comment,
        boolean saveChilds)
```
    Saves this node. Use saveChilds == true to save recursive all children
    
    Parameters:
    comment - comment
    saveChilds - true to save recursive all children, otherwise use false
    Since:
    
    4.0
  - delete
```
void delete()
            throws LockException
```
    Deletes this storeelement. This operation needs a lock to this storeelement.
    
    Specified by:
    
    delete in interface Workflowable
    
    Throws:
    
    LockException - if the direct parent is locked in a different session
    Since:
    
    2.3
  - refresh
```
void refresh()
```
    Refreshs this storeelement against the actual server version
    
    Since:
    
    2.3
  - toXml
```
String toXml()
```
    Returns:
    the xml representation the node with all children without indentation and line breaks
    Since:
    
    2.3
  - toXml
```
String toXml(boolean includeChilds)
```
    Parameters:
    includeChilds - if true the xml of id childs is included
    
    Returns:
    the xml representation the node without indentation and line breaks
    Since:
    
    4.0
  - toXml
```
String toXml(boolean includeChildren,
           boolean prettyPrinting)
```
    Parameters:
    includeChildren - if true the xml of id children is included
    prettyPrinting - if true to get the xml strings with line breaks and indentation
    
    Returns:
    the xml representation the node with indentation and line breaks
    Since:
    
    4.0
  - isImportSupported
```
boolean isImportSupported()
```
    Since:
    
    3.0.1
  - isExportSupported
```
boolean isExportSupported()
```
    Since:
    
    3.0.1
  - exportStoreElement
```
void exportStoreElement(OutputStream out,
                      @Nullable
                      ExportHandler exportHandler)
                        throws IOException
```
    Exports this storeelement as zip file to the given outputstream.
    
    Parameters:
    exportHandler - the export events will be reported to this handler (may be null)
    out - the output stream the zip export file will be written to
    
    Throws:
    
    IOException
    Since:
    
    3.0.7
  - importStoreElement
```
StoreElement importStoreElement(ZipFile exportFile,
                              @Nullable
                              ImportHandler importHandler)
                                throws IOException,
                                       ElementDeletedException,
                                       WorkflowLockException
```
    Imports the first root node from the given zip exportfile. The created node is not locked, it is necessary to lock, save and unlock the imported element.
    
    Parameters:
    exportFile - Zip export file to import from.
    importHandler - Import handler, may be null.
    
    Returns:
    First element from exportfile (the node mayhave an arbitrary number of child nodes).
    
    Throws:
    
    IOException - If an io error occurs when handling given zip file.
    
    ElementDeletedException - If this element is already deleted.
    
    WorkflowLockException - If this element is locked in a workflow.
    Since:
    
    3.0.7
  - importStoreElements
```
Listable<StoreElement> importStoreElements(ZipFile exportFile,
                                         @Nullable
                                         ImportHandler importHandler)
                                           throws IOException,
                                                  ElementDeletedException,
                                                  WorkflowLockException
```
    Imports all root nodes from the given zip exportfile. The created nodes are not locked, it is necessary to lock, save and unlock them.
    
    Parameters:
    exportFile - Zip export file to import from.
    importHandler - Import handler, may be null.
    
    Returns:
    List of imported elements (each node may have an arbitrary number of child nodes).
    
    Throws:
    
    IOException - If an io error occurs when handling given zip file.
    
    ElementDeletedException - If this element is already deleted.
    
    WorkflowLockException - If this element is locked in a workflow.
    Since:
    
    4.0.47
  - update
```
@Deprecated
void update(ZipFile exportFile,
                     ImportHandler importHandler)
            throws IOException
```
    Deprecated. since 4.2.406 - no replacement, always throws UnsupportedOperationException
    
    ImportHandler may be null
    
    Throws:
    
    UnsupportedOperationException - deprecated, no implementation. Always throws this exception.
    
    IOException
    Since:
    
    3.1.158
  - getElementType
```
String getElementType()
```
    Since:
    
    3.0.7
  - getProject
```
Project getProject()
```
    Returns the belonging project of this storeelement.
    
    Returns:
    the belonging project
    Since:
    
    4.0
  - getIncomingReferences
```
@NotNull
ReferenceEntry[] getIncomingReferences()
```
    Returns all incoming references of this StoreElement.
    
    Returns:
    all incoming references for this StoreElement.
    Since:
    
    3.1.172
    
    See Also:
    hasIncomingReferences()
  - hasIncomingReferences
```
boolean hasIncomingReferences()
```
    Returns true if this StoreElement has incoming references. This method is more efficient and less time consuming than getIncomingReferences().length > 0.
    
    Returns:
    true if this StoreElement has incoming references.
    Since:
    
    4.0
  - getOutgoingReferences
```
@NotNull
ReferenceEntry[] getOutgoingReferences()
```
    Returns all outgoing references of this StoreElement.
    
    Returns:
    all outgoing references of this StoreElement.
    Since:
    
    3.1.172
  - getReferenceName
```
@Nullable
String getReferenceName()
```
    Returns:
    the refernce text, e.g. used for $CMS_REF(..)$ expressions, or null if this element supports no referencing
    Since:
    
    4.0.17
  - getReferences
```
Set<ReferenceEntry> getReferences()
```
    Returns current outgoing references of this store element.
    
    Returns:
    current outgoing references.
    Since:
    
    4.0.17
  - isDeleted
```
boolean isDeleted()
```
    Returns the state of deletion. true if element is deleted and false if its not
    
    Returns:
    true if element is deleted, false otherwise
    Since:
    
    4.2.9

Interface StoreElement

Method Summary

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

Methods inherited from interface java.lang.Comparable

Method Detail

getName

getChildren

getChildren

getChildren

getChildren

appendChild

appendChildBefore

removeChild

replaceChild

getChildCount

getChildIndex

getParent

getNextSibling

getFirstChild

getStore

isFolder

isPermissionSupported

hasPermissions

getPermission

getPermission

getPermission

setPermission

setPermission

setPermission

removePermission

removePermission

removePermission

getTreePermission

getDefinedPrincipalPermissions

getInheritedPrincipalPermissions

getLastChanged

getEditor

isWorkflowSupported

getWorkflowPermissions

getWorkflowPermission

getCreateWorkflowPermission

setWorkflowPermission

setWorkflowPermissions

removeWorkflowPermission

removeAllWorkflowPermissions

isWorkflowAllowed

inheritWorkflowPermission

setInheritWorkflowPermission

setWriteLock

getWriteLock

isLockSupported

setLock

setLock

isLocked

isLockedOnServer

save

save

save

delete

refresh

toXml

toXml

toXml

isImportSupported

isExportSupported

exportStoreElement

importStoreElement

importStoreElements

update

getElementType

getProject

getIncomingReferences

hasIncomingReferences

getOutgoingReferences

getReferenceName

getReferences

isDeleted