Package ddf.catalog.util

Interface Describable

All Superinterfaces:
org.codice.ddf.platform.services.common.Describable
All Known Subinterfaces:
CatalogFramework, CatalogProvider, CatalogStore, ConnectedSource, FederatedSource, Maskable, OAuthFederatedSource, RemoteSource, ResourceReader, Source, SourceCache, SourceDescriptor
@Deprecated public interface Describable extends org.codice.ddf.platform.services.common.Describable
Deprecated.
see Describable
Describable is used to capture a basic description. For an example of a how the Describable interface is used view the Source interface and the
invalid reference 
DescribableImpl
class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Deprecated.
    Returns a description of the describable item.
    String
    getId()
    Deprecated.
    Returns the name, aka ID, of the describable item.
    String
    getOrganization()
    Deprecated.
    Returns the organization associated with the describable item.
    String
    getTitle()
    Deprecated.
    Returns the title of the describable item.
    String
    getVersion()
    Deprecated.
    Retrieve the version.

  • Method Details

    • getVersion

      String getVersion()
      Deprecated.
      Retrieve the version.
      Specified by:
      getVersion in interface org.codice.ddf.platform.services.common.Describable
      Returns:
      the version of the item being described (example: 1.0)

    • getId

      String getId()
      Deprecated.
      Returns the name, aka ID, of the describable item. The name should be unique for each instance.
      Example: html for a MetacardTransformer that transforms Metacards to HTML
      Specified by:
      getId in interface org.codice.ddf.platform.services.common.Describable
      Returns:
      ID of the item

    • getTitle

      String getTitle()
      Deprecated.
      Returns the title of the describable item. It is generally more verbose than the name (aka ID).
      Specified by:
      getTitle in interface org.codice.ddf.platform.services.common.Describable
      Returns:
      title of the item (example: Dummy Catalog Provider)

    • getDescription

      String getDescription()
      Deprecated.
      Returns a description of the describable item.
      Specified by:
      getDescription in interface org.codice.ddf.platform.services.common.Describable
      Returns:
      description of the item (example: Provider that returns back static results)

    • getOrganization

      String getOrganization()
      Deprecated.
      Returns the organization associated with the describable item.
      Specified by:
      getOrganization in interface org.codice.ddf.platform.services.common.Describable
      Returns:
      organizational name or acronym (example: USAF)