|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.able.platform.AbleAgentSituationReport
Capture the entire context of a circumstance an agent it currently in, including any response information needed before an action is taken.
The purpose of this class is to allow circumstances to be captured for later machine learning and labeling of training instances by an administrator.
This is the object that is logged to the logging service by and agent or any part of the platform. It can represent a circumstance that an agent is having, and another agent or user at the console can answer this situation request and the agent will take this action. It could also represent the history of an agent. The agent could just send an AbleAgentSituationReport to the logging service every now and then with status and updates and info on what it has been doing.
Constructor Summary | |
AbleAgentSituationReport(AbleAgentSituationReport theAbleAgentSituationReport)
Creates an AbleAgentSituationReport based off another AbleAgentSituationReport. |
|
AbleAgentSituationReport(AbleEServerSituation theSituation,
AbleMessageContainer theResponseTaken,
AbleMessageContainer theResultsSummary,
javax.agent.AgentName theAgentName,
java.lang.String theAgentDescription,
long theTimeCreated,
java.lang.String theSystemName,
java.lang.Integer theAutomationLevel)
Creates an AbleAgentSituationReport. |
|
AbleAgentSituationReport(java.io.Serializable theIdentifier,
AbleEServerCapability theCapability,
AbleEServerSituation theSituation,
AbleMessageContainer theSuggestedResponse,
AbleMessageContainer theResponseTaken,
AbleMessageContainer theResultsSummary,
boolean theState,
javax.agent.AgentName theAgentName,
java.lang.String theAgentDescription,
long theTimeCreated,
java.lang.String theSystemName,
java.lang.Integer theAutomationLevel)
Creates an AbleAgentSituationReport. |
|
AbleAgentSituationReport(java.io.Serializable theIdentifier,
AbleEServerCapability theCapability,
AbleEServerSituation theSituation,
AbleMessageContainer theSuggestedResponse,
javax.agent.AgentName theAgentName,
java.lang.String theAgentDescription,
long theTimeCreated,
java.lang.String theSystemName,
java.lang.Integer theAutomationLevel)
Creates an AbleAgentSituationReport. |
Method Summary | |
static java.lang.String |
Copyright()
Gets the copyright of this class. |
java.lang.String |
debugString()
Returns a translated representation of this AbleAgentSituationReport. |
boolean |
equals(java.lang.Object o)
Compares this AbleAgentSituationReport with another to determine if the reports are equal. |
java.lang.String |
getAgentDescription()
Getter for agentDescription |
javax.agent.AgentName |
getAgentName()
Method getAgentName |
java.lang.Integer |
getAutomationLevel()
Method getAutomationLevel |
AbleEServerCapability |
getCapability()
Method getCapability. |
java.io.Serializable |
getIdentifier()
Method getIdentifier. |
boolean |
getProblemState()
Method getProblemState. |
AbleMessageContainer |
getResponseTaken()
Method getResponseTaken. |
AbleMessageContainer |
getResultsSummary()
Method getResultsSummary. |
AbleEServerSituation |
getSituation()
Method getSituation. |
AbleMessageContainer |
getSuggestedResponse()
Method getSuggestedResponse. |
java.lang.String |
getSystemName()
Method getSystemName |
long |
getTimeCreated()
Method getTimeCreated |
int |
hashCode()
Return the hashCode for an AbleAgentSituationReport |
void |
setProblemState(boolean theProblemState)
Method setProblemState. |
void |
setResponseTaken(AbleMessageContainer theResponseTaken)
Method setResponseTaken. |
void |
setResultsSummary(AbleMessageContainer theResultsSummary)
Method setResultsSummary. |
java.lang.String |
toString()
Returns a brief description of this AbleAgentSituationReport. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public AbleAgentSituationReport(java.io.Serializable theIdentifier, AbleEServerCapability theCapability, AbleEServerSituation theSituation, AbleMessageContainer theSuggestedResponse, AbleMessageContainer theResponseTaken, AbleMessageContainer theResultsSummary, boolean theState, javax.agent.AgentName theAgentName, java.lang.String theAgentDescription, long theTimeCreated, java.lang.String theSystemName, java.lang.Integer theAutomationLevel)
An AbleAgentSituationReport is used for an agent to describe a circumstance that it is in.
theIdentifier
- This may hold any Serializable Object and
be used in any way the agent wants. It is intended to
make this AbleAgentSituationReport Object unique from all
other AbleAgentSituationReports of this agent.
theCapability
- The agent capability that this
AbleAgentSituationReport came from.
theSituation
- The agent situation that this
AbleAgentSituationReport came from.
theSuggestedResponse
- The suggested response that should be taken
when this AbleAgentSituationReport is a request.
theResponseTaken
- The response that was taken.
theResultsSummary
- The results summary of the response that was taken.
theState
- The problem state of this AbleAgentSituationReport.
theAgentName
- The AgentName of the agent that created this
AbleAgentSituationReport.
theAgentDescription
- A description of the agent that created
this AbleAgentSituationReport.
theTimeCreated
- The time that this AbleAgentSituationReport was created.
theSystemName
- The system that the creator of this
AbleAgentSituationReport is running on.
theAutomationLevel
- The automation level of the agent at the time this
AbleAgentSituationReport was created.public AbleAgentSituationReport(java.io.Serializable theIdentifier, AbleEServerCapability theCapability, AbleEServerSituation theSituation, AbleMessageContainer theSuggestedResponse, javax.agent.AgentName theAgentName, java.lang.String theAgentDescription, long theTimeCreated, java.lang.String theSystemName, java.lang.Integer theAutomationLevel)
An AbleAgentSituationReport is used for an agent to describe a circumstance that it is in. This constructor should be used when creating an AbleAgentSituaitonReport that needs a response.
Besides responseTaken
, resultsSummary
and problemState
(which will be set to true),
everything will be an argument to this constructor.
theIdentifier
- This may hold any Serializable Object and
be used in any way the agent wants. It is intended to
make this AbleAgentSituationReport Object unique from all
other AbleAgentSituationReports of this agent.
theCapability
- The agent capability that this
AbleAgentSituationReport came from.
theSituation
- The agent situation that this
AbleAgentSituationReport came from.
theAgentName
- The AgentName of the agent that created this
AbleAgentSituationReport.
theAgentDescription
- A description of the agent that created
this AbleAgentSituationReport.
theTimeCreated
- The time that this AbleAgentSituationReport was created.
theSystemName
- The system that the creator of this
AbleAgentSituationReport is running on.
theAutomationLevel
- The automation level of the agent at the time this
AbleAgentSituationReport was created.public AbleAgentSituationReport(AbleEServerSituation theSituation, AbleMessageContainer theResponseTaken, AbleMessageContainer theResultsSummary, javax.agent.AgentName theAgentName, java.lang.String theAgentDescription, long theTimeCreated, java.lang.String theSystemName, java.lang.Integer theAutomationLevel)
An AbleAgentSituationReport is used for an agent to describe a
circumstance that it is in. This constructor should be used when
creating an AbleAgentSituaitonReport that will be a history log.
Besides identifier
, capability
,
suggestedResponse
and problemState
(which will be set to false
) everything will be set
on the constructor.
theSituation
- The agent situation that this
AbleAgentSituationReport came from.
theResponseTaken
- The response that was taken.
theResultsSummary
- The results summary of the response that was taken.
theAgentName
- The AgentName of the agent that created this
AbleAgentSituationReport.
theAgentDescription
- A description of the agent that created
this AbleAgentSituationReport.
theTimeCreated
- The time that this AbleAgentSituationReport was created.
theSystemName
- The system that the creator of this
AbleAgentSituationReport is running on.
theAutomationLevel
- The automation level of the agent at the time this
AbleAgentSituationReport was created.public AbleAgentSituationReport(AbleAgentSituationReport theAbleAgentSituationReport)
An AbleAgentSituationReport is used for an agent to describe a situation that it is in. This constructor should be used as a copy constructor.
theAbleAgentSituationReport
- The AbleAgentSituationReport
to create a new AbleAgentSituationReport based off of.Method Detail |
public java.io.Serializable getIdentifier()
public void setResponseTaken(AbleMessageContainer theResponseTaken)
theResponseTaken
- The response that was taken for this AbleAgentSituationReport.public AbleMessageContainer getResponseTaken()
public void setResultsSummary(AbleMessageContainer theResultsSummary)
public AbleMessageContainer getResultsSummary()
public AbleMessageContainer getSuggestedResponse()
public AbleEServerCapability getCapability()
public AbleEServerSituation getSituation()
public void setProblemState(boolean theProblemState)
public boolean getProblemState()
public javax.agent.AgentName getAgentName()
public java.lang.String getAgentDescription()
public java.lang.String getSystemName()
public long getTimeCreated()
public java.lang.Integer getAutomationLevel()
public java.lang.String debugString()
public static java.lang.String Copyright()
public boolean equals(java.lang.Object o)
AbleAgentSituationReports are equal if their internal, private, immutable handles are equal.
equals
in class java.lang.Object
o
- An instance of an AbleAgentSituationReport that is to
be compared to this AbleAgentSituationReport.
AbleAgentSituationReports are equal if their internal, private, immutable handles are equal.
public int hashCode()
The hashCode of an AbleAgentSituationReport is the sum of the hashCodes of all of the the internal, private, immutable handles of this Object.
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |