Interface IAgentManager

All Superinterfaces:

IDisposable, IEntity

public interface IAgentManager
extends IEntity

Manages the agents.

Method Summary

Modifier and Type	Method	Description
void	assignCampaign(String agentName, String campaignName)	Assigns an agent to the campaign.
void	assignTeam(String agentName, String teamName)	Assigns an agent to the team.
void	cleanupAgent(String agentName)	Cleans the agent in the instance if logged as agent.
void	cleanupSupervisor(String agentName)	Cleans the agent in the instance if logged as supervisor.
int	createAgent(AgentCreateRequest request)	Creates an agent.
void	deAssignCampaign(String agentName, String campaignName)	Deassigns an agent to the campaign.
void	deAssignTeam(String agentName, String teamName)	Deassigns an agent to the team.
void	deleteAgent(String agentName)	Deletes an agent.
void	deleteAgentById(int agentId)	Deletes an agent.
int	duplicateAgent(String agentName, AgentCreateRequest request)	Duplicates the current agent
void	forcedDeAssignCampaign(String agentName, String campaignName)	Deassigns an agent to the campaign regardless of the current state of the campaign.
IAgentCursor	getAgentCursor(int cursorId)	Gets an agent cursor open in the instance.
IAgentCursor[]	getAgentCursors()	Returns the agent cursors open in the instance.
AgentData	getAgentDataById(int agentId)	Gets the agent data.
AgentData	getAgentDataByName(String agentName)	Gets the agent data.
TableSchema	getAgentTableSchema()	Gets the table schema of the agent.
CampaignData[]	getAssignedCampaigns(String agentName, AssignmentMode assignmentMode)	Gets the data of campaigns assigned to the agent.
TeamData[]	getAssignedTeams(String agentName)	Gets the data of the teams assigned to the agent.
IInstance	getInstance()	The instance.
AgentRolePermission[]	getPermissions(String agentName)	Gets the list of role permissions.
IAgentCursor	newAgentCursor(String[] columns, String sql, AgentAssignmentFilter assignmentFilter)	Opens an agent cursor.
void	sendCustomData(String agentName, byte[] customData)	Sends custom data (blind data) to applications.
void	sendMessage(String agentName, String message)	Sends a message to an agent.
IAgentCursor	tryGetAgentCursor(int cursorId)	Gets an agent cursor open in the instance or null if it doesn't exist.
void	updateAgent(String agentName, AgentUpdateRequest request)	Updates an agent.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

assignCampaign

void assignCampaign(String agentName,
 String campaignName)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Assigns an agent to the campaign.

Parameters:

agentName - Name of the agent.

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

assignTeam

void assignTeam(String agentName,
 String teamName)
         throws Exception,
altitude.integrationServer.exceptions.ISException

Assigns an agent to the team.

Parameters:

agentName - Name of the agent.

teamName - Name of the team.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

cleanupAgent

void cleanupAgent(String agentName)
           throws Exception,
altitude.integrationServer.exceptions.ISException

Cleans the agent in the instance if logged as agent.

Parameters:

agentName - Name of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

cleanupSupervisor

void cleanupSupervisor(String agentName)
                throws Exception,
altitude.integrationServer.exceptions.ISException

Cleans the agent in the instance if logged as supervisor.

Parameters:

agentName - Name of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createAgent

int createAgent(AgentCreateRequest request)
         throws Exception,
altitude.integrationServer.exceptions.ISException

Creates an agent.

Parameters:

request - Contains the fields that must be overwritten

Returns:

Identifier of the created agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deAssignCampaign

void deAssignCampaign(String agentName,
 String campaignName)
               throws Exception,
altitude.integrationServer.exceptions.ISException

Deassigns an agent to the campaign.

Parameters:

agentName - Name of the agent.

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deAssignTeam

void deAssignTeam(String agentName,
 String teamName)
           throws Exception,
altitude.integrationServer.exceptions.ISException

Deassigns an agent to the team.

Parameters:

agentName - Name of the agent.

teamName - Name of the team.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteAgent

void deleteAgent(String agentName)
          throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes an agent.

Parameters:

agentName - Name of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteAgentById

void deleteAgentById(int agentId)
              throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes an agent.

Parameters:

agentId - Identifier of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

duplicateAgent

int duplicateAgent(String agentName,
 AgentCreateRequest request)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Duplicates the current agent

Parameters:

agentName - Name of the agent.

request - Contains the fields that must be overwritten

Returns:

Identifier of the duplicated agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

forcedDeAssignCampaign

void forcedDeAssignCampaign(String agentName,
 String campaignName)
                     throws Exception,
altitude.integrationServer.exceptions.ISException

Deassigns an agent to the campaign regardless of the current state of the campaign.

Parameters:

agentName - Name of the agent.

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAgentCursor

IAgentCursor getAgentCursor(int cursorId)
                     throws Exception,
altitude.integrationServer.exceptions.ISException

Gets an agent cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IAgentCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAgentCursors

IAgentCursor[] getAgentCursors()
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the agent cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAgentDataById

AgentData getAgentDataById(int agentId)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the agent data.

Parameters:

agentId - Identifier of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAgentDataByName

AgentData getAgentDataByName(String agentName)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the agent data.

Parameters:

agentName - Name of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAgentTableSchema

TableSchema getAgentTableSchema()
                         throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAssignedCampaigns

CampaignData[] getAssignedCampaigns(String agentName,
 AssignmentMode assignmentMode)
                             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the data of campaigns assigned to the agent.

Parameters:

agentName - Name of the agent.

assignmentMode - Type of mode. If AssignmentMode.NoValue, AssignmentMode.Direct is assumed.

Returns:

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAssignedTeams

TeamData[] getAssignedTeams(String agentName)
                     throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the data of the teams assigned to the agent.

Parameters:

agentName - Name of the agent.

Returns:

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInstance

IInstance getInstance()
               throws Exception,
altitude.integrationServer.exceptions.ISException

The instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPermissions

AgentRolePermission[] getPermissions(String agentName)
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the list of role permissions.

Parameters:

agentName - Name of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

newAgentCursor

IAgentCursor newAgentCursor(String[] columns,
 String sql,
 AgentAssignmentFilter assignmentFilter)
                     throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens an agent cursor.

Parameters:

columns - Columns to fetch.

sql - SQL

assignmentFilter - Assignment filter.

Returns:

The IAgentCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

sendCustomData

void sendCustomData(String agentName,
 byte[] customData)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Sends custom data (blind data) to applications.

Parameters:

agentName - Name of the agent.

customData - Custom data (blind data).

Throws:

Exception

altitude.integrationServer.exceptions.ISException

sendMessage

void sendMessage(String agentName,
 String message)
          throws Exception,
altitude.integrationServer.exceptions.ISException

Sends a message to an agent.

Parameters:

agentName - Name of the agent.

message - The message to send.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetAgentCursor

IAgentCursor tryGetAgentCursor(int cursorId)
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets an agent cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IAgentCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateAgent

void updateAgent(String agentName,
 AgentUpdateRequest request)
          throws Exception,
altitude.integrationServer.exceptions.ISException

Updates an agent.

Parameters:

agentName - Name of the agent.

request - Contains the fields to be updated.

Throws:

Exception

altitude.integrationServer.exceptions.ISException