org.hawkular.inventory.api

Interface Metrics.ReadAssociate

All Superinterfaces:

ReadInterface<Metrics.Single,Metrics.Multiple>, ResolvingToMultiple<Metrics.Multiple>, ResolvingToSingle<Metrics.Single>

All Known Implementing Classes:

EmptyInventory.MetricsReadAssociate

Enclosing class:

Metrics

public static interface Metrics.ReadAssociate
extends ReadInterface<Metrics.Single,Metrics.Multiple>

Provides read-only access to metrics with the additional ability to relate the metrics to the current position in the inventory traversal.

Method Summary

Modifier and Type	Method and Description
Relationship	associate(String id) Adds a pre-existing entity into the relation with the current entity.
Relationship	associationWith(String id) Finds the relationship with the entity with the provided id.
Relationship	disassociate(String id) Removes an entity from the relation with the current entity.

Methods inherited from interface org.hawkular.inventory.api.ResolvingToSingle

get

Methods inherited from interface org.hawkular.inventory.api.ResolvingToMultiple

getAll

Method Detail

associate

Relationship associate(String id)
                throws EntityNotFoundException,
                       RelationAlreadyExistsException

Adds a pre-existing entity into the relation with the current entity. The current entity is determined by the current position in the inventory traversal as is the type of the entity being related to it. Consider this example:

 inventory.tenants().get(tenantId).environments().get(envId).resources().get(rId).metrics().associate(metricId);
 

In here the associate method will add a new metric (identified by the metricId) to the resource identified by the rId.

Parameters:

id - the id of a pre-existing entity to be related to the entity on the current position in the inventory traversal.

Returns:

the relationship that was created as the consequence of the association.

Throws:

EntityNotFoundException

RelationAlreadyExistsException

disassociate

Relationship disassociate(String id)
                   throws EntityNotFoundException

Removes an entity from the relation with the current entity. The current entity and the type of the entity to remove from the relation is determined by the current position in the inventory traversal.

Parameters:

id - the id of the entity to remove from the relation with the current entity.

Returns:

the relationship that was deleted as a result of the disassociation

Throws:

EntityNotFoundException

See Also:

for explanation of how the current entity and the relation is determined.

associationWith

Relationship associationWith(String id)
                      throws RelationNotFoundException

Finds the relationship with the entity with the provided id.

Parameters:

id - the id of the entity to find the relation with

Returns:

the relationship found

Throws:

RelationNotFoundException - if a relation with an entity of given id doesn't exist

See Also:

for the discussion of how the entity and the relationship is determined