|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--fipaos.ont.fipa.fipaman.AMSAgentDescription
FIPA defined AMS Agent Description class for the FIPA agent management ontology.
See FIPA 2000 6.1.5.
e.g. a parseable string into the object is:
(ams-agent-description :name (agent-identifier :name CameraProxy@foo.com :addresses (sequence iiop://foo.com/acc))
:ownership Ann
:state active)
Constructor Summary | |
AMSAgentDescription()
Empty constructor which can either be populated using the parse() method or the set methods. |
|
AMSAgentDescription(Content content)
This constructor takes a Content Object as the parameter and parses it into an AMSAgentDescription object. |
|
AMSAgentDescription(java.lang.String ams_string)
This constructor takes an AMSAgentDescription String as a parameter and uses the SL Parser to parse it into a Content Object. |
Method Summary | |
boolean |
canDeregister()
Indicates whether this AMS Agent Description is suitable for use in the deregister action. |
boolean |
canModify()
Indicates whether this AMS Agent description is suitable for use in the modify action. |
boolean |
canRegister()
Indicates whether this AMS Agent Description is suitable for use in the register action. |
AgentID |
getAgentID()
This method returns the agent ID |
java.lang.String |
getAgentName()
This method returns the name of the agent ID |
java.lang.String |
getObjectID()
This method is required for the DatabaseObject interface for storage. |
java.lang.String |
getOwnership()
This method returns the ownership |
java.lang.String |
getState()
This method returns the state of the agent |
boolean |
hasAgentID()
Indicates whether the agent name was present in the AMS Agent Description |
boolean |
hasState()
Indicates whether the agent state was present in the AMS Agent Description |
static void |
main(java.lang.String[] args)
This method is for testing only. |
void |
setAgentID(AgentID agent_id)
This method sets the agent ID. |
void |
setOwnership(java.lang.String ownership)
This method sets the ownership |
void |
setState(java.lang.String state)
This method sets the state of the agent |
java.lang.String |
toString()
This method returns an AMS-Agent Description as a string |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public AMSAgentDescription(java.lang.String ams_string) throws ParserException
ams_string
- the AMS-Agent Description component of an ACL stringParserException
- if the SL parser fails to parse the Stringpublic AMSAgentDescription(Content content) throws ParserException
content
- the content object representing the AMSAgentDescriptionParserException
- if the String is not validpublic AMSAgentDescription()
Method Detail |
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getObjectID()
getObjectID
in interface DatabaseObject
public AgentID getAgentID()
public void setAgentID(AgentID agent_id)
agent_id
- the AgentID of the Descriptionpublic java.lang.String getAgentName()
public java.lang.String getState()
public void setState(java.lang.String state)
state
- state of the agentpublic java.lang.String getOwnership()
public void setOwnership(java.lang.String ownership)
ownership
- Ownership stored in the descriptionpublic boolean canRegister()
public boolean canModify()
public boolean canDeregister()
public boolean hasAgentID()
public boolean hasState()
public static void main(java.lang.String[] args)
args
- Arguments array
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |