Interface ITeamManager

All Superinterfaces:

IDisposable, IEntity

public interface ITeamManager
extends IEntity

Manages the teams.

Method Summary

Modifier and Type	Method	Description
void	assignAgent(String teamName, String agentName)	Assigns an agent to the team.
void	assignCampaign(String teamName, String campaignName)	Assigns a campaign to the team.
int	createTeam(TeamCreateRequest request)	Creates a team.
void	deAssignAgent(String teamName, String agentName)	Deassigns an agent to the team.
void	deAssignCampaign(String teamName, String campaignName)	Deassigns a campaign to the team.
void	deleteTeam(String teamName)	Deletes a team.
void	forcedDeAssignCampaign(String teamName, String campaignName)	Deassigns a campaign to the team regardless of the current state of the campaign.
AgentData[]	getAssignedAgents(String teamName)	Gets the data of the agents assigned to the team.
CampaignData[]	getAssignedCampaigns(String teamName)	Gets the data of campaigns assigned to the team.
IInstance	getInstance()	The instance.
TeamRolePermission[]	getPermissions(String teamName)	Gets the list of role permissions.
ITeamCursor	getTeamCursor(int cursorId)	Gets a team cursor open in the instance.
ITeamCursor[]	getTeamCursors()	Returns the team cursors open in the instance.
TeamData	getTeamDataById(int teamId)	Gets the team data.
TeamData	getTeamDataByName(String teamName)	Gets the team data.
String[]	getTeamNames()	Retrieves the list of team names.
TableSchema	getTeamTableSchema()	Gets the table schema of the team.
ITeamCursor	newTeamCursor(String[] columns, String sql, TeamAssignmentFilter assignmentFilter)	Opens a team cursor.
void	sendMessage(String teamName, String message)	Sends a message to a team.
ITeamCursor	tryGetTeamCursor(int cursorId)	Gets a team cursor open in the instance or null if it doesn't exist.
void	updateTeam(String teamName, TeamUpdateRequest request)	Updates a team.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

assignAgent

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

Assigns an agent to the team.

Parameters:

teamName - Name of the team.

agentName - Name of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

assignCampaign

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

Assigns a campaign to the team.

Parameters:

teamName - Name of the team.

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createTeam

int createTeam(TeamCreateRequest request)
        throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a team.

Parameters:

request - Contains the fields that must be overwritten

Returns:

Identifier of the created team.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deAssignAgent

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

Deassigns an agent to the team.

Parameters:

teamName - Name of the team.

agentName - Name of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deAssignCampaign

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

Deassigns a campaign to the team.

Parameters:

teamName - Name of the team.

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteTeam

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

Deletes a team.

Parameters:

teamName - Name of the team.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

forcedDeAssignCampaign

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

Deassigns a campaign to the team regardless of the current state of the campaign.

Parameters:

teamName - Name of the team.

campaignName - Name of the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAssignedAgents

AgentData[] getAssignedAgents(String teamName)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the data of the agents assigned to the team.

Parameters:

teamName - Name of the team.

Returns:

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAssignedCampaigns

CampaignData[] getAssignedCampaigns(String teamName)
                             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the data of campaigns assigned to the team.

Parameters:

teamName - Name of the team.

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

TeamRolePermission[] getPermissions(String teamName)
                             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the list of role permissions.

Parameters:

teamName - Name of the team.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getTeamCursor

ITeamCursor getTeamCursor(int cursorId)
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a team cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The ITeamCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getTeamCursors

ITeamCursor[] getTeamCursors()
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the team cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getTeamDataById

TeamData getTeamDataById(int teamId)
                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the team data.

Parameters:

teamId - Identifier of the team.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getTeamDataByName

TeamData getTeamDataByName(String teamName)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the team data.

Parameters:

teamName - Name of the team.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getTeamNames

String[] getTeamNames()
               throws Exception,
altitude.integrationServer.exceptions.ISException

Retrieves the list of team names.

Returns:

An array with the names of the teams.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getTeamTableSchema

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

Gets the table schema of the team.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

newTeamCursor

ITeamCursor newTeamCursor(String[] columns,
 String sql,
 TeamAssignmentFilter assignmentFilter)
                   throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a team cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

assignmentFilter - Assignment filter.

Returns:

The ITeamCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

sendMessage

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

Sends a message to a team.

Parameters:

teamName - Name of the team.

message - The message to send.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetTeamCursor

ITeamCursor tryGetTeamCursor(int cursorId)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a team cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The ITeamCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateTeam

void updateTeam(String teamName,
 TeamUpdateRequest request)
         throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a team.

Parameters:

teamName - Name of the team.

request - Contains the fields to be updated.

Throws:

Exception

altitude.integrationServer.exceptions.ISException