eu.ehri.project.models

Interface Repository

All Superinterfaces:

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

All Known Implementing Classes:

Repository.Impl

public interface Repository
extends Described, ItemHolder, Watchable, Versioned, Annotatable

A frame class for graph nodes representing repository items.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Repository.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
void	addTopLevelDocumentaryUnit(DocumentaryUnit unit) Add a documentary unit as a top-level item in this repository.
Iterable<DocumentaryUnit>	getAllDocumentaryUnits() Fetch items at all levels (including children of top-level items and their children, recursively.)
int	getChildCount() Count the number of top-level documentary unit items within this repository.
Country	getCountry() Fetch the country in which this repository resides.
Iterable<DocumentaryUnit>	getTopLevelDocumentaryUnits() Fetch all top-level documentary unit items within this repository.
void	setCountry(Country country) The the country in which this repository resides.

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()

Count the number of top-level documentary unit items within this repository.

Specified by:

getChildCount in interface ItemHolder

Returns:

the number of top-level items

getTopLevelDocumentaryUnits

Iterable<DocumentaryUnit> getTopLevelDocumentaryUnits()

Fetch all top-level documentary unit items within this repository.

Returns:

an iterable of top-level items

getAllDocumentaryUnits

Iterable<DocumentaryUnit> getAllDocumentaryUnits()

Fetch items at all levels (including children of top-level items and their children, recursively.)

Returns:

an iterable of documentary unit items

addTopLevelDocumentaryUnit

void addTopLevelDocumentaryUnit(DocumentaryUnit unit)

Add a documentary unit as a top-level item in this repository.

Parameters:

unit - a documentary unit item

getCountry

Country getCountry()

Fetch the country in which this repository resides.

Returns:

a country frame

setCountry

void setCountry(Country country)

The the country in which this repository resides.

Parameters:

country - a country frame