Package de.espirit.firstspirit.access.store.sitestore

Interface DocLink

All Superinterfaces:

Comparable<StoreElement>, StoreElement, Workflowable

public interface DocLink
extends StoreElement

This interface represents a document link.

Since:

4.0

Method Summary

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

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.espirit.firstspirit.access.store.StoreElement

appendChild, appendChildBefore, delete, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getName, getNextSibling, getOutgoingReferences, getParent, getPermission, getPermission, getPermission, getPreviousSibling, getProject, getReferenceName, getReferences, getReferences, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasPermissions, importStoreElement, importStoreElements, inheritWorkflowPermission, isDeleted, isExportSupported, isFolder, isImportSupported, isLocked, isLockedOnServer, isLockSupported, isPermissionSupported, isWorkflowAllowed, isWorkflowSupported, refresh, removeAllWorkflowPermissions, removeChild, removePermission, removePermission, removePermission, removeWorkflowPermission, replaceChild, save, save, save, setInheritWorkflowPermission, setLock, setLock, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml

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

getColor, getTask, hasTask, removeTask, setColor, setTask

Method Details

getTargetId

long getTargetId()

Returns the ID of the IDProvider referenced by this DocLink

Since:

4.0

getTarget

IDProvider getTarget(Store store)

Provides the target element. Gives null, if the target is not (or no longer) in the specified store.

Parameters:

store - The store.

Returns:

The linked IDProvider-node or null.

Since:

4.0

getTarget

IDProvider getTarget(boolean release)
              throws IOException

Gets the target referenced by this element link. Returns null if release = true and target is not in release store.

Parameters:

release - specifies if the target is returned from release or current store

Returns:

the linked IDProvider-node or null if the target is not (or no longer) in the specified store.

Throws:

IOException

Since:

4.0