Interface IAgentInCampaign

All Superinterfaces:

IDisposable, IEntity

public interface IAgentInCampaign
extends IEntity

Represents the operations performed by an agent in a campaign.

Method Summary

Modifier and Type	Method	Description
void	addAgentInCampaignCannotOpenListener(AgentInCampaignCannotOpenListener listener)	Registers the AgentInCampaignCannotOpenListener.
void	addAgentInCampaignErrorListener(AgentInCampaignErrorListener listener)	Registers the AgentInCampaignErrorListener.
void	addAgentInCampaignOperationListener(AgentInCampaignOperationListener listener)	Registers the AgentInCampaignOperationListener.
void	addAgentInCampaignRequestListener(AgentInCampaignRequestListener listener)	Registers the AgentInCampaignRequestListener.
void	addCampaignMessageListener(CampaignMessageListener listener)	Registers the CampaignMessageListener.
void	addCampaignStateChangedListener(CampaignStateChangedListener listener)	Registers the CampaignStateChangedListener.
void	addScriptChangedListener(ScriptChangedListener listener)	Registers the ScriptChangedListener.
void	changeNotReadyReason(String reason)	Changes the agent not ready reason in the campaign.
void	close()	Closes the campaign of the agent.
IAgent	getAgent()	Associated agent.
AgentInCampaignCanDo	getAllowedOperations()	Operations that the agent can perform in the campaign.
ICampaign	getCampaign()	Associated campaign.
boolean	getHasValidSwitch()	True if the campaign has a valid switch.
AgentInCampaignInfo	getInfo()	Gets information about the state of the agent in the campaign.
AgentInCampaignMediaInfo	getInfoMedia(int mediaId)	Gets information about the media state of the agent in the campaign.
boolean	getIsOpen()	True if the agent has the campaign open.
boolean	getIsReady()	True if the agent is ready in the campaign.
boolean	getIsRequestRunning()	True if the campaign has a request running.
boolean	getIsSignedOn()	True if the agent is signed in to the campaign.
String	getNotReadyReasonGuiName()	Gui name of the not ready reason.
String	getNotReadyReasonName()	Name of the not ready reason.
int	getNumberOfDataTransactions()	Number of current data transactions.
void	open()	Opens the campaign of the agent.
void	removeAgentInCampaignCannotOpenListener(AgentInCampaignCannotOpenListener listener)	Unregisters the AgentInCampaignCannotOpenListener.
void	removeAgentInCampaignErrorListener(AgentInCampaignErrorListener listener)	Unregisters the AgentInCampaignErrorListener.
void	removeAgentInCampaignOperationListener(AgentInCampaignOperationListener listener)	Unregisters the AgentInCampaignOperationListener.
void	removeAgentInCampaignRequestListener(AgentInCampaignRequestListener listener)	Unregisters the AgentInCampaignRequestListener.
void	removeCampaignMessageListener(CampaignMessageListener listener)	Unregisters the CampaignMessageListener.
void	removeCampaignStateChangedListener(CampaignStateChangedListener listener)	Unregisters the CampaignStateChangedListener.
void	removeScriptChangedListener(ScriptChangedListener listener)	Unregisters the ScriptChangedListener.
void	setNotReady(String reason)	Sets the agent not ready in the campaign.
void	setReady(boolean synchronous)	Sets the agent ready in the open campaign.
void	signOff(boolean synchronous)	Signs off the agent from the campaign.
void	signOn(boolean synchronous)	Signs in the agent in the campaign.
ISession	startDataTransaction()	Starts a data transaction.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

addAgentInCampaignCannotOpenListener

void addAgentInCampaignCannotOpenListener(AgentInCampaignCannotOpenListener listener)

Registers the AgentInCampaignCannotOpenListener.

Parameters:

listener - Event listener to add.

removeAgentInCampaignCannotOpenListener

void removeAgentInCampaignCannotOpenListener(AgentInCampaignCannotOpenListener listener)

Unregisters the AgentInCampaignCannotOpenListener.

Parameters:

listener - Event listener to remove.

addAgentInCampaignErrorListener

void addAgentInCampaignErrorListener(AgentInCampaignErrorListener listener)

Registers the AgentInCampaignErrorListener.

Parameters:

listener - Event listener to add.

removeAgentInCampaignErrorListener

void removeAgentInCampaignErrorListener(AgentInCampaignErrorListener listener)

Unregisters the AgentInCampaignErrorListener.

Parameters:

listener - Event listener to remove.

addAgentInCampaignOperationListener

void addAgentInCampaignOperationListener(AgentInCampaignOperationListener listener)

Registers the AgentInCampaignOperationListener.

Parameters:

listener - Event listener to add.

removeAgentInCampaignOperationListener

void removeAgentInCampaignOperationListener(AgentInCampaignOperationListener listener)

