Package jade.domain.FIPAAgentManagement
Class DFAgentDescription
- java.lang.Object
-
- jade.domain.FIPAAgentManagement.DFAgentDescription
-
- All Implemented Interfaces:
Concept,Term,Serializable,Serializable
public class DFAgentDescription extends 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$ $Revision$
- Author:
- Fabio Bellifemine - CSELT S.p.A.
- See Also:
FIPAManagementOntology,AMSService, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DFAgentDescription()Default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddLanguages(String l)Add a content language name to thelanguagesslot collection of this object.voidaddOntologies(String o)Add an ontology name to theontologiesslot collection of this object.voidaddProtocols(String ip)Add a protocol name to theprotocolsslot collection of this object.voidaddServices(ServiceDescription a)Add a service description to theserviceslot collection of this object.booleancheckLeaseTimeExpired()Indicates whether the lease time for the registration of thisDFAgentDescriptionexpired.voidclearAllLanguages()Remove all content language names from thelanguagesslot collection of this object.voidclearAllOntologies()Remove all ontology names from theontologiesslot collection of this object.voidclearAllProtocols()Remove all protocol names from theprotocolsslot collection of this object.voidclearAllServices()Remove all service descriptions from theservicesslot collection of this object.IteratorgetAllLanguages()Access all content language names from thelanguagesslot collection of this object.IteratorgetAllOntologies()Access all ontology names from theontologiesslot collection of this object.IteratorgetAllProtocols()Access all protocol names from theprotocolsslot collection of this object.IteratorgetAllServices()Access all service descriptions from theservicesslot collection of this object.DategetLeaseTime()Retrieve the lease time for the registration of this description (i.e., how long it will be kept within the DF agent knowledge base).AIDgetName()Retrieve the agent identifier for the described agent.booleanremoveLanguages(String l)Remove a content language name from thelanguagesslot collection of this object.booleanremoveOntologies(String o)Remove an ontology name from theontologiesslot collection of this object.booleanremoveProtocols(String ip)Remove a protocol name from theprotocolsslot collection of this object.booleanremoveServices(ServiceDescription a)Remove a service description from theservicesslot collection of this object.voidsetLeaseTime(Date absoluteTime)Set the lease time for the registration of this DFAgentDescription as an absolute time.voidsetName(AID n)Set the identifier of the agentvoidsetRelativeLeaseTime(long relativeTime)Set the lease time for the registration of thisDFAgentDescriptionas a relative time.
-
-
-
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(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. Usenull(default) to indicate an infinite lease time
-
getLeaseTime
public 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
DFAgentDescriptionas an absolute time. Anullvalue indicates an infinite time.
-
setRelativeLeaseTime
public void setRelativeLeaseTime(long relativeTime)
Set the lease time for the registration of thisDFAgentDescriptionas 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 thisDFAgentDescriptionexpired.- Returns:
- If the lease time expired,
trueis returned, andfalseotherwise.
-
addServices
public void addServices(ServiceDescription a)
Add a service description to theserviceslot 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 theservicesslot 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 theservicesslot collection of this object.
-
getAllServices
public Iterator getAllServices()
Access all service descriptions from theservicesslot collection of this object.- Returns:
- An iterator over the service descriptions collection.
-
addProtocols
public void addProtocols(String ip)
Add a protocol name to theprotocolsslot collection of this object.- Parameters:
ip- The protocol name to add to the collection.
-
removeProtocols
public boolean removeProtocols(String ip)
Remove a protocol name from theprotocolsslot 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 theprotocolsslot collection of this object.
-
getAllProtocols
public Iterator getAllProtocols()
Access all protocol names from theprotocolsslot collection of this object.- Returns:
- An iterator over the protocol names collection.
-
addOntologies
public void addOntologies(String o)
Add an ontology name to theontologiesslot collection of this object.- Parameters:
o- The ontology name to add to the collection.
-
removeOntologies
public boolean removeOntologies(String o)
Remove an ontology name from theontologiesslot 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 theontologiesslot collection of this object.
-
getAllOntologies
public Iterator getAllOntologies()
Access all ontology names from theontologiesslot collection of this object.- Returns:
- An iterator over the ontology names collection.
-
addLanguages
public void addLanguages(String l)
Add a content language name to thelanguagesslot collection of this object.- Parameters:
l- The content language name to add to the collection.
-
removeLanguages
public boolean removeLanguages(String l)
Remove a content language name from thelanguagesslot 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 thelanguagesslot collection of this object.
-
getAllLanguages
public Iterator getAllLanguages()
Access all content language names from thelanguagesslot collection of this object.- Returns:
- An iterator over the content language names collection.
-
-