SystemScope (EHRI Backend 0.13.10 API)

java.lang.Object
- java.lang.Enum<SystemScope>
- - eu.ehri.project.acl.SystemScope

All Implemented Interfaces:

com.tinkerpop.frames.VertexFrame, Entity, Identifiable, PermissionScope, Serializable, Comparable<SystemScope>
```
public enum SystemScope
extends Enum<SystemScope>
implements PermissionScope
```
Singleton class representing the system scope for permissions and ID namespaces.

Nested Class Summary
- Nested classes/interfaces inherited from interface eu.ehri.project.models.base.PermissionScope
  PermissionScope.Impl

Enum Constant Summary

Enum Constants
Enum Constant and Description

INSTANCE

Enum Constants
Enum Constant and Description
`INSTANCE`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends Entity> T`	`as(Class<T> cls)` Cast this frame to another type.
`com.tinkerpop.blueprints.Vertex`	`asVertex()`
`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.
`String`	`getId()` Get the unique item id.
`String`	`getIdentifier()`
`static PermissionScope`	`getInstance()` Obtain the shared instance of SystemScope.
`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.
`<T> T`	`getProperty(Enum<?> key)`
`<T> T`	`getProperty(String key)` Get an arbitrary property from the underlying vertex.
`Set<String>`	`getPropertyKeys()` Get the property keys from the underlying vertex.
`String`	`getType()` Get the type key for this frame.
`Collection<String>`	`idPath()` Get the path of the permission scope as an ordered collection of strings.
`static SystemScope`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SystemScope[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - INSTANCE
```
public static final SystemScope INSTANCE
```
- Method Detail
  - values
```
public static SystemScope[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (SystemScope c : SystemScope.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SystemScope valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getInstance
```
public static PermissionScope getInstance()
```
    Obtain the shared instance of SystemScope.
    
    Returns:
    
    The global SystemScope instance
  - as
```
public <T extends Entity> T as(Class<T> cls)
```
    Description copied from interface: Entity
    
    Cast this frame to another type.
    
    Specified by:
    
    as in interface Entity
    
    Type Parameters:
    
    T - the generic class
    
    Parameters:
    
    cls - the class of the framed type
    
    Returns:
    
    the framed item as the new class
  - getId
```
public String getId()
```
    Description copied from interface: Entity
    
    Get the unique item id.
    
    Specified by:
    
    getId in interface Entity
    
    Returns:
    
    id
  - getType
```
public String getType()
```
    Description copied from interface: Entity
    
    Get the type key for this frame.
    
    Specified by:
    
    getType in interface Entity
    
    Returns:
    
    type
  - getIdentifier
```
public String getIdentifier()
```
    Specified by:
    
    getIdentifier in interface Identifiable
  - asVertex
```
public com.tinkerpop.blueprints.Vertex asVertex()
```
    Specified by:
    
    asVertex in interface com.tinkerpop.frames.VertexFrame
  - getPermissionGrants
```
public Iterable<PermissionGrant> getPermissionGrants()
```
    Description copied from interface: PermissionScope
    
    Get all permission grants that apply directly to this scope.
    
    Specified by:
    
    getPermissionGrants in interface PermissionScope
    
    Returns:
    
    an iterable of permission grant frames
  - getPermissionScopes
```
public Iterable<PermissionScope> getPermissionScopes()
```
    Description copied from interface: PermissionScope
    
    Get an iterable of the parent and all the parents higher permission scopes, recursively.
    
    Specified by:
    
    getPermissionScopes in interface PermissionScope
    
    Returns:
    
    an iterable of parent scope items
  - getContainedItems
```
public Iterable<Accessible> getContainedItems()
```
    Description copied from interface: PermissionScope
    
    Get an iterable of all items immediately within this scope.
    
    Specified by:
    
    getContainedItems in interface PermissionScope
    
    Returns:
    
    an iterable of lower scoped items
  - getAllContainedItems
```
public Iterable<Accessible> getAllContainedItems()
```
    Description copied from interface: PermissionScope
    
    Get an iterable of all items within this scope, recursively down to all lower levels.
    
    Specified by:
    
    getAllContainedItems in interface PermissionScope
    
    Returns:
    
    an iterable of lower scoped items to all depths
  - idPath
```
public Collection<String> idPath()
```
    Description copied from interface: PermissionScope
    
    Get the path of the permission scope as an ordered collection of strings.
    
    Specified by:
    
    idPath in interface PermissionScope
    
    Returns:
    
    an ordered Collection of Strings that forms the 'path'.
  - getProperty
```
public <T> T getProperty(String key)
```
    Description copied from interface: Entity
    
    Get an arbitrary property from the underlying vertex.
    
    Specified by:
    
    getProperty in interface Entity
    
    Type Parameters:
    
    T - the property's type
    
    Parameters:
    
    key - the property key
    
    Returns:
    
    the property value, or null
  - getProperty
```
public <T> T getProperty(Enum<?> key)
```
    Specified by:
    
    getProperty in interface Entity
  - getPropertyKeys
```
public Set<String> getPropertyKeys()
```
    Description copied from interface: Entity
    
    Get the property keys from the underlying vertex.
    
    Specified by:
    
    getPropertyKeys in interface Entity
    
    Returns:
    
    a set of string keys

Enum SystemScope

Nested Class Summary

Nested classes/interfaces inherited from interface eu.ehri.project.models.base.PermissionScope

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INSTANCE

Method Detail

values

valueOf

getInstance

as

getId

getType

getIdentifier

asVertex

getPermissionGrants

getPermissionScopes

getContainedItems

getAllContainedItems

idPath

getProperty

getProperty

getPropertyKeys