org.hawkular.inventory.api

Interface WriteInterface<U,B extends Blueprint,Single,Id>

Type Parameters:

Id - the type of the identification of the entity (usually a string)

U - type of entity update class

B - the blueprint type that supplies data necessary to create a new entity

Single - the access interface to a single entity

All Known Subinterfaces:

Data.ReadWrite<Role>, Environments.ReadWrite, Feeds.ReadWrite, Metrics.ReadWrite, MetricTypes.ReadWrite, org.hawkular.inventory.api.ReadWriteInterface<U,B,Single,Multiple,Id>, Resources.ReadWrite, ResourceTypes.ReadWrite, Tenants.ReadWrite

All Known Implementing Classes:

BaseData.ReadWrite, BaseEnvironments.ReadWrite, BaseFeeds.ReadWrite, BaseMetrics.ReadWrite, BaseMetricTypes.ReadWrite, BaseResources.ReadWrite, BaseResourceTypes.ReadWrite, BaseTenants.ReadWrite, EmptyInventory.DataReadWrite, EmptyInventory.EnvironmentReadWrite, EmptyInventory.FeedsReadWrite, EmptyInventory.MetricsReadWrite, EmptyInventory.MetricTypesReadWrite, EmptyInventory.ResourcesReadWrite, EmptyInventory.ResourceTypesReadWrite, EmptyInventory.TenantsReadWrite

public interface WriteInterface<U,B extends Blueprint,Single,Id>

Generic methods to write access to entities.

Since:

0.0.1

Author:

Lukas Krejci

Method Summary

Modifier and Type	Method and Description
Single	create(B blueprint) Creates a new entity at the current position in the inventory traversal.
void	delete(Id id) Deletes an entity with the provided id from the current position in the inventory traversal.
void	update(Id id, U update) Persists the provided entity on the current position in the inventory traversal.

Method Detail

create

Single create(B blueprint)
       throws EntityAlreadyExistsException

Creates a new entity at the current position in the inventory traversal.

Parameters:

blueprint - the blueprint to be used to create the new entity

Returns:

access interface to the freshly created entity

Throws:

EntityAlreadyExistsException - if the entity already exists

IllegalArgumentException - if the blueprint or context in which the entity is being create is somehow invalid

update

void update(Id id,
            U update)
     throws EntityNotFoundException

Persists the provided entity on the current position in the inventory traversal.

Parameters:

id - the id of the entity to update

update - the updates to the entity

Throws:

EntityNotFoundException - if the entity is not found in the database

IllegalArgumentException - if the supplied entity could not be updated for some reason

delete

void delete(Id id)
     throws EntityNotFoundException

Deletes an entity with the provided id from the current position in the inventory traversal.

Parameters:

id - the id of the entity to delete

Throws:

EntityNotFoundException - if an entity with given ID doesn't exist on the current position in the inventory traversal

IllegalArgumentException - if the supplied entity could not be deleted for some reason