Package com.smeup.kokos.sdk.entity.repository

Interface EntityRepository<T extends AbstractEntity>

Type Parameters:

T - the type of entity that extends AbstractEntity

public interface EntityRepository<T extends AbstractEntity>

The interface of generic repository for entities. It defines the basic CRUD operations.

Method Summary

Modifier and Type	Method	Description
void	deleteById(EntityRepositoryContext context, String id)	Deletes an entity by its id.
default List<OavDescriptor>	describeOavs(Class<? extends AbstractEntity> entityClass)	Returns the OAV metadata descriptors for the given entity class, derived purely from the SmeupOav and Id annotations on its declared fields.
Iterable<T>	find(EntityRepositoryContext context)	Reads a list of entities
T	findById(EntityRepositoryContext context, String id)	Reads a single entity by its id.
T	save(EntityRepositoryContext context, T entity)	Creates a new entity and returns the created entity with its generated id.
T	updateById(EntityRepositoryContext context, String id, T entity)	Updates an existing entity and returns the updated entity.

Method Details

find

Iterable<T> find(EntityRepositoryContext context)
          throws UnsupportedOperationException

Reads a list of entities

Throws:

UnsupportedOperationException

findById

T findById(EntityRepositoryContext context,
 String id)
    throws UnsupportedOperationException

Reads a single entity by its id.

Throws:

UnsupportedOperationException

save

T save(EntityRepositoryContext context,
 T entity)
throws UnsupportedOperationException

Creates a new entity and returns the created entity with its generated id.

Throws:

UnsupportedOperationException

deleteById

void deleteById(EntityRepositoryContext context,
 String id)
         throws UnsupportedOperationException

Deletes an entity by its id.

Throws:

UnsupportedOperationException

updateById

T updateById(EntityRepositoryContext context,
 String id,
 T entity)
      throws UnsupportedOperationException

Updates an existing entity and returns the updated entity.

Throws:

UnsupportedOperationException

describeOavs

default List<OavDescriptor> describeOavs(Class<? extends AbstractEntity> entityClass)

Returns the OAV metadata descriptors for the given entity class, derived purely from the SmeupOav and Id annotations on its declared fields.

This is a default method so that concrete repositories (e.g. AhdRepository, ContactCollaboratorRepository) get it for free without any boilerplate.

Parameters:

entityClass - the concrete entity class to introspect

Returns:

an ordered list of OavDescriptor matching field declaration order