eu.ehri.project.models

Interface Country

All Superinterfaces:

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

All Known Implementing Classes:

Country.Impl

public interface Country
extends PermissionScope, ItemHolder, Versioned, Annotatable

Frame class representing a country. It's identifier should be represented by an ISO3166 Alpha 2 code, lower cased.

Nested Class Summary

Nested Classes

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

Field Summary

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

CHILD_COUNT

Method Summary

Modifier and Type	Method and Description
void	addRepository(Repository repository) Add a repository to this country.
int	getChildCount() Fetch a count of the number of repositories in this country.
String	getCode() Alias function for fetching the country code identifier.
Iterable<Repository>	getRepositories() Fetch all repositories in this country.
Iterable<DocumentaryUnit>	getTopLevelDocumentaryUnits()

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.Versioned

getAllPriorVersions, getPriorVersion

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.Annotatable

addAnnotation, addAnnotationPart, getAnnotations

Method Detail

getCode

String getCode()

Alias function for fetching the country code identifier.

Returns:

The country code

getChildCount

int getChildCount()

Fetch a count of the number of repositories in this country.

Specified by:

getChildCount in interface ItemHolder

Returns:

the repository count

getRepositories

Iterable<Repository> getRepositories()

Fetch all repositories in this country.

Returns:

an iterable of repository frames

getTopLevelDocumentaryUnits

Iterable<DocumentaryUnit> getTopLevelDocumentaryUnits()

addRepository

void addRepository(Repository repository)

Add a repository to this country.

Parameters:

repository - a repository frame