eu.ehri.project.models.base

Interface Accessible

All Superinterfaces:

Entity, PermissionGrantTarget, com.tinkerpop.frames.VertexFrame

All Known Subinterfaces:

AbstractUnit, AccessPoint, Annotation, AuthoritativeItem, AuthoritativeSet, Concept, ConceptDescription, ContentType, Country, Described, Description, DocumentaryUnit, DocumentaryUnitDescription, Group, HistoricalAgent, HistoricalAgentDescription, Link, Linkable, MaintenanceEvent, Permission, Promotable, Repository, RepositoryDescription, SystemEvent, UnknownProperty, UserProfile, Version, Versioned, VirtualUnit, Vocabulary, Watchable

All Known Implementing Classes:

Accessible.Impl, AuthoritativeSet.Impl, Concept.Impl, Country.Impl, DocumentaryUnit.Impl, Entity.Impl, Group.Impl, Promotable.Impl, Repository.Impl, SystemEvent.Impl, UserProfile.Impl, Version.Impl, Versioned.Impl, VirtualUnit.Impl, Watchable.Impl

public interface Accessible
extends PermissionGrantTarget

An entity that can be accessed by specific Accessors.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
void	addAccessor(Accessor accessor) only Accessor accessor can access this Accessible item.
Iterable<Accessor>	getAccessors() Fetch accessors to which this item is restricted.
Iterable<SystemEvent>	getHistory() Fetch a list of Actions for this entity in order.
SystemEvent	getLatestEvent() Fetch the most recent event that affected this item.
PermissionScope	getPermissionScope() Fetch the permission scope to which this item belongs, if any.
Iterable<PermissionScope>	getPermissionScopes() Get the full hierarchy of permission scopes to which this item belongs.
boolean	hasAccessRestriction() Determine if this item has access restrictions.
void	removeAccessor(Accessor accessor) Remove an accessor from having access to this item.
void	setPermissionScope(PermissionScope scope) Set this item's permission scope.

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

Method Detail

getAccessors

Iterable<Accessor> getAccessors()

Fetch accessors to which this item is restricted.

Returns:

an iterable of accessor frames

addAccessor

void addAccessor(Accessor accessor)

only Accessor accessor can access this Accessible item. This is NOT the way to add an Accessor to a Group, use Group.addMember()

Parameters:

accessor - an accessor that can access the current item

removeAccessor

void removeAccessor(Accessor accessor)

Remove an accessor from having access to this item.

Parameters:

accessor - an accessor frame

getPermissionScope

PermissionScope getPermissionScope()

Fetch the permission scope to which this item belongs, if any.

Returns:

a permission scope frame, or null

setPermissionScope

void setPermissionScope(PermissionScope scope)

Set this item's permission scope.

Parameters:

scope - a permission scope frame

getPermissionScopes

Iterable<PermissionScope> getPermissionScopes()

Get the full hierarchy of permission scopes to which this item belongs.

Returns:

an iterable of permission scope frames

getHistory

Iterable<SystemEvent> getHistory()

Fetch a list of Actions for this entity in order.

Returns:

a list of system event frames

getLatestEvent

SystemEvent getLatestEvent()

Fetch the most recent event that affected this item.

Returns:

a system event frame, or null

hasAccessRestriction

boolean hasAccessRestriction()

Determine if this item has access restrictions.

Returns:

true, if the item is restricted, otherwise false