com.esri.gpt.control.webharvest.protocol
Interface Protocol

All Known Implementing Classes:

AbstractHTTPHarvestProtocol, ArcGISProtocol, HarvestProtocol, HarvestProtocolAgp, HarvestProtocolArcIms, HarvestProtocolCsw, HarvestProtocolNone, HarvestProtocolOai, HarvestProtocolResource, HarvestProtocolThredds, HarvestProtocolWaf

public interface Protocol

Protocol.

Method Summary

void	applyAttributeMap(StringAttributeMap attributeMap) Applies protocol attributes map.
StringAttributeMap	extractAttributeMap() Extracts protocol attributes map.
StringAttributeMap	getAttributeMap() Gets protocol attributes map.
long	getFlags() Gets flag set.
String	getKind() Gets protocol kind.
QueryBuilder	newQueryBuilder(IterationContext context, String url) Creates new query builder.
void	setAttributeMap(StringAttributeMap attributeMap) Sets protocol attributes map.
void	setFlags(long flags) Sets flag set.

Method Detail

getKind

String getKind()

Gets protocol kind.

Returns:

protocol kind

getAttributeMap

StringAttributeMap getAttributeMap()

Gets protocol attributes map. Used to exchange attributes with the form.

Returns:

attributes map

setAttributeMap

void setAttributeMap(StringAttributeMap attributeMap)

Sets protocol attributes map. Used to exchange attributes with the form.

Parameters:

attributeMap - attributes map

extractAttributeMap

StringAttributeMap extractAttributeMap()

Extracts protocol attributes map. Used saving (typically encrypts user name/password).

Returns:

attributes map

applyAttributeMap

void applyAttributeMap(StringAttributeMap attributeMap)

Applies protocol attributes map. Used loading (typically decrypts user name/password).

Parameters:

attributeMap - attributes map

getFlags

long getFlags()

Gets flag set.

Returns:

flags set

setFlags

void setFlags(long flags)

Sets flag set.

Parameters:

flags - flag set

newQueryBuilder

QueryBuilder newQueryBuilder(IterationContext context,
                             String url)

Creates new query builder.

Parameters:

context - iteration context

url - url

Returns:

query builder