org.codice.ddf.commands.catalog.facade

Class Framework

java.lang.Object

org.codice.ddf.commands.catalog.facade.CatalogFacade

org.codice.ddf.commands.catalog.facade.Framework

All Implemented Interfaces:

Describable

public class Framework
extends CatalogFacade

Constructor Summary

Constructors

Constructor and Description
Framework(CatalogFramework framework)

Method Summary

Modifier and Type	Method and Description
CreateResponse	create(CreateRequest createRequest)
DeleteResponse	delete(DeleteRequest deleteRequest)
String	getDescription() Returns a description of the describable item.
String	getId() Returns the name, aka ID, of the describable item.
String	getOrganization() Returns the organization associated with the describable item.
Set<String>	getSourceIds()
String	getTitle() Returns the title of the describable item.
String	getVersion() Retrieve the version.
QueryResponse	query(QueryRequest query)
UpdateResponse	update(UpdateRequest updateRequest)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Framework

public Framework(CatalogFramework framework)

Method Detail

getVersion

public String getVersion()

Description copied from interface: Describable

Retrieve the version.

Returns:

the version of the item being described (example: 1.0)

getId

public String getId()

Description copied from interface: Describable

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

Returns:

ID of the item

getTitle

public String getTitle()

Description copied from interface: Describable

Returns the title of the describable item. It is generally more verbose than the name (aka ID).

Returns:

title of the item (example: Dummy Catalog Provider)

getDescription

public String getDescription()

Description copied from interface: Describable

Returns a description of the describable item.

Returns:

description of the item (example: Provider that returns back static results)

getOrganization

public String getOrganization()

Description copied from interface: Describable

Returns the organization associated with the describable item.

Returns:

organizational name or acronym (example: USAF)

create

public CreateResponse create(CreateRequest createRequest)
                      throws IngestException,
                             SourceUnavailableException

Specified by:

create in class CatalogFacade

Throws:

IngestException

SourceUnavailableException

update

public UpdateResponse update(UpdateRequest updateRequest)
                      throws IngestException,
                             SourceUnavailableException

Specified by:

update in class CatalogFacade

Throws:

IngestException

SourceUnavailableException

delete

public DeleteResponse delete(DeleteRequest deleteRequest)
                      throws IngestException,
                             SourceUnavailableException

Specified by:

delete in class CatalogFacade

Throws:

IngestException

SourceUnavailableException

query

public QueryResponse query(QueryRequest query)
                    throws UnsupportedQueryException,
                           SourceUnavailableException,
                           FederationException

Specified by:

query in class CatalogFacade

Throws:

UnsupportedQueryException

SourceUnavailableException

FederationException

getSourceIds

public Set<String> getSourceIds()

Specified by:

getSourceIds in class CatalogFacade