EntityManager (Step 3.15.0 API)

java.lang.Object
- step.core.entities.EntityManager

public class EntityManager
extends Object

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`executions`
`static String`	`functions`
`static String`	`plans`
`static String`	`recursive`
`static String`	`reports`
`static String`	`resourceRevisions`
`static String`	`resources`
`static String`	`tasks`
`static String`	`users`

Constructor Summary

Constructors
Constructor Description

EntityManager(AbstractStepContext context)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`getAllEntities(String entityName, String id, EntityReferencesMap references)`	get entities recursively by scanning the given entity (aka artefact), the entity is retrieved and deserialized from the db
`Entity<?,?>`	`getEntitiesByClass(Class<?> c)`
`void`	`getEntitiesReferences(String entityType, ObjectPredicate objectPredicate, boolean recursively, EntityReferencesMap refs)`	Retrieve all existing references from the DB for give entity type
`Entity<?,?>`	`getEntityByName(String entityName)`
`EntityManager`	`register(Entity<?,?> entity)`
`void`	`updateReferences(Object object, Map<String,String> references)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- executions
```
public static final String executions
```
  See Also:
  
  Constant Field Values
- plans
```
public static final String plans
```
  See Also:
  
  Constant Field Values
- functions
```
public static final String functions
```
  See Also:
  
  Constant Field Values
- reports
```
public static final String reports
```
  See Also:
  
  Constant Field Values
- tasks
```
public static final String tasks
```
  See Also:
  
  Constant Field Values
- users
```
public static final String users
```
  See Also:
  
  Constant Field Values
- resources
```
public static final String resources
```
  See Also:
  
  Constant Field Values
- resourceRevisions
```
public static final String resourceRevisions
```
  See Also:
  
  Constant Field Values
- recursive
```
public static final String recursive
```
  See Also:
  
  Constant Field Values

Constructor Detail

EntityManager

public EntityManager(AbstractStepContext context)

Method Detail

register

public EntityManager register(Entity<?,?> entity)

getEntityByName

public Entity<?,?> getEntityByName(String entityName)

getEntitiesReferences
```
public void getEntitiesReferences(String entityType,
                                  ObjectPredicate objectPredicate,
                                  boolean recursively,
                                  EntityReferencesMap refs)
```
Retrieve all existing references from the DB for give entity type

Parameters:

entityType - type of entities to retrieve

objectPredicate - to apply to filter entities (i.e. project)

recursively - flag to export references recursively (i.e by exporting a plan recursively the plan will be scanned to find sub references)

refs - the map of entity references to be populated during the process

getAllEntities
```
public void getAllEntities(String entityName,
                           String id,
                           EntityReferencesMap references)
```
get entities recursively by scanning the given entity (aka artefact), the entity is retrieved and deserialized from the db

Parameters:

entityName - name of the type of entity

id - the id of the entity

references - the map of references to be populated

getEntitiesByClass

public Entity<?,?> getEntitiesByClass(Class<?> c)

updateReferences

public void updateReferences(Object object,
                             Map<String,String> references)