eu.ehri.project.models.base

Interface PermissionScope

All Superinterfaces:

Entity, Identifiable, com.tinkerpop.frames.VertexFrame

All Known Subinterfaces:

AbstractUnit, AuthoritativeSet, Concept, Country, Described, DocumentaryUnit, Group, HistoricalAgent, Repository, VirtualUnit, Vocabulary

All Known Implementing Classes:

AuthoritativeSet.Impl, Concept.Impl, Country.Impl, DocumentaryUnit.Impl, Group.Impl, PermissionScope.Impl, Repository.Impl, SystemScope, VirtualUnit.Impl

public interface PermissionScope
extends Identifiable

The scope of permissions granted to users. A permission scope always has an identifier.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PermissionScope.Impl

Method Summary

Modifier and Type	Method and Description
Iterable<Accessible>	getAllContainedItems() Get an iterable of all items within this scope, recursively down to all lower levels.
Iterable<Accessible>	getContainedItems() Get an iterable of all items immediately within this scope.
Iterable<PermissionGrant>	getPermissionGrants() Get all permission grants that apply directly to this scope.
Iterable<PermissionScope>	getPermissionScopes() Get an iterable of the parent and all the parents higher permission scopes, recursively.
Collection<String>	idPath() Get the path of the permission scope as an ordered collection of strings.

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

getIdentifier

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

Method Detail

getPermissionGrants

Iterable<PermissionGrant> getPermissionGrants()

Get all permission grants that apply directly to this scope.

Returns:

an iterable of permission grant frames

getPermissionScopes

Iterable<PermissionScope> getPermissionScopes()

Get an iterable of the parent and all the parents higher permission scopes, recursively.

Returns:

an iterable of parent scope items

getContainedItems

Iterable<Accessible> getContainedItems()

Get an iterable of all items immediately within this scope.

Returns:

an iterable of lower scoped items

getAllContainedItems

Iterable<Accessible> getAllContainedItems()

Get an iterable of all items within this scope, recursively down to all lower levels.

Returns:

an iterable of lower scoped items to all depths

idPath

Collection<String> idPath()

Get the path of the permission scope as an ordered collection of strings.

Returns:

an ordered Collection of Strings that forms the 'path'.