net.powermatcher.api

Interface Agent.Status

All Known Subinterfaces:

AgentEndpoint.Status

All Known Implementing Classes:

BaseAgentEndpoint.Connected, BaseMatcherEndpoint.Connected

Enclosing interface:

Agent

public static interface Agent.Status

The Agent.Status object describes the current connection status of an Agent. This status can be queried through the Agent.getStatus() method and will give a snapshot of the state at that time.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getClusterId()
MarketBasis	getMarketBasis()
boolean	isConnected() For a agent to be connect, the Agent.setContext(FlexiblePowerContext) has been called and the agent has been configured with a clusterId (and usually a market basis).

Method Detail

getClusterId

java.lang.String getClusterId()

Returns:

the id of the cluster, as received from its Agent parent.

Throws:

java.lang.IllegalStateException - when the agent is not connected (see isConnected())

getMarketBasis

MarketBasis getMarketBasis()

Returns:

the current MarketBasis on which this Agent is running and basing its Bids and Prices.

Throws:

java.lang.IllegalStateException - when the agent is not connected (see isConnected())

isConnected

boolean isConnected()

For a agent to be connect, the Agent.setContext(FlexiblePowerContext) has been called and the agent has been configured with a clusterId (and usually a market basis). Only if this is true should the agent be used normally. For an AgentEndpoint this means that it has been connected through a Session. For a MatcherEndpoint is can be connected simply by having a MarketBasis configured (e.g. for an Auctioneer).

Returns:

true when the agent is connected to the cluster.