eu.ehri.project.models

Interface VirtualUnit

All Superinterfaces:

AbstractUnit, Accessible, Annotatable, Described, Entity, Identifiable, ItemHolder, Linkable, PermissionGrantTarget, PermissionScope, Versioned, com.tinkerpop.frames.VertexFrame, Watchable

All Known Implementing Classes:

VirtualUnit.Impl

public interface VirtualUnit
extends AbstractUnit

Virtual documentary unit. Note: a *virtual* unit can have its own descriptions which do not refer to *actual* doc units, but are structurally the same. However, the label and direction is different in these cases, with the "purely virtual" descriptions having an outgoing "describes" relationship to the VU, whereas descriptions that describe real doc units have an incoming "isDescribedBy" relationship from a VU. The difference denotes ownership (dependency) which likewise controls cascading deletions.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	VirtualUnit.Impl Implementation of complex methods.

Field Summary

Fields inherited from interface eu.ehri.project.models.base.ItemHolder

CHILD_COUNT

Fields inherited from interface eu.ehri.project.models.base.Watchable

WATCHED_COUNT

Method Summary

Modifier and Type	Method and Description
boolean	addChild(VirtualUnit child) Add a child.
boolean	addIncludedUnit(DocumentaryUnit unit) Add a documentary unit to be included in this virtual unit.
Iterable<VirtualUnit>	getAllChildren() Fetch all child virtual units and their children recursively.
Iterable<VirtualUnit>	getAncestors()
Accessor	getAuthor() Fetch the author of this virtual unit.
int	getChildCount()
Iterable<VirtualUnit>	getChildren() Get the child virtual units subordinate to this one.
Iterable<DocumentaryUnit>	getIncludedUnits() Fetch documentary unit items included in this virtual unit.
VirtualUnit	getParent()
Iterable<Repository>	getRepositories() Get the repositories which hold the documentary unit items included in this virtual unit.
Iterable<DocumentaryUnitDescription>	getVirtualDescriptions() Fetch the descriptions of this virtual unit.
boolean	removeChild(VirtualUnit child) Remove a child virtual unit from this one.
void	removeIncludedUnit(DocumentaryUnit unit) Remove a documentary unit item from this virtual unit.
void	setAuthor(Accessor accessor) Set the author of this virtual unit.

Methods inherited from interface eu.ehri.project.models.base.Described

addDescription, getDescriptions, removeDescription

Methods inherited from interface eu.ehri.project.models.base.PermissionScope

getAllContainedItems, getContainedItems, getPermissionGrants, getPermissionScopes, idPath

Methods inherited from interface eu.ehri.project.models.base.Identifiable

getIdentifier

Methods inherited from interface eu.ehri.project.models.base.Linkable

addLink, getLinks

Methods inherited from interface eu.ehri.project.models.base.Accessible

addAccessor, getAccessors, getHistory, getLatestEvent, getPermissionScope, getPermissionScopes, hasAccessRestriction, removeAccessor, setPermissionScope

Methods inherited from interface eu.ehri.project.models.base.PermissionGrantTarget

getPermissionGrants

Methods inherited from interface eu.ehri.project.models.base.Entity

as, getId, getProperty, getProperty, getPropertyKeys, getType

Methods inherited from interface com.tinkerpop.frames.VertexFrame

asVertex

Methods inherited from interface eu.ehri.project.models.base.Watchable

getWatchedCount, getWatchers

Methods inherited from interface eu.ehri.project.models.base.Versioned

getAllPriorVersions, getPriorVersion

Methods inherited from interface eu.ehri.project.models.base.Annotatable

addAnnotation, addAnnotationPart, getAnnotations

Method Detail

getChildCount

int getChildCount()

Specified by:

getChildCount in interface ItemHolder

getParent

VirtualUnit getParent()

addChild

boolean addChild(VirtualUnit child)

Add a child.

Parameters:

child - The child collection

Returns:

Whether or not the operation was allowed.

removeChild

boolean removeChild(VirtualUnit child)

Remove a child virtual unit from this one.

Parameters:

child - a virtual unit frame

Returns:

whether or not the item was removed

getAncestors

Iterable<VirtualUnit> getAncestors()

getChildren

Iterable<VirtualUnit> getChildren()

Get the child virtual units subordinate to this one.

Returns:

an iterable of virtual unit frames

getAllChildren

Iterable<VirtualUnit> getAllChildren()

Fetch all child virtual units and their children recursively.

Returns:

an iterable of virtual unit frames

getIncludedUnits

Iterable<DocumentaryUnit> getIncludedUnits()

Fetch documentary unit items included in this virtual unit.

Returns:

an iterable of documentary unit frames

getRepositories

Iterable<Repository> getRepositories()

Get the repositories which hold the documentary unit items included in this virtual unit.

Returns:

an iterable of repository frames

addIncludedUnit

boolean addIncludedUnit(DocumentaryUnit unit)

Add a documentary unit to be included in this virtual unit.

Parameters:

unit - a documentary unit frame

Returns:

whether or not the item was newly added

removeIncludedUnit

void removeIncludedUnit(DocumentaryUnit unit)

Remove a documentary unit item from this virtual unit.

Parameters:

unit - a documentary unit frame

getAuthor

Accessor getAuthor()

Fetch the author of this virtual unit.

Returns:

a user or group frame

setAuthor

void setAuthor(Accessor accessor)

Set the author of this virtual unit.

Parameters:

accessor - a user or group frame

getVirtualDescriptions

Iterable<DocumentaryUnitDescription> getVirtualDescriptions()

Fetch the descriptions of this virtual unit.

Returns:

an iterable of documentary unit description frames