AbstractExplorerWidget (Kuwaiba Open Network Inventory Server 2.1 API)

java.lang.Object
- org.neotropic.kuwaiba.core.apis.integration.views.AbstractExplorerWidget<C>

Type Parameters:

C - The type of the graphical component that contains the explorer.

Direct Known Subclasses:

AttachmentExplorer, AuditTrailExplorer, RelationshipExplorer, SpecialChildrenExplorer
```
public abstract class AbstractExplorerWidget<C extends com.vaadin.flow.component.Component>
extends Object
```
A component designed to explore a model structures such as relationships, attachments, containment hierarchy, etc.Subclasses will behave like factories, just like

Author:

Charles Edward Bedon Cortazar <charles.bedon@kuwaiba.org>

Constructor Summary

Constructors
Constructor Description

AbstractExplorerWidget()

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`abstract String`	`appliesTo()`	Tells the consumer what type of objects the explorer is suitable for.
`abstract C`	`build(BusinessObjectLight selectedObject)`	Creates an embeddable visual component withe the explorer.
`abstract String`	`getDescription()`	Obtains the description of the explorer.
`abstract String`	`getName()`	Obtains the name of the explorer.

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

- Constructor Detail
  - AbstractExplorerWidget
```
public AbstractExplorerWidget()
```
- Method Detail
  - getName
```
public abstract String getName()
```
    Obtains the name of the explorer. This name will be used as label in lists and context menus.
    
    Returns:
    
    The explorer name.
  - getDescription
```
public abstract String getDescription()
```
    Obtains the description of the explorer. This will be used in help texts and tool tip texts.
    
    Returns:
    
    The description of what the explorer does.
  - appliesTo
```
public abstract String appliesTo()
```
    Tells the consumer what type of objects the explorer is suitable for. For example, a explorer of physical connection would be apply to GenericPhysicalConnection and so on.
    
    Returns:
    
    The type of object the explorer is intended to.
  - build
```
public abstract C build(BusinessObjectLight selectedObject)
```
    Creates an embeddable visual component withe the explorer.
    
    Parameters:
    
    selectedObject - The object from which the explorer will be built.
    
    Returns:
    
    The embeddable component.