|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Method Summary | |
Agent |
copyAgent(Agent agent,
User userNewOwner,
java.lang.String sNewAgentname)
Copy an agent from one user to another. |
AciResponse |
createAgent(Agent agent)
Create the given agent on IDOL. |
AciResponse |
deleteAgent(Agent agent)
Remove the given agent from IDOL. |
Agent |
getAgent(java.lang.String sAgentID)
Reads the details of a user agent from IDOL. |
Agent |
getAgent(java.lang.String sAgentname,
java.lang.String sUsername)
Reads the details of a user agent from IDOL. |
java.util.ArrayList |
getAgentList(User user)
Reads all of a user's agents from IDOL. |
java.util.ArrayList |
getAgentNames(User user)
Reads the names of all of a user's agents from IDOL. |
ResultList |
getAgentResults(Agent agent,
java.util.ArrayList alAgentGetResultsParams)
Retrieve the documents that currently match an agent's training. |
AciResponse |
retrainAgent(Agent agent,
java.util.ArrayList positiveDocs)
Retrain the given agent on IDOL. |
Agent |
shareAgent(Agent agent,
User userNewOwner,
java.lang.String sNewAgentname)
NOT CURRENTLY IMPLEMENTED. |
AciResponse |
updateAgent(Agent agent)
Edit the given agent on IDOL. |
Method Detail |
public AciResponse createAgent(Agent agent) throws AciException, AgentExistsException, UserNotFoundException, MaximumAgentsException
agent
- the agent to create. The agent must be populated with at least an agentname, a username or user ID
and some training text or training documents.
AciException
- if there was an error when making the request.
AgentExistsException
- if the user already owns an agent with this name.
UserNotFoundException
- if the user does not exist on IDOL.
MaximumAgentsException
- if the user already has the maximum number allowed by the IDOL configuration.public AciResponse deleteAgent(Agent agent) throws AciException, AgentNotFoundException, UserNotFoundException
agent
- the agent to remove. The agent must be populated with at least an agentname and an username or user ID.
AciException
- if there was an error when making the request.
AgentNotFoundException
- if the user does not own an agent with this name.
UserNotFoundException
- if the user does not exist on IDOL.public AciResponse updateAgent(Agent agent) throws AciException, AgentNotFoundException, UserNotFoundException
agent
- the agent to create. The agent must be populated with at least an agentname, a username or user ID
and some training text or training documents.
AciException
- if there was an error when making the request.
AgentNotFoundException
- if the user does not own an agent with this name.
UserNotFoundException
- if the user does not exist on IDOL.public AciResponse retrainAgent(Agent agent, java.util.ArrayList positiveDocs) throws AciException, AgentNotFoundException, UserNotFoundException
agent
- the agent to create. The agent must be populated with at least an agentname, a username or user ID
and some training text or training documents.positiveDocs
- list of retraining documents. The ArrayList must be contain a list of Document objects.
AciException
- if there was an error when making the request.
AgentNotFoundException
- if the user does not own an agent with this name.
UserNotFoundException
- if the user does not exist on IDOL.public java.util.ArrayList getAgentList(User user) throws AciException, UserNotFoundException
user
- the user whose agents are required.
ArrayList
of Agent
objects representing all the agents the user has
stored on IDOL.
AciException
- if there was an error when making the request.
UserNotFoundException
- if the user does not exist on IDOL.public java.util.ArrayList getAgentNames(User user) throws AciException, UserNotFoundException
user
- the user whose agents' names are required (must be populated at least with a username or user ID).
ArrayList
of String
s giving the names of all the agents the user
has stored on IDOL.
AciException
- if there was an error when making the request.
UserNotFoundException
- if the user does not exist on IDOL.public Agent getAgent(java.lang.String sAgentname, java.lang.String sUsername) throws AciException, AgentNotFoundException, UserNotFoundException
sAgentname
- the name of the agent whose details are required.sUsername
- the username of the user whose agent details are required.
Agent
object representing the required agent.
AciException
- if there was an error when making the request.
AgentNotFoundException
- if the specified agent does not exist on IDOL.
UserNotFoundException
- if the specified user does not exist on IDOL.public Agent getAgent(java.lang.String sAgentID) throws AciException, AgentNotFoundException, UserNotFoundException
sAgentID
- the unique ID of the agent whose details are required.
Agent
object representing the required agent.
AciException
- if there was an error when making the request.
AgentNotFoundException
- if the specified agent does not exist on IDOL.
UserNotFoundException
- if the specified user does not exist on IDOL.public Agent copyAgent(Agent agent, User userNewOwner, java.lang.String sNewAgentname) throws AciException, AgentNotFoundException, UserNotFoundException, MaximumAgentsException
agent
- the agent to be copied.userNewOwner
- the user who will own the new agent.sNewAgentname
- the name to give to the agent copy.
AciException
- if there was an error when making the request.
AgentNotFoundException
- if the agent to be copied does not exist
UserNotFoundException
- if the destination user does not exist on IDOL.
MaximumAgentsException
- if the user already has the maximum number allowed by the IDOL configuration.public Agent shareAgent(Agent agent, User userNewOwner, java.lang.String sNewAgentname) throws AciException, AgentNotFoundException, UserNotFoundException, AgentExistsException
agent
- the agent to be shared.userNewOwner
- the user who will own the shared agent.sNewAgentname
- the name to give to the shared agent.
Agent
object representing the shared agent.
AciException
- if there was an error when making the request.
AgentNotFoundException
- if the specified agent does not exist on IDOL.
AgentExistsException
- if the user already has an agent with the given name.
UserNotFoundException
- if the specified user does not exist on IDOL.public ResultList getAgentResults(Agent agent, java.util.ArrayList alAgentGetResultsParams) throws AciException, AgentNotFoundException, UserNotFoundException, DataStoreNotFoundException
agent
- the agent whose results are required.alAgentGetResultsParams
- extra parameters to send when retrieving agent results. Parameters
set here will override any parameters set by the agent. Can be null
.
ResultList
containing the documents matching the agent's training.
AciException
- if there was an error when making the request.
AgentNotFoundException
- if the specified agent does not exist on IDOL.
UserNotFoundException
- if the specified user does not exist on IDOL.
DataStoreNotFoundException
- if content was not available to retrieve results from.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |