Package co.ecg.alpaca.toolkit.generated

Class RoutePoint

java.lang.Object

co.ecg.alpaca.toolkit.model.BroadWorksObject

co.ecg.alpaca.toolkit.model.BroadWorksUser

co.ecg.alpaca.toolkit.generated.RoutePoint

All Implemented Interfaces:

Serializable

public class RoutePoint
extends BroadWorksUser

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RoutePoint.GroupRoutePointAddDNISRequest	Add a Route Point DNIS.
static class	RoutePoint.GroupRoutePointAddInstanceRequest	Add a Route Point instance to a group.
static class	RoutePoint.GroupRoutePointBouncedCallGetRequest	Get a route point's bounced call settings.
static class	RoutePoint.GroupRoutePointBouncedCallGetResponse	Response to the GroupRoutePointBouncedCallGetRequest.
static class	RoutePoint.GroupRoutePointBouncedCallModifyRequest	Modify a route point's bounced call settings.
static class	RoutePoint.GroupRoutePointDeleteDNISRequest	Delete a route point's DNIS.
static class	RoutePoint.GroupRoutePointDeleteInstanceRequest	Delete a Route Point instance from a group.
static class	RoutePoint.GroupRoutePointDistinctiveRingingGetRequest	Get the distinctive ringing configuration values for route point.
static class	RoutePoint.GroupRoutePointDistinctiveRingingGetResponse	Response to the GroupRoutePointDistinctiveRingingGetRequest.
static class	RoutePoint.GroupRoutePointDistinctiveRingingModifyRequest	Modify the distinctive ringing configuration values for route point.
static class	RoutePoint.GroupRoutePointForcedForwardingGetRequest	Get a route point's forced forwarding settings.
static class	RoutePoint.GroupRoutePointForcedForwardingGetResponse	Response to the GroupRoutePointForcedForwardingGetRequest20.
static class	RoutePoint.GroupRoutePointForcedForwardingModifyRequest	Modify a route point's forced forwarding settings.
static class	RoutePoint.GroupRoutePointGetAnnouncementRequest	Get a route point's announcement settings.
static class	RoutePoint.GroupRoutePointGetAnnouncementResponse	Response to the GroupRoutePointGetAnnouncementRequest20.
static class	RoutePoint.GroupRoutePointGetDNISAgentListRequest	Get a list of agent who selected the DNIS as the outgoing call.
static class	RoutePoint.GroupRoutePointGetDNISAgentListResponse	Response to the GroupRoutePointGetDNISAgentListRequest.
static class	RoutePoint.GroupRoutePointGetDNISAnnouncementRequest	Get a route point's DNIS Announcements The response is either a GroupRoutePointGetDNISAnnouncementResponse20 or an ErrorResponse.
static class	RoutePoint.GroupRoutePointGetDNISAnnouncementResponse	Response to the GroupRoutePointGetDNISAnnouncementRequest20.
static class	RoutePoint.GroupRoutePointGetDNISListRequest	Get a list of DNIS that are configured for a Route Point.
static class	RoutePoint.GroupRoutePointGetDNISListResponse	Response to the GroupRoutePointGetDNISListRequest.
static class	RoutePoint.GroupRoutePointGetDNISRequest	Get a route point's DNIS.
static class	RoutePoint.GroupRoutePointGetDNISResponse	Response to the GroupRoutePointGetDNISRequest.
static class	RoutePoint.GroupRoutePointGetFailoverPolicyRequest	Get the route point failover policy.
static class	RoutePoint.GroupRoutePointGetFailoverPolicyResponse	Response to the GroupRoutePointGetFailoverPolicyRequest.
static class	RoutePoint.GroupRoutePointGetInstanceListRequest	Get a list of Route Point instances within a group.
static class	RoutePoint.GroupRoutePointGetInstanceListResponse	Response to the GroupRoutePointGetInstanceListRequest.
static class	RoutePoint.GroupRoutePointGetInstanceRequest	Request to get all the information of a Route Point instance.
static class	RoutePoint.GroupRoutePointGetInstanceResponse	Response to GroupRoutePointGetInstanceRequest22.
static class	RoutePoint.GroupRoutePointHolidayServiceGetRequest	Get a route point's holiday service settings.
static class	RoutePoint.GroupRoutePointHolidayServiceGetResponse	Response to the GroupRoutePointHolidayServiceGetRequest20.
static class	RoutePoint.GroupRoutePointHolidayServiceModifyRequest	Modify a route point's holiday service settings.
static class	RoutePoint.GroupRoutePointManualFailoverRequest	Initiate manual failover for the Route Point.
static class	RoutePoint.GroupRoutePointModifyActiveInstanceListRequest	Request to set the active status of Route Point instances.
static class	RoutePoint.GroupRoutePointModifyAnnouncementRequest	Modify a route point's announcement settings.
static class	RoutePoint.GroupRoutePointModifyDNISAnnouncementRequest	Modify a route point DNIS announcement settings.
static class	RoutePoint.GroupRoutePointModifyDNISParametersRequest	Modify the setting that are configured for all the DNIS in a Route Point.
static class	RoutePoint.GroupRoutePointModifyDNISRequest	Modify a route point's DNIS settings.
static class	RoutePoint.GroupRoutePointModifyFailoverPolicyRequest	Modify the route point failover policy.
static class	RoutePoint.GroupRoutePointModifyInstanceRequest	Request to modify a Route Point instance.
static class	RoutePoint.GroupRoutePointNightServiceGetRequest	Get a route point's night service settings.
static class	RoutePoint.GroupRoutePointNightServiceGetResponse	Response to the GroupRoutePointNightServiceGetRequest20.
static class	RoutePoint.GroupRoutePointNightServiceModifyRequest	Modify a route point's night service settings.
static class	RoutePoint.GroupRoutePointOverflowGetRequest	Get a route point's overflow settings.
static class	RoutePoint.GroupRoutePointOverflowGetResponse	Response to the GroupRoutePointOverflowGetRequest20.
static class	RoutePoint.GroupRoutePointOverflowModifyRequest	Modify a route point's overflow settings.
static class	RoutePoint.GroupRoutePointQueueCallDispositionCodeAddRequest	Add a Route Point Call Disposition Code.
static class	RoutePoint.GroupRoutePointQueueCallDispositionCodeDeleteRequest	Delete a Route Point Call Disposition Code.
static class	RoutePoint.GroupRoutePointQueueCallDispositionCodeGetListRequest	Get the list of Route Point Level and Organization Level Call Disposition Codes.
static class	RoutePoint.GroupRoutePointQueueCallDispositionCodeGetListResponse	Response to the GroupRoutePointQueueCallDispositionCodeGetListRequest.
static class	RoutePoint.GroupRoutePointQueueCallDispositionCodeGetRequest	Get a Route Point Call Disposition Code.
static class	RoutePoint.GroupRoutePointQueueCallDispositionCodeGetResponse	Response to the GroupRoutePointQueueCallDispositionCodeGetRequest
static class	RoutePoint.GroupRoutePointQueueCallDispositionCodeModifyRequest	Modify a Route Point Call Disposition Code.
static class	RoutePoint.GroupRoutePointQueueCallDispositionCodeSettingsGetRequest	Request the queue level data associated with Route Point Call Disposition Code Settings.
static class	RoutePoint.GroupRoutePointQueueCallDispositionCodeSettingsGetResponse	Response to GroupRoutePointQueueCallDispositionCodeSettingsGetRequest.
static class	RoutePoint.GroupRoutePointQueueCallDispositionCodeSettingsModifyRequest	Modify the queue level data associated with Route Point Agents Unavailable Code Settings.
static class	RoutePoint.UserRoutePointCallDispositionCodeGetAvailableListRequest	Get the list of available Route Point Call Disposition Codes to be used by a client.
static class	RoutePoint.UserRoutePointCallDispositionCodeGetAvailableListResponse	Response to the UserRoutePointCallDispositionCodeGetAvailableListRequest.
static class	RoutePoint.UserRoutePointSupervisorGetListRequest	Get a list of Route Point supervisors assigned to a user.
static class	RoutePoint.UserRoutePointSupervisorGetListResponse	Response to the UserRoutePointSupervisorGetListRequest.
static class	RoutePoint.UserRoutePointSupervisorModifyListRequest	Request to modify the Route Point supervisor list for a user.

Field Summary

Fields

Modifier and Type	Field	Description
protected AgentACDAutomaticState	agentStateAfterCall
protected String	agentUnavailableCode
protected Boolean	enableAutomaticStateChangeForAgents
protected Boolean	enableVideo
protected AudioFileCodec22	externalPreferredAudioCodec
protected Boolean	forceDeliveryOfCalls
protected Integer	forceDeliveryWaitTimeSeconds
protected AudioFileCodec22	internalPreferredAudioCodec
protected String	networkClassOfService
protected Integer	noAnswerTimeoutRings
protected Boolean	overrideAgentWrapUpTime
protected Boolean	playRingingWhenOfferingCall
protected Integer	queueLength
protected ServiceInstanceReadProfile19sp1	serviceInstanceProfile
protected Integer	wrapUpSeconds

Fields inherited from class co.ecg.alpaca.toolkit.model.BroadWorksUser

group, groupId, serviceProvider, serviceProviderId, userId

Fields inherited from class co.ecg.alpaca.toolkit.model.BroadWorksObject

broadWorksServer, populated

Constructor Summary

Constructors

Constructor	Description
RoutePoint()	Serializable Constructor
RoutePoint(Group group, String userId)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
AgentACDAutomaticState	getAgentStateAfterCall()
String	getAgentUnavailableCode()
String	getClassName()
Boolean	getEnableAutomaticStateChangeForAgents()
Boolean	getEnableVideo()
AudioFileCodec22	getExternalPreferredAudioCodec()
Boolean	getForceDeliveryOfCalls()
Integer	getForceDeliveryWaitTimeSeconds()
AudioFileCodec22	getInternalPreferredAudioCodec()
String	getNetworkClassOfService()
Integer	getNoAnswerTimeoutRings()
Boolean	getOverrideAgentWrapUpTime()
Boolean	getPlayRingingWhenOfferingCall()
static RoutePoint	getPopulatedRoutePoint(Group group, String userId)	Retrieves a populated RoutePoint
Integer	getQueueLength()
ServiceInstanceReadProfile19sp1	getServiceInstanceProfile()
Integer	getWrapUpSeconds()
int	hashCode()
Response	populate()	Method to populate the Fields of the Object via the Associated BroadWorks request
Response	populate(RoutePoint.GroupRoutePointGetInstanceResponse resp)	Method to populate the Fields of the Object via the Associated BroadWorks request
RoutePoint	setAgentStateAfterCall(AgentACDAutomaticState agentStateAfterCall)
RoutePoint	setAgentUnavailableCode(String agentUnavailableCode)
RoutePoint	setEnableAutomaticStateChangeForAgents(Boolean enableAutomaticStateChangeForAgents)
RoutePoint	setEnableVideo(Boolean enableVideo)
RoutePoint	setExternalPreferredAudioCodec(AudioFileCodec22 externalPreferredAudioCodec)
RoutePoint	setForceDeliveryOfCalls(Boolean forceDeliveryOfCalls)
RoutePoint	setForceDeliveryWaitTimeSeconds(Integer forceDeliveryWaitTimeSeconds)
RoutePoint	setInternalPreferredAudioCodec(AudioFileCodec22 internalPreferredAudioCodec)
RoutePoint	setNetworkClassOfService(String networkClassOfService)
RoutePoint	setNoAnswerTimeoutRings(Integer noAnswerTimeoutRings)
RoutePoint	setOverrideAgentWrapUpTime(Boolean overrideAgentWrapUpTime)
RoutePoint	setPlayRingingWhenOfferingCall(Boolean playRingingWhenOfferingCall)
RoutePoint	setQueueLength(Integer queueLength)
RoutePoint	setServiceInstanceProfile(ServiceInstanceReadProfile19sp1 serviceInstanceProfile)
RoutePoint	setWrapUpSeconds(Integer wrapUpSeconds)
String	toString()