Unregisters the AgentInCampaignOperationListener.

Parameters:

listener - Event listener to remove.

addAgentInCampaignRequestListener

void addAgentInCampaignRequestListener(AgentInCampaignRequestListener listener)

Registers the AgentInCampaignRequestListener.

Parameters:

listener - Event listener to add.

removeAgentInCampaignRequestListener

void removeAgentInCampaignRequestListener(AgentInCampaignRequestListener listener)

Unregisters the AgentInCampaignRequestListener.

Parameters:

listener - Event listener to remove.

addCampaignMessageListener

void addCampaignMessageListener(CampaignMessageListener listener)

Registers the CampaignMessageListener.

Parameters:

listener - Event listener to add.

removeCampaignMessageListener

void removeCampaignMessageListener(CampaignMessageListener listener)

Unregisters the CampaignMessageListener.

Parameters:

listener - Event listener to remove.

addCampaignStateChangedListener

void addCampaignStateChangedListener(CampaignStateChangedListener listener)

Registers the CampaignStateChangedListener.

Parameters:

listener - Event listener to add.

removeCampaignStateChangedListener

void removeCampaignStateChangedListener(CampaignStateChangedListener listener)

Unregisters the CampaignStateChangedListener.

Parameters:

listener - Event listener to remove.

addScriptChangedListener

void addScriptChangedListener(ScriptChangedListener listener)

Registers the ScriptChangedListener.

Parameters:

listener - Event listener to add.

removeScriptChangedListener

void removeScriptChangedListener(ScriptChangedListener listener)

Unregisters the ScriptChangedListener.

Parameters:

listener - Event listener to remove.

changeNotReadyReason

void changeNotReadyReason(String reason)
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Changes the agent not ready reason in the campaign.

Parameters:

reason - String with the not ready reason to send to the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

close

void close()
    throws Exception,
altitude.integrationServer.exceptions.ISException

Closes the campaign of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAgent

IAgent getAgent()
         throws Exception,
altitude.integrationServer.exceptions.ISException

Associated agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAllowedOperations

AgentInCampaignCanDo getAllowedOperations()
                                   throws Exception,
altitude.integrationServer.exceptions.ISException

Operations that the agent can perform in the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCampaign

ICampaign getCampaign()
               throws Exception,
altitude.integrationServer.exceptions.ISException

Associated campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getHasValidSwitch

boolean getHasValidSwitch()
                   throws Exception,
altitude.integrationServer.exceptions.ISException

True if the campaign has a valid switch.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInfo

AgentInCampaignInfo getInfo()
                     throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the state of the agent in the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInfoMedia

AgentInCampaignMediaInfo getInfoMedia(int mediaId)
                               throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the media state of the agent in the campaign.

Parameters:

mediaId - Identifier of the media.

Returns:

An AgentInCampaignMediaInfo object.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getIsOpen

boolean getIsOpen()
           throws Exception,
altitude.integrationServer.exceptions.ISException

True if the agent has the campaign open.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getIsReady

boolean getIsReady()
            throws Exception,
altitude.integrationServer.exceptions.ISException

True if the agent is ready in the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getIsRequestRunning

boolean getIsRequestRunning()
                     throws Exception,
altitude.integrationServer.exceptions.ISException

True if the campaign has a request running.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getIsSignedOn

boolean getIsSignedOn()
               throws Exception,
altitude.integrationServer.exceptions.ISException

True if the agent is signed in to the campaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getNotReadyReasonGuiName

String getNotReadyReasonGuiName()
                         throws Exception,
altitude.integrationServer.exceptions.ISException

Gui name of the not ready reason.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getNotReadyReasonName

String getNotReadyReasonName()
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Name of the not ready reason.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getNumberOfDataTransactions

int getNumberOfDataTransactions()
                         throws Exception,
altitude.integrationServer.exceptions.ISException

Number of current data transactions.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

open

void open()
   throws Exception,
altitude.integrationServer.exceptions.ISException

Opens the campaign of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setNotReady

void setNotReady(String reason)
          throws Exception,
altitude.integrationServer.exceptions.ISException

Sets the agent not ready in the campaign.

Parameters:

reason - String with the not ready reason to send to the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setReady

void setReady(boolean synchronous)
       throws Exception,
altitude.integrationServer.exceptions.ISException

Sets the agent ready in the open campaign.

Parameters:

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

signOff

void signOff(boolean synchronous)
      throws Exception,
altitude.integrationServer.exceptions.ISException

Signs off the agent from the campaign.

Parameters:

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

signOn

void signOn(boolean synchronous)
     throws Exception,
altitude.integrationServer.exceptions.ISException

Signs in the agent in the campaign.

Parameters:

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

startDataTransaction

ISession startDataTransaction()
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Starts a data transaction.

Returns:

The ISession object associated with the data transaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException