net.powermatcher.api

Interface Agent

All Known Subinterfaces:

AgentEndpoint, MatcherEndpoint, ObservableAgent, TransformingConcentrator

All Known Implementing Classes:

Auctioneer, BaseAgent, BaseAgentEndpoint, BaseMatcherEndpoint, Concentrator, PeakShavingConcentrator

public interface Agent

Agent defines the interface with the basic functionality needed to act as an agent in a Powermatcher cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Agent.Status The Agent.Status object describes the current connection status of an Agent.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAgentId()
Agent.Status	getStatus()
void	setContext(org.flexiblepower.context.FlexiblePowerContext context) Give the agent a reference to a FlexiblePowerContext.

Method Detail

getAgentId

java.lang.String getAgentId()

Returns:

the mandatory unique id of the Agent.

getStatus

Agent.Status getStatus()

Returns:

The current Agent.Status of the Agent. This returns a snapshot of the state that won't change. If used at a later time, the snapshot should be refreshed.

setContext

void setContext(org.flexiblepower.context.FlexiblePowerContext context)

Give the agent a reference to a FlexiblePowerContext. This should be done by the runtime bundle after the component is activated.

Parameters:

context - reference to the FlexiblePowerContext