org.eclipse.kura.wire.graph

Interface WireGraphService

@ProviderType
public interface WireGraphService

This interface provides all the needed methods to interact with the WireGraph.

Since:

1.4

Method Summary

Modifier and Type	Method and Description
void	delete() This method allows to delete the current Wire Graph.
WireGraphConfiguration	get() This method returns the current Wire Graph configuration.
void	update(WireGraphConfiguration graphConfiguration) This method allows to create and update the graph, by providing a WireGraphConfiguration.

Method Detail

update

void update(WireGraphConfiguration graphConfiguration)
     throws KuraException

This method allows to create and update the graph, by providing a WireGraphConfiguration.

Parameters:

graphConfiguration - A WireGraphConfiguration object that represents an updated status of the Wire Graph

Throws:

{@link - KuraException} if the update operation fails

KuraException

delete

void delete()
     throws KuraException

This method allows to delete the current Wire Graph.

Throws:

{@link - KuraException} if the delete operation fails

KuraException

get

WireGraphConfiguration get()
                    throws KuraException

This method returns the current Wire Graph configuration.

Returns:

a WireGraphConfiguration object that represents the current configuration of the Wire Graph

Throws:

{@link - KuraException} if the get operation fails

KuraException