Methods inherited from class co.ecg.alpaca.toolkit.model.BroadWorksUser

getGroup, getGroupId, getServiceProvider, getServiceProviderId, getUserId, getUserId, setGroupId, setServiceProviderId, setUserId

Methods inherited from class co.ecg.alpaca.toolkit.model.BroadWorksObject

getBroadWorksServer, hasPopulated, isPopulated, setBroadWorksServer, setPopulated

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

serviceInstanceProfile

protected ServiceInstanceReadProfile19sp1 serviceInstanceProfile

networkClassOfService

protected String networkClassOfService

externalPreferredAudioCodec

protected AudioFileCodec22 externalPreferredAudioCodec

internalPreferredAudioCodec

protected AudioFileCodec22 internalPreferredAudioCodec

queueLength

protected Integer queueLength

noAnswerTimeoutRings

protected Integer noAnswerTimeoutRings

enableVideo

protected Boolean enableVideo

playRingingWhenOfferingCall

protected Boolean playRingingWhenOfferingCall

overrideAgentWrapUpTime

protected Boolean overrideAgentWrapUpTime

wrapUpSeconds

protected Integer wrapUpSeconds

enableAutomaticStateChangeForAgents

protected Boolean enableAutomaticStateChangeForAgents

agentStateAfterCall

protected AgentACDAutomaticState agentStateAfterCall

agentUnavailableCode

protected String agentUnavailableCode

forceDeliveryOfCalls

protected Boolean forceDeliveryOfCalls

forceDeliveryWaitTimeSeconds

protected Integer forceDeliveryWaitTimeSeconds

Constructor Details

RoutePoint

public RoutePoint()

Serializable Constructor

RoutePoint

public RoutePoint(Group group,
 String userId)

Parameters:

group - The Group

userId - The user id

Method Details

getPopulatedRoutePoint

public static RoutePoint getPopulatedRoutePoint(Group group,
 String userId)
                                         throws BroadWorksObjectException

Retrieves a populated RoutePoint

Parameters:

group - The Group

userId - The user id

Throws:

BroadWorksObjectException - Thrown if the object cannot be retrieved.

getClassName

public String getClassName()

setServiceInstanceProfile

public RoutePoint setServiceInstanceProfile(ServiceInstanceReadProfile19sp1 serviceInstanceProfile)

getServiceInstanceProfile

public ServiceInstanceReadProfile19sp1 getServiceInstanceProfile()

setNetworkClassOfService

public RoutePoint setNetworkClassOfService(String networkClassOfService)

getNetworkClassOfService

public String getNetworkClassOfService()

setExternalPreferredAudioCodec

public RoutePoint setExternalPreferredAudioCodec(AudioFileCodec22 externalPreferredAudioCodec)

getExternalPreferredAudioCodec

public AudioFileCodec22 getExternalPreferredAudioCodec()

setInternalPreferredAudioCodec

public RoutePoint setInternalPreferredAudioCodec(AudioFileCodec22 internalPreferredAudioCodec)

getInternalPreferredAudioCodec

public AudioFileCodec22 getInternalPreferredAudioCodec()

setQueueLength

public RoutePoint setQueueLength(Integer queueLength)

getQueueLength

public Integer getQueueLength()

setNoAnswerTimeoutRings

public RoutePoint setNoAnswerTimeoutRings(Integer noAnswerTimeoutRings)

getNoAnswerTimeoutRings

public Integer getNoAnswerTimeoutRings()

setEnableVideo

public RoutePoint setEnableVideo(Boolean enableVideo)

getEnableVideo

public Boolean getEnableVideo()

setPlayRingingWhenOfferingCall

public RoutePoint setPlayRingingWhenOfferingCall(Boolean playRingingWhenOfferingCall)

getPlayRingingWhenOfferingCall

public Boolean getPlayRingingWhenOfferingCall()

setOverrideAgentWrapUpTime

public RoutePoint setOverrideAgentWrapUpTime(Boolean overrideAgentWrapUpTime)

getOverrideAgentWrapUpTime

public Boolean getOverrideAgentWrapUpTime()

setWrapUpSeconds

public RoutePoint setWrapUpSeconds(Integer wrapUpSeconds)

getWrapUpSeconds

public Integer getWrapUpSeconds()

setEnableAutomaticStateChangeForAgents

public RoutePoint setEnableAutomaticStateChangeForAgents(Boolean enableAutomaticStateChangeForAgents)

getEnableAutomaticStateChangeForAgents

public Boolean getEnableAutomaticStateChangeForAgents()

setAgentStateAfterCall

public RoutePoint setAgentStateAfterCall(AgentACDAutomaticState agentStateAfterCall)

getAgentStateAfterCall

public AgentACDAutomaticState getAgentStateAfterCall()

setAgentUnavailableCode

public RoutePoint setAgentUnavailableCode(String agentUnavailableCode)

getAgentUnavailableCode

public String getAgentUnavailableCode()

setForceDeliveryOfCalls

public RoutePoint setForceDeliveryOfCalls(Boolean forceDeliveryOfCalls)

getForceDeliveryOfCalls

public Boolean getForceDeliveryOfCalls()

setForceDeliveryWaitTimeSeconds

public RoutePoint setForceDeliveryWaitTimeSeconds(Integer forceDeliveryWaitTimeSeconds)

getForceDeliveryWaitTimeSeconds

public Integer getForceDeliveryWaitTimeSeconds()

populate

public Response populate()

Method to populate the Fields of the Object via the Associated BroadWorks request

Specified by:

populate in class BroadWorksObject

populate

public Response populate(RoutePoint.GroupRoutePointGetInstanceResponse resp)

Method to populate the Fields of the Object via the Associated BroadWorks request

Parameters:

resp - The response object to perform population

equals

public boolean equals(Object obj)

Overrides:

equals in class BroadWorksUser

hashCode

public int hashCode()

Overrides:

hashCode in class BroadWorksUser

toString

public String toString()

Overrides:

toString in class Object