atg.agent.events
Class AgentMessagingTools

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.agent.events.AgentMessagingTools
All Implemented Interfaces:
atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class AgentMessagingTools
extends GenericService

The class contains the configurations and utility methods for creating and sending agent events.


Field Summary
static java.lang.String CHANGE_PASSWORD_TYPE
          Agent Activity Type for a ProfilePasswordChanged
static java.lang.String CLASS_VERSION
          Class version string
static java.lang.String END_CALL_TYPE
          Agent Activity Type for an end call
protected  AgentTools mAgentTools
           
static java.lang.String NEW_CALL_TYPE
          Agent Activity Type for a new call
static java.lang.String ORGANIZATION_CREATED_TYPE
          Agent Activity Type for a OrganizationCreated
static java.lang.String PROFILE_ADDED_TO_ORG_TYPE
          Agent Activity Type for a ProfileAddedToOrg
static java.lang.String PROFILE_CREATED_TYPE
          Agent Activity Type for a Profile Create
static java.lang.String PROFILE_REMOVED_FROM_ORG_TYPE
          Agent Activity Type for a ProfileRemovedFromOrg
static java.lang.String PROFILE_UPDATED_TYPE
          Agent Activity Type for a Profile Update
static java.lang.String PROFILE_VIEWED_TYPE
          Agent Activity Type for a Profile View
static java.lang.String SESSIONEND_TYPE
          Agent Activity Type for a SessionEnd
 
Fields inherited from class atg.nucleus.GenericService
SERVICE_INFO_KEY
 
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging
DEFAULT_LOG_TRACE_STATUS
 
Fields inherited from interface atg.nucleus.logging.ApplicationLogging
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
 
Constructor Summary
AgentMessagingTools()
           
 
Method Summary
 AgentEvent createAgentEvent(java.lang.String pActivityType, java.lang.String pCustomerProfileId)
          Creates a new AgentEvent with the given customer profile ID
 AgentEvent createAgentEvent(java.lang.String pActivityType, java.lang.String pCustomerProfileId, java.lang.String pTicketId)
          Creates a new AgentEvent with the given customer profile ID
 CallEvent createCallEvent(java.lang.String pActivityType, java.lang.String pCustomerProfileId, java.lang.String pCallId, java.util.Date pStartTime, java.util.Date pEndTime)
          Creates a new CallEvent
 CallEvent createCallEvent(java.lang.String pActivityType, java.lang.String pCustomerProfileId, java.lang.String pTicketId, java.lang.String pCallId, java.util.Date pStartTime, java.util.Date pEndTime)
          Creates a new CallEvent
 ItemUpdateAgentEvent createItemUpdateAgentEvent(java.lang.String pActivityType, RepositoryItem pUpdatedRepositoryItem, java.lang.String pCustomerProfileId, java.util.Collection pPropertyUpdates, java.lang.String pTicketId)
          Creates a ItemUpdateAgentEvent.
 AgentEvent createProfileViewedAgentEvent(java.lang.String pViewedCustomerProfileId)
          Creates a profile viewed agent event.
 AgentEvent createProfileViewedAgentEvent(java.lang.String pActivityType, java.lang.String pViewedCustomerProfileId)
          Creates a profile viewed agent event.
 ItemUpdateAgentEvent generateAgentEventForItemUpdate(RepositoryItem pUpdatedItem, RepositoryItem pCustomerProfile, java.lang.String pActivityType, java.util.Dictionary pNewValues, java.lang.String pTicketId)
          Generates an agent event for the updates in the values dictionary.
 AgentMessageSource getAgentMessageSource()
           
 AgentTools getAgentTools()
           
 java.lang.String getChangePasswordJMSType()
           
 java.lang.String getCreateProfileJMSType()
           
 java.lang.String getEndCallJMSType()
           
 java.lang.String getNewCallJMSType()
           
 java.lang.String getOrganizationCreatedJMSType()
           
 java.lang.String getProfileAddedToOrgJMSType()
           
 java.lang.String getProfileRemovedFromOrgJMSType()
           
 ProfileTools getProfileTools()
          The ProfileTools component
 java.lang.String getSessionEndJMSType()
           
 java.lang.String getUpdateOrganizationJMSType()
           
 java.lang.String getUpdateProfileJMSType()
           
 java.lang.String getViewProfileJMSType()
           
 void sendChangePasswordEvent(java.lang.String pProfileId, java.lang.String pTicketId)
          Sends the ChangePassword event using the JMSType defined by the changePasswordJMSType property.
 void sendChangePasswordEvent(java.lang.String pProfileId, java.lang.String pTicketId, java.lang.String pPortName)
          Sends the ChangePassword event using the JMSType defined by the changePasswordJMSType property.
 void sendCreateProfileEvent(java.lang.String pNewProfileId, java.lang.String pTicketId)
          Sends the CreateProfile event using the JMSType defined by the createProfileJMSType property.
 void sendCreateProfileEvent(java.lang.String pNewProfileId, java.lang.String pTicketId, java.lang.String pPortName)
          Sends the CreateProfile event using the JMSType defined by the createProfileJMSType property.
 void sendEndCallEvent(java.lang.String pCustomerProfileId, java.lang.String pCallId, java.util.Date pStartTime, java.util.Date pEndTime)
          Sends the EndCall event using the JMSType defined by the endCallJMSType property.
 void sendEndCallEvent(java.lang.String pCustomerProfileId, java.lang.String pPortName, java.lang.String pCallId, java.util.Date pStartTime, java.util.Date pEndTime)
          Sends the EndCall event using the JMSType defined by the endCallJMSType property.
 void sendItemUpdateAgentEvent(ItemUpdateAgentEvent pEvent, java.lang.String pJMSType)
           
 void sendItemUpdateAgentEvent(ItemUpdateAgentEvent pEvent, java.lang.String pJMSType, java.lang.String pPortName)
          Sends a ItemUpdateAgentEvent to the specified port.
 void sendNewCallEvent(java.lang.String pCustomerProfileId, java.lang.String pCallId, java.util.Date pStartTime, java.util.Date pEndTime)
          Sends the NewCall event using the JMSType defined by the newCallJMSType property.
 void sendNewCallEvent(java.lang.String pCustomerProfileId, java.lang.String pPortName, java.lang.String pCallId, java.util.Date pStartTime, java.util.Date pEndTime)
          Sends the NewCall event using the JMSType defined by the newCallJMSType property.
 void sendOrganizationCreatedEvent(java.lang.String pNewOrganizationId, java.lang.String pTicketId)
          Sends the OrganizationCreated event using the JMSType defined by the organizationCreatedJMSType property.
 void sendOrganizationCreatedEvent(java.lang.String pNewOrganizationId, java.lang.String pTicketId, java.lang.String pPortName)
          Sends the OrganizationCreated event using the JMSType defined by the organizationCreatedJMSType property.
 void sendProfileAddedToOrgEvent(java.lang.String pAddedProfileId, java.lang.String pOrganizationId, java.lang.String pTicketId, java.lang.String pPortName)
          Sends an event that indicates a profile was added to an organization.
 void sendProfileRemovedFromOrgEvent(java.lang.String pRemovedProfileId, java.lang.String pOrganizationId, java.lang.String pTicketId, java.lang.String pPortName)
          Sends an event that indicates a profile was removed from an organization.
 void sendSessionEndEvent(java.lang.String pAgentProfileId, java.lang.String pParentOrganizationId, java.lang.String pSessionId, long pSessionCreateTime, long pSessionDuration)
          Sends agent session end event
 void sendSessionEndEvent(java.lang.String pAgentProfileId, java.lang.String pParentOrganizationId, java.lang.String pSessionId, long pSessionCreateTime, long pSessionDuration, java.lang.String pPortName)
          Sends agent session end event
 void sendViewProfileEvent(java.lang.String pCustomerProfileId)
          Sends the ViewProfile event using the JMSType defined by the viewProfileJMSType property.
 void sendViewProfileEvent(java.lang.String pCustomerProfileId, java.lang.String pPortName)
          Sends the ViewProfile event using the JMSType defined by the viewProfileJMSType property.
 void setAgentMessageSource(AgentMessageSource pAgentMessageSource)
          The component used to send agent event messages
 void setAgentTools(AgentTools pCSRAgentTools)
          Sets the property AgentTools.
 void setChangePasswordJMSType(java.lang.String pChangePasswordJMSType)
          Sets the JMS Type used for the change password event
 void setCreateProfileJMSType(java.lang.String pCreateProfileJMSType)
          Sets the JMS Type used for the create profile event
 void setEndCallJMSType(java.lang.String pEndCallJMSType)
          Sets the JMS Type used for the end call event
 void setNewCallJMSType(java.lang.String pNewCallJMSType)
          Sets the JMS Type used for the new call event
 void setOrganizationCreatedJMSType(java.lang.String pOrganizationCreatedJMSType)
          Sets the JMS Type used for the create organization event
 void setProfileAddedToOrgJMSType(java.lang.String pProfileAddedToOrgJMSType)
          Sets the JMS Type used when added a profile to an organization
 void setProfileRemovedFromOrgJMSType(java.lang.String pProfileRemovedFromOrgJMSType)
          Sets the JMS Type used when removing a profile from an organization
 void setProfileTools(ProfileTools pProfileTools)
          Sets the ProfileTools component
 void setSessionEndJMSType(java.lang.String pSessionEndJMSType)
           
 void setUpdateOrganizationJMSType(java.lang.String pUpdateOrganizationJMSType)
          Sets the JMS Type used for the edit organization event
 void setUpdateProfileJMSType(java.lang.String pUpdateProfileJMSType)
          Sets the JMS Type used for the edit profile event
 void setViewProfileJMSType(java.lang.String pViewProfileJMSType)
          Sets the JMS Type used for the view profile event
 
Methods inherited from class atg.nucleus.GenericService
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
 
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION
Class version string

See Also:
Constant Field Values

NEW_CALL_TYPE

public static final java.lang.String NEW_CALL_TYPE
Agent Activity Type for a new call

See Also:
Constant Field Values

END_CALL_TYPE

public static final java.lang.String END_CALL_TYPE
Agent Activity Type for an end call

See Also:
Constant Field Values

PROFILE_UPDATED_TYPE

public static final java.lang.String PROFILE_UPDATED_TYPE
Agent Activity Type for a Profile Update

See Also:
Constant Field Values

PROFILE_CREATED_TYPE

public static final java.lang.String PROFILE_CREATED_TYPE
Agent Activity Type for a Profile Create

See Also:
Constant Field Values

PROFILE_VIEWED_TYPE

public static final java.lang.String PROFILE_VIEWED_TYPE
Agent Activity Type for a Profile View

See Also:
Constant Field Values

PROFILE_REMOVED_FROM_ORG_TYPE

public static final java.lang.String PROFILE_REMOVED_FROM_ORG_TYPE
Agent Activity Type for a ProfileRemovedFromOrg

See Also:
Constant Field Values

PROFILE_ADDED_TO_ORG_TYPE

public static final java.lang.String PROFILE_ADDED_TO_ORG_TYPE
Agent Activity Type for a ProfileAddedToOrg

See Also:
Constant Field Values

CHANGE_PASSWORD_TYPE

public static final java.lang.String CHANGE_PASSWORD_TYPE
Agent Activity Type for a ProfilePasswordChanged

See Also:
Constant Field Values

SESSIONEND_TYPE

public static final java.lang.String SESSIONEND_TYPE
Agent Activity Type for a SessionEnd

See Also:
Constant Field Values

ORGANIZATION_CREATED_TYPE

public static final java.lang.String ORGANIZATION_CREATED_TYPE
Agent Activity Type for a OrganizationCreated

See Also:
Constant Field Values

mAgentTools

protected AgentTools mAgentTools
Constructor Detail

AgentMessagingTools

public AgentMessagingTools()
Method Detail

setAgentTools

public void setAgentTools(AgentTools pCSRAgentTools)
Sets the property AgentTools.


getAgentTools

public AgentTools getAgentTools()
Returns:
The AgentTools component

setProfileTools

public void setProfileTools(ProfileTools pProfileTools)
Sets the ProfileTools component

Parameters:
pProfileTools - the ProfileTools component

getProfileTools

public ProfileTools getProfileTools()
The ProfileTools component

Returns:
the ProfileTools component

setAgentMessageSource

public void setAgentMessageSource(AgentMessageSource pAgentMessageSource)
The component used to send agent event messages

Parameters:
pAgentMessageSource - the component used to send agent event messages

getAgentMessageSource

public AgentMessageSource getAgentMessageSource()

getSessionEndJMSType

public java.lang.String getSessionEndJMSType()
Returns:
Returns the sessionEndJMSType.

setSessionEndJMSType

public void setSessionEndJMSType(java.lang.String pSessionEndJMSType)
Parameters:
pSessionEndJMSType - The sessionEndJMSType to set.

setChangePasswordJMSType

public void setChangePasswordJMSType(java.lang.String pChangePasswordJMSType)
Sets the JMS Type used for the change password event

Parameters:
pChangePasswordJMSType - the JMS Type used for the change password event

getChangePasswordJMSType

public java.lang.String getChangePasswordJMSType()
Returns:
the JMS Type used for the change password event

setCreateProfileJMSType

public void setCreateProfileJMSType(java.lang.String pCreateProfileJMSType)
Sets the JMS Type used for the create profile event

Parameters:
pCreateProfileJMSType - the JMS Type used for the create profile event

getCreateProfileJMSType

public java.lang.String getCreateProfileJMSType()
Returns:
the JMS Type used for the create profile event

setOrganizationCreatedJMSType

public void setOrganizationCreatedJMSType(java.lang.String pOrganizationCreatedJMSType)
Sets the JMS Type used for the create organization event

Parameters:
pOrganizationCreatedJMSType - the JMS Type used for the create organization event

getOrganizationCreatedJMSType

public java.lang.String getOrganizationCreatedJMSType()
Returns:
the JMS Type used for the create organization event

setProfileRemovedFromOrgJMSType

public void setProfileRemovedFromOrgJMSType(java.lang.String pProfileRemovedFromOrgJMSType)
Sets the JMS Type used when removing a profile from an organization

Parameters:
pProfileRemovedFromOrgJMSType - the JMS Type used when removing a profile from an organization

getProfileRemovedFromOrgJMSType

public java.lang.String getProfileRemovedFromOrgJMSType()
Returns:
the JMS Type used when removing a profile from an organization

setProfileAddedToOrgJMSType

public void setProfileAddedToOrgJMSType(java.lang.String pProfileAddedToOrgJMSType)
Sets the JMS Type used when added a profile to an organization

Parameters:
pProfileAddedToOrgJMSType - the JMS Type used when added a profile to an organization

getProfileAddedToOrgJMSType

public java.lang.String getProfileAddedToOrgJMSType()
Returns:
the JMS Type used when added a profile to an organization

setUpdateProfileJMSType

public void setUpdateProfileJMSType(java.lang.String pUpdateProfileJMSType)
Sets the JMS Type used for the edit profile event

Parameters:
pUpdateProfileJMSType - the JMS Type used for the edit profile event

getUpdateProfileJMSType

public java.lang.String getUpdateProfileJMSType()
Returns:
the JMS Type used for the edit profile event

setUpdateOrganizationJMSType

public void setUpdateOrganizationJMSType(java.lang.String pUpdateOrganizationJMSType)
Sets the JMS Type used for the edit organization event

Parameters:
pUpdateOrganizationJMSType - the JMS Type used for the edit organization event

getUpdateOrganizationJMSType

public java.lang.String getUpdateOrganizationJMSType()
Returns:
the JMS Type used for the edit organization event

setNewCallJMSType

public void setNewCallJMSType(java.lang.String pNewCallJMSType)
Sets the JMS Type used for the new call event

Parameters:
pNewCallJMSType - the JMS Type used for the new call event

getNewCallJMSType

public java.lang.String getNewCallJMSType()
Returns:
the JMS Type used for the new call event

setEndCallJMSType

public void setEndCallJMSType(java.lang.String pEndCallJMSType)
Sets the JMS Type used for the end call event

Parameters:
pEndCallJMSType - the JMS Type used for the end call event

getEndCallJMSType

public java.lang.String getEndCallJMSType()
Returns:
the JMS Type used for the end call event

setViewProfileJMSType

public void setViewProfileJMSType(java.lang.String pViewProfileJMSType)
Sets the JMS Type used for the view profile event

Parameters:
pViewProfileJMSType - the JMS Type used for the view profile event

getViewProfileJMSType

public java.lang.String getViewProfileJMSType()
Returns:
the JMS Type used for the view profile event

createAgentEvent

public AgentEvent createAgentEvent(java.lang.String pActivityType,
                                   java.lang.String pCustomerProfileId)
Creates a new AgentEvent with the given customer profile ID

Parameters:
pActivityType - the event activity type.
pCustomerProfileId - the customer profile id to associate with the event.
Returns:
a new AgentEvent

createAgentEvent

public AgentEvent createAgentEvent(java.lang.String pActivityType,
                                   java.lang.String pCustomerProfileId,
                                   java.lang.String pTicketId)
Creates a new AgentEvent with the given customer profile ID

Parameters:
pActivityType - the event activity type.
pCustomerProfileId - the customer profile id to associate with the event.
pTicketId - the ticket id associated with the event
Returns:
a new AgentEvent

createCallEvent

public CallEvent createCallEvent(java.lang.String pActivityType,
                                 java.lang.String pCustomerProfileId,
                                 java.lang.String pTicketId,
                                 java.lang.String pCallId,
                                 java.util.Date pStartTime,
                                 java.util.Date pEndTime)
Creates a new CallEvent

Parameters:
pActivityType - the event activity type.
pCustomerProfileId - the customer profile id to associate with the event.
pTicketId - the ticket id associated with the event
pCallId - id for call
pStartTime - call start time
pEndTime - call end time
Returns:
a new CallEvent

createCallEvent

public CallEvent createCallEvent(java.lang.String pActivityType,
                                 java.lang.String pCustomerProfileId,
                                 java.lang.String pCallId,
                                 java.util.Date pStartTime,
                                 java.util.Date pEndTime)
Creates a new CallEvent

Parameters:
pActivityType - the event activity type.
pCustomerProfileId - the customer profile id to associate with the event.
pCallId - id for call
pStartTime - call start time
pEndTime - call end time
Returns:
a new CallEvent

sendSessionEndEvent

public void sendSessionEndEvent(java.lang.String pAgentProfileId,
                                java.lang.String pParentOrganizationId,
                                java.lang.String pSessionId,
                                long pSessionCreateTime,
                                long pSessionDuration)
Sends agent session end event

Parameters:
pAgentProfileId - Agent's profile id
pParentOrganizationId - parentOrganization of the Agent. Can be null if the aganet doesn't have a parent organization
pSessionId - HTTP Session id
pSessionCreateTime - Session create time in milliseconds
pSessionDuration - HTTP Session duration in seconds

sendSessionEndEvent

public void sendSessionEndEvent(java.lang.String pAgentProfileId,
                                java.lang.String pParentOrganizationId,
                                java.lang.String pSessionId,
                                long pSessionCreateTime,
                                long pSessionDuration,
                                java.lang.String pPortName)
Sends agent session end event

Parameters:
pAgentProfileId - Agent's profile id
pParentOrganizationId - parentOrganization of the Agent. Can be null if the aganet doesn't have a parent organization
pSessionId - HTTP Session id
pSessionCreateTime - Session create time in milliseconds
pSessionDuration - HTTP Session duration in seconds
pPortName - JMS port to send the message on

sendChangePasswordEvent

public void sendChangePasswordEvent(java.lang.String pProfileId,
                                    java.lang.String pTicketId)
Sends the ChangePassword event using the JMSType defined by the changePasswordJMSType property.

Parameters:
pProfileId - the id of the customer profile
pTicketId - the id of the associated ticket

sendChangePasswordEvent

public void sendChangePasswordEvent(java.lang.String pProfileId,
                                    java.lang.String pTicketId,
                                    java.lang.String pPortName)
Sends the ChangePassword event using the JMSType defined by the changePasswordJMSType property.

Parameters:
pProfileId - the id of the new customer profile
pTicketId - the id of the associated ticket
pPortName - the port name to use for sending the event.
See Also:
AgentMessageSource.sendAgentEventMessage(AgentEvent, String, String)

sendCreateProfileEvent

public void sendCreateProfileEvent(java.lang.String pNewProfileId,
                                   java.lang.String pTicketId)
Sends the CreateProfile event using the JMSType defined by the createProfileJMSType property.

Parameters:
pNewProfileId - the id of the new customer profile
pTicketId - the id of the associated ticket

sendCreateProfileEvent

public void sendCreateProfileEvent(java.lang.String pNewProfileId,
                                   java.lang.String pTicketId,
                                   java.lang.String pPortName)
Sends the CreateProfile event using the JMSType defined by the createProfileJMSType property.

Parameters:
pNewProfileId - the id of the new customer profile
pTicketId - the id of the associated ticket
pPortName - the port name to use for sending the event.
See Also:
AgentMessageSource.sendAgentEventMessage(AgentEvent, String, String)

sendOrganizationCreatedEvent

public void sendOrganizationCreatedEvent(java.lang.String pNewOrganizationId,
                                         java.lang.String pTicketId)
Sends the OrganizationCreated event using the JMSType defined by the organizationCreatedJMSType property.

Parameters:
pNewOrganizationId - the id of the new organization
pTicketId - the id of the associated ticket

sendOrganizationCreatedEvent

public void sendOrganizationCreatedEvent(java.lang.String pNewOrganizationId,
                                         java.lang.String pTicketId,
                                         java.lang.String pPortName)
Sends the OrganizationCreated event using the JMSType defined by the organizationCreatedJMSType property.

Parameters:
pNewOrganizationId - the id of the new organization
pTicketId - the id of the associated ticket
pPortName - the port name to use for sending the event.

sendProfileRemovedFromOrgEvent

public void sendProfileRemovedFromOrgEvent(java.lang.String pRemovedProfileId,
                                           java.lang.String pOrganizationId,
                                           java.lang.String pTicketId,
                                           java.lang.String pPortName)
Sends an event that indicates a profile was removed from an organization.

It uses the JMSType defined by the profileRemovedFromOrgJMSType property.

Parameters:
pRemovedProfileId - the id of the removed customer profile
pOrganizationId - the id of the organization.
pTicketId - the id of the associated ticket
pPortName - the port name to use for sending the event.
See Also:
AgentMessageSource.sendAgentEventMessage(AgentEvent, String, String)

sendProfileAddedToOrgEvent

public void sendProfileAddedToOrgEvent(java.lang.String pAddedProfileId,
                                       java.lang.String pOrganizationId,
                                       java.lang.String pTicketId,
                                       java.lang.String pPortName)
Sends an event that indicates a profile was added to an organization.

It uses the JMSType defined by the profileAddedFromOrgJMSType property.

Parameters:
pAddedProfileId - the id of the added customer profile
pOrganizationId - the id of the organization.
pTicketId - the id of the associated ticket
pPortName - the port name to use for sending the event.
See Also:
AgentMessageSource.sendAgentEventMessage(AgentEvent, String, String)

createItemUpdateAgentEvent

public ItemUpdateAgentEvent createItemUpdateAgentEvent(java.lang.String pActivityType,
                                                       RepositoryItem pUpdatedRepositoryItem,
                                                       java.lang.String pCustomerProfileId,
                                                       java.util.Collection pPropertyUpdates,
                                                       java.lang.String pTicketId)
Creates a ItemUpdateAgentEvent.

Parameters:
pActivityType - the activity type for the update.
pUpdatedRepositoryItem - the item that was updated.
pCustomerProfileId - the customer profile id to associate with the event.
pPropertyUpdates - a collection of property updates that details the changes made in the update
pTicketId - the id of the associated ticket
Returns:
ItemUpdateAgentEvent

createProfileViewedAgentEvent

public AgentEvent createProfileViewedAgentEvent(java.lang.String pViewedCustomerProfileId)
Creates a profile viewed agent event.

Parameters:
pViewedCustomerProfileId - the profile that was viewed.
pTicketId - the id of the associated ticket
Returns:
AgentEvent

createProfileViewedAgentEvent

public AgentEvent createProfileViewedAgentEvent(java.lang.String pActivityType,
                                                java.lang.String pViewedCustomerProfileId)
Creates a profile viewed agent event.

Parameters:
pActivityType - the activity type
pViewedCustomerProfileId - the profile that was viewed.
Returns:
AgentEvent

sendNewCallEvent

public void sendNewCallEvent(java.lang.String pCustomerProfileId,
                             java.lang.String pCallId,
                             java.util.Date pStartTime,
                             java.util.Date pEndTime)
Sends the NewCall event using the JMSType defined by the newCallJMSType property.

Parameters:
pCustomerProfileId - the id of the customer profile for which the new call was started.
pCallId - id for call
pStartTime - call start time
pEndTime - call end time

sendNewCallEvent

public void sendNewCallEvent(java.lang.String pCustomerProfileId,
                             java.lang.String pPortName,
                             java.lang.String pCallId,
                             java.util.Date pStartTime,
                             java.util.Date pEndTime)
Sends the NewCall event using the JMSType defined by the newCallJMSType property.

Parameters:
pCustomerProfileId - the id of the customer profile for which the new call was started.
pPortName - the port name to use for sending the event.
pCallId - id for call
pStartTime - call start time
pEndTime - call end time
See Also:
AgentMessageSource.sendAgentEventMessage(AgentEvent, String, String)

sendEndCallEvent

public void sendEndCallEvent(java.lang.String pCustomerProfileId,
                             java.lang.String pCallId,
                             java.util.Date pStartTime,
                             java.util.Date pEndTime)
Sends the EndCall event using the JMSType defined by the endCallJMSType property.

Parameters:
pCustomerProfileId - the id of the customer profile for which the call was ended
pCallId - id for call
pStartTime - call start time
pEndTime - call end time

sendEndCallEvent

public void sendEndCallEvent(java.lang.String pCustomerProfileId,
                             java.lang.String pPortName,
                             java.lang.String pCallId,
                             java.util.Date pStartTime,
                             java.util.Date pEndTime)
Sends the EndCall event using the JMSType defined by the endCallJMSType property.

Parameters:
pCustomerProfileId - the id of the customer profile for which the call was ended
pPortName - the port name to use for sending the event.
pCallId - id for call
pStartTime - call start time
pEndTime - call end time
See Also:
AgentMessageSource.sendAgentEventMessage(AgentEvent, String, String)

sendViewProfileEvent

public void sendViewProfileEvent(java.lang.String pCustomerProfileId)
Sends the ViewProfile event using the JMSType defined by the viewProfileJMSType property.

Parameters:
pCustomerProfileId - the id of the customer whose profile was viewed

sendViewProfileEvent

public void sendViewProfileEvent(java.lang.String pCustomerProfileId,
                                 java.lang.String pPortName)
Sends the ViewProfile event using the JMSType defined by the viewProfileJMSType property.

Parameters:
pCustomerProfileId - the id of the customer whose profile was viewed
pPortName - the port name to use for sending the event.
See Also:
AgentMessageSource.sendAgentEventMessage(AgentEvent, String, String)

generateAgentEventForItemUpdate

public ItemUpdateAgentEvent generateAgentEventForItemUpdate(RepositoryItem pUpdatedItem,
                                                            RepositoryItem pCustomerProfile,
                                                            java.lang.String pActivityType,
                                                            java.util.Dictionary pNewValues,
                                                            java.lang.String pTicketId)
Generates an agent event for the updates in the values dictionary.

Parameters:
pUpdatedItem - the item being updated.
pCustomerProfile - the customer profile to associate with the new events.
pActivityType - the activity type to use in the the ItemUpdateAgentEvent.
pNewValues - a value dictionary from ProfileForm or RepositoryFormHandler.
pTicketId - the id of the associated ticket
Returns:
ItemUpdateAgentEvent
See Also:
ProfileTools.buildPropertyUpdatesForDictionary(RepositoryItem, Dictionary)

sendItemUpdateAgentEvent

public void sendItemUpdateAgentEvent(ItemUpdateAgentEvent pEvent,
                                     java.lang.String pJMSType)
Parameters:
pEvent -
pJMSType -
See Also:
sendItemUpdateAgentEvent(ItemUpdateAgentEvent, String, String)

sendItemUpdateAgentEvent

public void sendItemUpdateAgentEvent(ItemUpdateAgentEvent pEvent,
                                     java.lang.String pJMSType,
                                     java.lang.String pPortName)
Sends a ItemUpdateAgentEvent to the specified port.

Parameters:
pAgentEvent - the item update agent event
pJMSType - the jms type to use for sending the event
pPortName - the port name to use for sending the event.
See Also:
AgentMessageSource.sendAgentEventMessage(AgentEvent, String, String)