Package com.abstratt.kirra

Interface SchemaManagement

  • All Known Subinterfaces:
    Repository
    All Known Implementing Classes:
    SchemaManagementSnapshot
    public interface SchemaManagement
    Provides access to various pieces of information about a schema.

    • Method Detail

      • getApplicationName

        String getApplicationName()
        The name of the application.

      • getApplicationLabel

        default String getApplicationLabel()
        The human-friendly title of the application.

      • getApplicationLogo

        default String getApplicationLogo()
        The logo of the application, as a base64-encoded string.

      • getBuild

        String getBuild()
        The current build of the application.

      • getEntities

        List<Entity> getEntities​(String namespace)
        Returns all entities in the namespace, or across all namespaces.
        Parameters:
        namespace - the namespace, or null for all
        Returns:
        the list of entities found

      • getRoleEntities

        default List<Entity> getRoleEntities​(String namespace)
        Returns the entities in the application that represent roles.

      • getSubEntities

        default List<Entity> getSubEntities​(TypeRef baseEntity)
        Returns all entities that have the give base entity as their super entity.
        Parameters:
        baseEntity -
        Returns:

      • getEntity

        Entity getEntity​(String namespace,
                 String name)
        Returns the entity with the given name. Returns null a corresponding class does not exist, or if it is not an entity.
        Parameters:
        namespace -
        name -
        Returns:
        the corresponding entity, or null

      • getRoleEntities

        default Collection<Entity> getRoleEntities()
        Returns all entities that represent roles.

      • getEntityOperations

        List<Operation> getEntityOperations​(String namespace,
                                    String name)
        Returns the operations available for the given entity type.

      • getEntityProperties

        List<Property> getEntityProperties​(String namespace,
                                   String name)
        Returns the properties available for the given entity type.

      • getEntityRelationships

        List<Relationship> getEntityRelationships​(String namespace,
                                          String name)
        Returns the relationships available for the given entity type.

      • getNamespace

        Namespace getNamespace​(String namespaceName)
        Returns the namespace with the given name.

      • getSchema

        Schema getSchema()
        Returns the entire schema at once.

      • getAllEntityRefs

        default List<TypeRef> getAllEntityRefs()