ABLE, Version 1.1b

com.ibm.able.platform.agents
Class FipaDfAgentDescription

java.lang.Object
  |
  +--com.ibm.able.platform.agents.FipaDfAgentDescription

public class FipaDfAgentDescription
extends java.lang.Object
implements java.io.Serializable

This class provides an implementation of a FIPA DF agent description.

This class also contain an ABLE extension, which is a Java reference to the agent that this description describes. Therefore, when one looks up an agent in the DF and obtains a description of the agent, addressability to the actual agent can be obtained by calling getReference() on the description. (The returned reference must be cast to the expected agent type before being used.)

Version:
$Revision: 1.2 $, $Date: 2000/02/08 15:13:58 $
See Also:
Serialized Form

Constructor Summary
FipaDfAgentDescription()
          Create a new, empty FIPA DF agent description.
FipaDfAgentDescription(java.lang.String theAgentName, java.lang.String theAddress)
          Create a new FIPA DF agent description, and initialize it with specified parameters.
 
Method Summary
static java.lang.String Copyright()
          Determine the copyright of this class.
 java.lang.String getAddress()
          Retrieve the address of the agent.
 java.lang.String getAgentName()
          Retrieve the name of the agent.
 int getDfState()
          Retrieve the DF state.
 java.lang.String getInteractionProtocols()
          Retrieve the interaction protocols.
 java.lang.String getLanguage()
          Retrieve the language.
 java.lang.String getOntology()
          Retrieve the ontology.
 java.lang.String getOwnership()
          Retrieve the ownership.
 java.lang.Object getReference()
          Retrieve the reference.
 java.util.Vector getServices()
          Retrieve the services of the agent.
 java.lang.String getType()
          Retrieve the type.
 void setAddress(java.lang.String theAddress)
          Set the address of the agent.
 void setAgentName(java.lang.String theAgentName)
          Set the name of the agent.
 void setDfState(int theDfStateId)
          Set the DF state.
 void setInteractionProtocols(java.lang.String theInteractionProtocols)
          Set the interaction protocols.
 void setLanguage(java.lang.String theLanguage)
          Set the language.
 void setOntology(java.lang.String theOntology)
          Set the ontology.
 void setOwnership(java.lang.String theOwnership)
          Set the ownership.
 void setReference(java.lang.Object theReference)
          Set the reference.
 void setServices(java.util.Vector theServices)
          Set the services of the agent.
 void setType(java.lang.String theType)
          Set the type.
 java.lang.String toString()
          Retrieve a string describing (the contents of) the object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FipaDfAgentDescription

public FipaDfAgentDescription()
Create a new, empty FIPA DF agent description. The content must be filled in before the object can be used.

FipaDfAgentDescription

public FipaDfAgentDescription(java.lang.String theAgentName,
                              java.lang.String theAddress)
Create a new FIPA DF agent description, and initialize it with specified parameters.
Parameters:
theAgentName - The name of the agent.

theAddress - The address of the agent.

Method Detail

getAgentName

public java.lang.String getAgentName()
Retrieve the name of the agent.
Returns:
An agent name.

setAgentName

public void setAgentName(java.lang.String theAgentName)
Set the name of the agent.
Parameters:
theAgentName - A name of an agent.


getAddress

public java.lang.String getAddress()
Retrieve the address of the agent.
Returns:
An agent address.

setAddress

public void setAddress(java.lang.String theAddress)
Set the address of the agent.
Parameters:
theAddress - A address of an agent.


getServices

public java.util.Vector getServices()
Retrieve the services of the agent.
Returns:
A list of FipaService objects.

setServices

public void setServices(java.util.Vector theServices)
Set the services of the agent.
Parameters:
theServices - A list of FipaService objects.


getType

public java.lang.String getType()
Retrieve the type.
Returns:
A type.

setType

public void setType(java.lang.String theType)
Set the type.
Parameters:
theType - A type.


getInteractionProtocols

public java.lang.String getInteractionProtocols()
Retrieve the interaction protocols.
Returns:
The interaction protocols.

setInteractionProtocols

public void setInteractionProtocols(java.lang.String theInteractionProtocols)
Set the interaction protocols.
Parameters:
theInteractionProtocols - The interaction protocols.


getOntology

public java.lang.String getOntology()
Retrieve the ontology.
Returns:
The ontology.

setOntology

public void setOntology(java.lang.String theOntology)
Set the ontology.
Parameters:
theOntology - The ontology.


getLanguage

public java.lang.String getLanguage()
Retrieve the language.
Returns:
The language.

setLanguage

public void setLanguage(java.lang.String theLanguage)
Set the language.
Parameters:
theLanguage - The language.


getOwnership

public java.lang.String getOwnership()
Retrieve the ownership.
Returns:
The ownership.

setOwnership

public void setOwnership(java.lang.String theOwnership)
Set the ownership.
Parameters:
theOwnership - The ownership.


getDfState

public int getDfState()
Retrieve the DF state.
Returns:
The DF state.

setDfState

public void setDfState(int theDfStateId)
                throws java.lang.IllegalArgumentException
Set the DF state.
Parameters:
theDfStateId - The DF state.

Throws:
java.lang.IllegalArgumentException - if the DfStateId is unknown; that is, not predefined in Fipa.java.

getReference

public java.lang.Object getReference()
Retrieve the reference.
Returns:
The reference.

setReference

public void setReference(java.lang.Object theReference)
Set the reference.
Parameters:
the - reference The reference.


toString

public java.lang.String toString()
Retrieve a string describing (the contents of) the object.
Returns:
A String containing the current contents of the object.
Overrides:
toString in class java.lang.Object

Copyright

public static java.lang.String Copyright()
Determine the copyright of this class.
Returns:
A String containing this class's copyright statement.

ABLE, Version 1.1b

ABLE: Produced by Joe, Don, and Jeff who say, 'Thanks for your support.'