jade.domain.FIPAAgentManagement
Class DFAgentDescription

java.lang.Object
  |
  +--jade.domain.FIPAAgentManagement.DFAgentDescription
All Implemented Interfaces:
Concept, java.io.Serializable, Serializable, Term

public class DFAgentDescription
extends java.lang.Object
implements Concept

This class implements the concept of the fipa-agent-management ontology representing the description of an agent in the DF catalogue.

Version:
$Date: 2005-06-23 14:47:39 +0200 (Thu, 23 Jun 2005) $ $Revision: 5731 $
Author:
Fabio Bellifemine - CSELT S.p.A.
See Also:
FIPAManagementOntology, AMSService, Serialized Form

Constructor Summary
DFAgentDescription()
          Default constructor.
 
Method Summary
 void addLanguages(java.lang.String l)
          Add a content language name to the languages slot collection of this object.
 void addOntologies(java.lang.String o)
          Add an ontology name to the ontologies slot collection of this object.
 void addProtocols(java.lang.String ip)
          Add a protocol name to the protocols slot collection of this object.
 void addServices(ServiceDescription a)
          Add a service description to the service slot collection of this object.
 boolean checkLeaseTimeExpired()
          Indicates whether the lease time for the registration of this DFAgentDescription expired.
 void clearAllLanguages()
          Remove all content language names from the languages slot collection of this object.
 void clearAllOntologies()
          Remove all ontology names from the ontologies slot collection of this object.
 void clearAllProtocols()
          Remove all protocol names from the protocols slot collection of this object.
 void clearAllServices()
          Remove all service descriptions from the services slot collection of this object.
 Iterator getAllLanguages()
          Access all content language names from the languages slot collection of this object.
 Iterator getAllOntologies()
          Access all ontology names from the ontologies slot collection of this object.
 Iterator getAllProtocols()
          Access all protocol names from the protocols slot collection of this object.
 Iterator getAllServices()
          Access all service descriptions from the services slot collection of this object.
 java.util.Date getLeaseTime()
          Retrieve the lease time for the registration of this description (i.e., how long it will be kept within the DF agent knowledge base).
 AID getName()
          Retrieve the agent identifier for the described agent.
 boolean removeLanguages(java.lang.String l)
          Remove a content language name from the languages slot collection of this object.
 boolean removeOntologies(java.lang.String o)
          Remove an ontology name from the ontologies slot collection of this object.
 boolean removeProtocols(java.lang.String ip)
          Remove a protocol name from the protocols slot collection of this object.
 boolean removeServices(ServiceDescription a)
          Remove a service description from the services slot collection of this object.
 void setLeaseTime(java.util.Date absoluteTime)
          Set the lease time for the registration of this DFAgentDescription as an absolute time.
 void setName(AID n)
          Set the identifier of the agent
 void setRelativeLeaseTime(long relativeTime)
          Set the lease time for the registration of this DFAgentDescription as a relative time.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DFAgentDescription

public DFAgentDescription()
Default constructor.

Method Detail

setName

public void setName(AID n)
Set the identifier of the agent

Parameters:
n - the identifier of the agent

getName

public AID getName()
Retrieve the agent identifier for the described agent.

Returns:
The identifier of the agent

setLeaseTime

public void setLeaseTime(java.util.Date absoluteTime)
Set the lease time for the registration of this DFAgentDescription as an absolute time.

Parameters:
absoluteTime - The lease time for the registration of this DFAgentDescription as an absolute time. Use null (default) to indicate an infinite lease time

getLeaseTime

public java.util.Date getLeaseTime()
Retrieve the lease time for the registration of this description (i.e., how long it will be kept within the DF agent knowledge base).

Returns:
The lease time for the registration of this DFAgentDescription as an absolute time. A null value indicates an infinite time.

setRelativeLeaseTime

public void setRelativeLeaseTime(long relativeTime)
Set the lease time for the registration of this DFAgentDescription as a relative time.

Parameters:
relativeTime - The lease time for the registration of this DFAgentDescription as a relative time.

checkLeaseTimeExpired

public boolean checkLeaseTimeExpired()
Indicates whether the lease time for the registration of this DFAgentDescription expired.

Returns:
If the lease time expired, true is returned, and false otherwise.

addServices

public void addServices(ServiceDescription a)
Add a service description to the service slot collection of this object.

Parameters:
a - The service description to add to the collection.

removeServices

public boolean removeServices(ServiceDescription a)
Remove a service description from the services slot collection of this object.

Parameters:
a - The service description to remove from the collection.
Returns:
A boolean, telling whether the element was present in the collection or not.

clearAllServices

public void clearAllServices()
Remove all service descriptions from the services slot collection of this object.


getAllServices

public Iterator getAllServices()
Access all service descriptions from the services slot collection of this object.

Returns:
An iterator over the service descriptions collection.

addProtocols

public void addProtocols(java.lang.String ip)
Add a protocol name to the protocols slot collection of this object.

Parameters:
ip - The protocol name to add to the collection.

removeProtocols

public boolean removeProtocols(java.lang.String ip)
Remove a protocol name from the protocols slot collection of this object.

Parameters:
ip - The protocol name to remove from the collection.
Returns:
A boolean, telling whether the element was present in the collection or not.

clearAllProtocols

public void clearAllProtocols()
Remove all protocol names from the protocols slot collection of this object.


getAllProtocols

public Iterator getAllProtocols()
Access all protocol names from the protocols slot collection of this object.

Returns:
An iterator over the protocol names collection.

addOntologies

public void addOntologies(java.lang.String o)
Add an ontology name to the ontologies slot collection of this object.

Parameters:
o - The ontology name to add to the collection.

removeOntologies

public boolean removeOntologies(java.lang.String o)
Remove an ontology name from the ontologies slot collection of this object.

Parameters:
o - The ontology name to remove from the collection.
Returns:
A boolean, telling whether the element was present in the collection or not.

clearAllOntologies

public void clearAllOntologies()
Remove all ontology names from the ontologies slot collection of this object.


getAllOntologies

public Iterator getAllOntologies()
Access all ontology names from the ontologies slot collection of this object.

Returns:
An iterator over the ontology names collection.

addLanguages

public void addLanguages(java.lang.String l)
Add a content language name to the languages slot collection of this object.

Parameters:
l - The content language name to add to the collection.

removeLanguages

public boolean removeLanguages(java.lang.String l)
Remove a content language name from the languages slot collection of this object.

Parameters:
l - The content language name to remove from the collection.
Returns:
A boolean, telling whether the element was present in the collection or not.

clearAllLanguages

public void clearAllLanguages()
Remove all content language names from the languages slot collection of this object.


getAllLanguages

public Iterator getAllLanguages()
Access all content language names from the languages slot collection of this object.

Returns:
An iterator over the content language names collection.


JADE