Interface IService
- All Superinterfaces:
IDisposable, IEntity
Represents a service.
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddToDoNotCallList(String number) Adds the phone number to the do not call list.voidaddToDoNotCallList(String number, String uniqueId, GregorianCalendar expiryDate) Adds an entry in the do not call list.Gets the definition of the activity attributes table.Allowed operations.String[]Gets the names of the ANI lists of the service.Gets the definition of the campaign attributes table.String[]getCampaignNames(boolean onlyAssignedAndRunning) Gets the names of the campaigns of the service.getCampaigns(boolean onlyAssignedAndRunning) Gets the campaigns of the service.intgetContactProfileInProgressWorkflowCount(int directoryId, int contactProfileId, String sql) Gets the count of the contact profile in progress workflow process task.Gets the table schema of the contact profile in progress workflow.intgetContactProfileInteractionHistoryCount(int directoryId, int contactProfileId, String sql) Gets the count of the contact profile interaction history, without the outcomes of each interaction.intgetContactProfileInteractionHistoryCount(int directoryId, int contactProfileId, String sql, boolean countOutcomes) Gets the count of the contact profile interaction history.Gets the table schema of the contact profile interaction history.Gets the default directory.Description of the service.intgetId()Identifier of the service.getInfo()Gets information about the service.The instance associated to the agent.getName()The name of the service.getOutcomes(int scriptSessionId) Gets the outcomes of the specified script session.Gets the table schema of the outcomes.intgetPendingWorkCount(String agentName, String sql, boolean onlyOpenedCampaigns, boolean onlyActivitiesWithAgent) Gets the count of the pending work.Gets the table schema of the pending work.intgetQueuedAgentPickUpTaskCount(String sql, boolean onlyOpenedCampaigns, boolean onlyPickable) Gets the count of the queued agent pick up task.Gets the table schema of the queued agent pick up task.intgetQueuedEmailCount(String sql, boolean onlyOpenedCampaigns, boolean onlyPickable) Gets the count of the queued email.Gets the table schema of the queued email.intgetQueuedSocialCount(String sql, boolean onlyOpenedCampaigns, boolean onlyPickable) Gets the count of the queued social.Gets the table schema of the queued social.intgetSentEmailCount(String sql, boolean onlyOpenedCampaigns) Gets the count of the sent email.Gets the table schema of the sent email.intgetSentSocialCount(String sql, boolean onlyOpenedCampaigns) Gets the count of the sent social.Gets the table schema of the sent social.getState()State of the service.newContactProfileInProgressWorkflowCursor(int directoryId, int contactProfileId, String[] columns, String sql) Opens a contact profile in progress workflow process task cursor.newContactProfileInteractionHistoryCursor(int directoryId, int contactProfileId, String[] columns, String sql, boolean fetchOutcomes) Opens a contact profile interaction history cursor.newPendingWorkCursor(String agentName, String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyActivitiesWithAgent) Opens a pending work cursor.newPendingWorkCursor(String agentName, String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyActivitiesWithAgent, PurposeFilter purposeFilter) Opens a pending work cursor.newQueuedAgentPickUpTaskCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyPickable) Opens a queued agent pick up task cursor.newQueuedAgentPickUpTaskCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyPickable, PurposeFilter purposeFilter) Opens a queued agent pick up task cursor.newQueuedEmailCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyPickable) Opens a queued email cursor.newQueuedEmailCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyPickable, PurposeFilter purposeFilter) Opens a queued email cursor.newQueuedSocialCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyPickable, PurposeFilter purposeFilter) Opens a queued social cursor.newSentEmailCursor(String[] columns, String sql, boolean onlyOpenedCampaigns) Opens a sent email cursor.newSentEmailCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, PurposeFilter purposeFilter) Opens a sent email cursor.newSentSocialCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, PurposeFilter purposeFilter) Opens a sent social cursor.Methods inherited from interface IDisposable
addDisposedListener, removeDisposedListenerMethods inherited from interface IEntity
getUserContext, setUserContext
-
Method Details
-
addToDoNotCallList
-
addToDoNotCallList
void addToDoNotCallList(String number, String uniqueId, GregorianCalendar expiryDate) throws Exception, altitude.integrationServer.exceptions.ISException Adds an entry in the do not call list.- Parameters:
number- The phone number to add. This parameter is optional.uniqueId- Unique identifier of the contact profile. This parameter is optional.expiryDate- Date of the expiration of the do not call list entry. This parameter is optional.The
numberanduniqueIdparameters can not be both unspecified.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getActivityAttributesTableSchema
TableSchema getActivityAttributesTableSchema() throws Exception, altitude.integrationServer.exceptions.ISExceptionGets the definition of the activity attributes table.- Returns:
- An array with the definition of each column of the activity attributes table.
- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getAllowedOperations
ServiceCanDo getAllowedOperations() throws Exception, altitude.integrationServer.exceptions.ISExceptionAllowed operations.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getAniListNames
-
getCampaignAttributesTableSchema
TableSchema getCampaignAttributesTableSchema() throws Exception, altitude.integrationServer.exceptions.ISExceptionGets the definition of the campaign attributes table.- Returns:
- An array with the definition of each column of the campaign attributes table.
- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getCampaignNames
String[] getCampaignNames(boolean onlyAssignedAndRunning) throws Exception, altitude.integrationServer.exceptions.ISException Gets the names of the campaigns of the service.- Parameters:
onlyAssignedAndRunning- If true, only returns the agent assigned and running campaign names. If false, returns all campaign names.- Returns:
- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getCampaigns
ICampaign[] getCampaigns(boolean onlyAssignedAndRunning) throws Exception, altitude.integrationServer.exceptions.ISException Gets the campaigns of the service.- Parameters:
onlyAssignedAndRunning- If true, only returns the agent assigned and running campaigns. If false, returns all campaigns.- Returns:
- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getContactProfileInProgressWorkflowCount
int getContactProfileInProgressWorkflowCount(int directoryId, int contactProfileId, String sql) throws Exception, altitude.integrationServer.exceptions.ISException Gets the count of the contact profile in progress workflow process task.- Parameters:
directoryId- Identifier of the directory.contactProfileId- Identifier of the contact profile.sql- SQL.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getContactProfileInProgressWorkflowTableSchema
TableSchema getContactProfileInProgressWorkflowTableSchema() throws Exception, altitude.integrationServer.exceptions.ISExceptionGets the table schema of the contact profile in progress workflow.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getContactProfileInteractionHistoryCount
int getContactProfileInteractionHistoryCount(int directoryId, int contactProfileId, String sql) throws Exception, altitude.integrationServer.exceptions.ISException Gets the count of the contact profile interaction history, without the outcomes of each interaction.- Parameters:
directoryId- Identifier of the directory.contactProfileId- Identifier of the contact profile.sql- SQL.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getContactProfileInteractionHistoryCount
int getContactProfileInteractionHistoryCount(int directoryId, int contactProfileId, String sql, boolean countOutcomes) throws Exception, altitude.integrationServer.exceptions.ISException Gets the count of the contact profile interaction history.- Parameters:
directoryId- Identifier of the directory.contactProfileId- Identifier of the contact profile.sql- SQL.countOutcomes- If true, counts the outcomes of each interaction. If false, the count does not include the outcomes.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getContactProfileInteractionHistoryTableSchema
TableSchema getContactProfileInteractionHistoryTableSchema() throws Exception, altitude.integrationServer.exceptions.ISExceptionGets the table schema of the contact profile interaction history.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getDefaultDirectory
-
getDescription
-
getId
-
getInfo
Gets information about the service.- Returns:
- The
ServiceInfoobject. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getInstance
-
getName
-
getOutcomes
OutcomeData[] getOutcomes(int scriptSessionId) throws Exception, altitude.integrationServer.exceptions.ISException Gets the outcomes of the specified script session.- Parameters:
scriptSessionId- Identifier of the script session.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getOutcomesTableSchema
TableSchema getOutcomesTableSchema() throws Exception, altitude.integrationServer.exceptions.ISExceptionGets the table schema of the outcomes.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getPendingWorkCount
int getPendingWorkCount(String agentName, String sql, boolean onlyOpenedCampaigns, boolean onlyActivitiesWithAgent) throws Exception, altitude.integrationServer.exceptions.ISException Gets the count of the pending work.- Parameters:
agentName- Name of the agent.sql- SQL.onlyOpenedCampaigns- If true, the cursor only has pending works of campaigns that the agent has open.onlyActivitiesWithAgent- If true, include only activities that have an agent assigned.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getPendingWorkTableSchema
TableSchema getPendingWorkTableSchema() throws Exception, altitude.integrationServer.exceptions.ISExceptionGets the table schema of the pending work.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getQueuedAgentPickUpTaskCount
int getQueuedAgentPickUpTaskCount(String sql, boolean onlyOpenedCampaigns, boolean onlyPickable) throws Exception, altitude.integrationServer.exceptions.ISException Gets the count of the queued agent pick up task.- Parameters:
sql- SQL.onlyOpenedCampaigns- If true, the cursor only has workflow tasks of campaigns that the agent has open.onlyPickable- If true, the cursor only has workflow tasks that the agent can pick up.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getQueuedAgentPickUpTaskTableSchema
TableSchema getQueuedAgentPickUpTaskTableSchema() throws Exception, altitude.integrationServer.exceptions.ISExceptionGets the table schema of the queued agent pick up task.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getQueuedEmailCount
int getQueuedEmailCount(String sql, boolean onlyOpenedCampaigns, boolean onlyPickable) throws Exception, altitude.integrationServer.exceptions.ISException Gets the count of the queued email.- Parameters:
sql- SQL.onlyOpenedCampaigns- If true, the cursor only has emails of campaigns that the agent has open.onlyPickable- If true, the cursor only has emails that the agent can pick up.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getQueuedEmailTableSchema
TableSchema getQueuedEmailTableSchema() throws Exception, altitude.integrationServer.exceptions.ISExceptionGets the table schema of the queued email.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getQueuedSocialCount
int getQueuedSocialCount(String sql, boolean onlyOpenedCampaigns, boolean onlyPickable) throws Exception, altitude.integrationServer.exceptions.ISException Gets the count of the queued social.- Parameters:
sql- SQL.onlyOpenedCampaigns- If true, the cursor only has socials of campaigns that the agent has open.onlyPickable- If true, the cursor only has socials that the agent can pick up.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getQueuedSocialTableSchema
TableSchema getQueuedSocialTableSchema() throws Exception, altitude.integrationServer.exceptions.ISExceptionGets the table schema of the queued social.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getSentEmailCount
int getSentEmailCount(String sql, boolean onlyOpenedCampaigns) throws Exception, altitude.integrationServer.exceptions.ISException Gets the count of the sent email.- Parameters:
sql- SQL.onlyOpenedCampaigns- If true, the cursor only has emails of campaigns that the agent has open.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getSentEmailTableSchema
TableSchema getSentEmailTableSchema() throws Exception, altitude.integrationServer.exceptions.ISExceptionGets the table schema of the sent email.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getSentSocialCount
int getSentSocialCount(String sql, boolean onlyOpenedCampaigns) throws Exception, altitude.integrationServer.exceptions.ISException Gets the count of the sent social.- Parameters:
sql- SQL.onlyOpenedCampaigns- If true, the cursor only has socials of campaigns that the agent has open.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getSentSocialTableSchema
TableSchema getSentSocialTableSchema() throws Exception, altitude.integrationServer.exceptions.ISExceptionGets the table schema of the sent social.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getState
State of the service.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
newContactProfileInProgressWorkflowCursor
IContactProfileInProgressWorkflowCursor newContactProfileInProgressWorkflowCursor(int directoryId, int contactProfileId, String[] columns, String sql) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException Opens a contact profile in progress workflow process task cursor.- Parameters:
directoryId- Identifier of the directory.contactProfileId- Identifier of the contact profile.columns- Columns to fetch.sql- SQL.- Returns:
- The
IContactProfileInProgressWorkflowCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISExceptionaltitude.integrationServer.exceptions.ISSqlException
-
newContactProfileInteractionHistoryCursor
IContactProfileInteractionHistoryCursor newContactProfileInteractionHistoryCursor(int directoryId, int contactProfileId, String[] columns, String sql, boolean fetchOutcomes) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException Opens a contact profile interaction history cursor.- Parameters:
directoryId- Identifier of the directory.contactProfileId- Identifier of the contact profile.columns- Columns to fetch.sql- SQL.fetchOutcomes- If true, the outcomes of each interaction are also fetched from the database. If false, the fetchedInteractionThreadScriptSession.Outcomeis null.- Returns:
- The
IContactProfileInteractionHistoryCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISExceptionaltitude.integrationServer.exceptions.ISSqlException
-
newPendingWorkCursor
IPendingWorkCursor newPendingWorkCursor(String agentName, String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyActivitiesWithAgent) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException Opens a pending work cursor.- Parameters:
agentName- Name of the agent.columns- Columns to fetch.sql- SQL.onlyOpenedCampaigns- If true, the cursor only has pending works of campaigns that the agent has open.onlyActivitiesWithAgent- If true, include only activities that have an agent assigned.- Returns:
- The
IPendingWorkCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISExceptionaltitude.integrationServer.exceptions.ISSqlException
-
newPendingWorkCursor
IPendingWorkCursor newPendingWorkCursor(String agentName, String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyActivitiesWithAgent, PurposeFilter purposeFilter) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException Opens a pending work cursor.- Parameters:
agentName- Name of the agent.columns- Columns to fetch.sql- SQL.onlyOpenedCampaigns- If true, the cursor only has pending works of campaigns that the agent has open.onlyActivitiesWithAgent- If true, include only activities that have an agent assigned.purposeFilter- Purpose filter.- Returns:
- The
IPendingWorkCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISExceptionaltitude.integrationServer.exceptions.ISSqlException
-
newQueuedAgentPickUpTaskCursor
IQueuedAgentPickUpTaskCursor newQueuedAgentPickUpTaskCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyPickable) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException Opens a queued agent pick up task cursor.- Parameters:
columns- Columns to fetch.sql- SQL.onlyOpenedCampaigns- If true, the cursor only has workflow tasks of campaigns that the agent has open.onlyPickable- If true, the cursor only has workflow tasks that the agent can pick up.- Returns:
- The
IQueuedAgentPickUpTaskCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISExceptionaltitude.integrationServer.exceptions.ISSqlException
-
newQueuedAgentPickUpTaskCursor
IQueuedAgentPickUpTaskCursor newQueuedAgentPickUpTaskCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyPickable, PurposeFilter purposeFilter) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException Opens a queued agent pick up task cursor.- Parameters:
columns- Columns to fetch.sql- SQL.onlyOpenedCampaigns- If true, the cursor only has workflow tasks of campaigns that the agent has open.onlyPickable- If true, the cursor only has workflow tasks that the agent can pick up.purposeFilter- Purpose filter.- Returns:
- The
IQueuedAgentPickUpTaskCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISExceptionaltitude.integrationServer.exceptions.ISSqlException
-
newQueuedEmailCursor
IQueuedEmailCursor newQueuedEmailCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyPickable) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException Opens a queued email cursor.- Parameters:
columns- Columns to fetch.sql- SQL.onlyOpenedCampaigns- If true, the cursor only has emails of campaigns that the agent has open.onlyPickable- If true, the cursor only has emails that the agent can pick up.- Returns:
- The
IQueuedEmailCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISExceptionaltitude.integrationServer.exceptions.ISSqlException
-
newQueuedEmailCursor
IQueuedEmailCursor newQueuedEmailCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyPickable, PurposeFilter purposeFilter) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException Opens a queued email cursor.- Parameters:
columns- Columns to fetch.sql- SQL.onlyOpenedCampaigns- If true, the cursor only has emails of campaigns that the agent has open.onlyPickable- If true, the cursor only has emails that the agent can pick up.purposeFilter- Purpose filter.- Returns:
- The
IQueuedEmailCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISExceptionaltitude.integrationServer.exceptions.ISSqlException
-
newQueuedSocialCursor
IQueuedSocialCursor newQueuedSocialCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyPickable, PurposeFilter purposeFilter) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException Opens a queued social cursor.- Parameters:
columns- Columns to fetch.sql- SQL.onlyOpenedCampaigns- If true, the cursor only has socials of campaigns that the agent has open.onlyPickable- If true, the cursor only has socials that the agent can pick up.purposeFilter- Purpose filter.- Returns:
- The
IQueuedSocialCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISExceptionaltitude.integrationServer.exceptions.ISSqlException
-
newSentEmailCursor
ISentEmailCursor newSentEmailCursor(String[] columns, String sql, boolean onlyOpenedCampaigns) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException Opens a sent email cursor.- Parameters:
columns- Columns to fetch.sql- SQL.onlyOpenedCampaigns- If true, the cursor only has emails of campaigns that the agent has open.- Returns:
- The
ISentEmailCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISExceptionaltitude.integrationServer.exceptions.ISSqlException
-
newSentEmailCursor
ISentEmailCursor newSentEmailCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, PurposeFilter purposeFilter) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException Opens a sent email cursor.- Parameters:
columns- Columns to fetch.sql- SQL.onlyOpenedCampaigns- If true, the cursor only has emails of campaigns that the agent has open.purposeFilter- Purpose filter.- Returns:
- The
ISentEmailCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISExceptionaltitude.integrationServer.exceptions.ISSqlException
-
newSentSocialCursor
ISentSocialCursor newSentSocialCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, PurposeFilter purposeFilter) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException Opens a sent social cursor.- Parameters:
columns- Columns to fetch.sql- SQL.onlyOpenedCampaigns- If true, the cursor only has socials of campaigns that the agent has open.purposeFilter- Purpose filter.- Returns:
- The
ISentSocialCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISExceptionaltitude.integrationServer.exceptions.ISSqlException
-