|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.nortel.soa.oi.openq.OpenQImpl
public class OpenQImpl
This service offers clients the ability to create contact center contacts that can
be queued and routed to agents with the requisite capabilities to handle these
contacts based on that contact centers routing/workflow rules.
The service allows a single user to login/logout and create, get or drop contacts.
Contacts created using this service are associated with a specific RoutePoint, the
"OpenQRoutePointAddress". This allows contacts created using this service to be reported
on separately from other contacts.
This service also supports some service provider specific notifications, which are
possible using a back to back web service model. I.e. This OpenQ service is paired
with a NotificationConsumer
service running on the client. When a client
issues a request for notifications, it provides the endpoint information
of its NotificationConsumer service implementation such that when a notification occurs, the
OpenQ service can invoke the clients NotificationConsumers notify operation.
Operations: View WSDL TODO
Field Summary | |
---|---|
static java.lang.String |
OI_OPENQ_CONTACT_TYPE
|
static java.lang.String |
OI_OPENQ_DEFAULT_OUT_OF_PROVIDER
|
static java.lang.String |
OI_OPENQ_PROVIDER_INTRINSIC_DEFAULT_VALUE
|
static java.lang.String |
OI_OPENQ_PROVIDER_NAME
|
static java.lang.String |
OI_OPENQ_ROUTEPOINT
|
static java.lang.String |
PROVIDER_INTRINSIC_KEY_VALUE
|
Constructor Summary | |
---|---|
OpenQImpl()
|
Method Summary | |
---|---|
java.lang.String |
addDefaultTreatmentListener(java.lang.String consumerEndpoint,
com.nortel.soa.oi.cct.types.SsoToken ssoToken)
Add default treatment listener |
java.lang.String |
addForceDisconnectListener(java.lang.String consumerEndpoint,
com.nortel.soa.oi.cct.types.SsoToken ssoToken)
Add force disconnect listener |
java.lang.String |
addServiceProviderStatusListener(java.lang.String consumerEndpoint,
com.nortel.soa.oi.cct.types.SsoToken ssoToken)
Add service provider status listener |
com.nortel.soa.oi.cct.types.Contact |
createContact(com.nortel.soa.oi.cct.types.Provider provider,
java.lang.String externalContactId,
Reason contactReasonCode,
Address outOfProviderAddress,
java.lang.String outOfProviderExternalId,
Reason outOfProviderReasonCode,
Address routePointAddress,
java.lang.String routePointAddressExternalId,
Reason routePointAddressReasonCode,
ContactTypeArray contactTypes,
IntrinsicArray intrinsics,
SsoToken ssoToken)
|
com.nortel.soa.oi.cct.types.Contact |
createOQContact(java.lang.String externalContactId,
java.lang.String outOfProviderAddressName,
IntrinsicArray intrinsics,
SsoToken ssoToken)
Create an OpenQ contact |
boolean |
dropContact(com.nortel.soa.oi.cct.types.Contact contact,
com.nortel.soa.oi.cct.types.SsoToken ssoToken)
|
boolean |
dropOQContact(java.lang.String externalContactId,
com.nortel.soa.oi.cct.types.SsoToken ssoToken)
Drop an OpenQ contact |
com.nortel.soa.oi.cct.types.Contact |
getContact(com.nortel.soa.oi.cct.types.Provider provider,
java.lang.String externalContactId,
SsoToken ssoToken)
|
com.nortel.soa.oi.cct.types.Contact |
getOQContact(java.lang.String externalContactId,
SsoToken ssoToken)
Get an OpenQ contact |
java.lang.String |
getVersion()
|
GetVersionResponse |
getVersion(GetVersionRequest parameters)
|
SsoToken |
logIn(AuthenticationLevel authenticationLevel)
Login to OpenQ service |
boolean |
logOff(SsoToken ssoToken)
Log off from OpenQ service |
boolean |
removeDefaultTreatmentListener(java.lang.String subscriptionRef,
com.nortel.soa.oi.cct.types.SsoToken ssoToken)
Remove default treatment listener subscription |
boolean |
removeForceDisconnectListener(java.lang.String subscriptionRef,
com.nortel.soa.oi.cct.types.SsoToken ssoToken)
Remove force disconnect listener subscription |
boolean |
removeServiceProviderStatusListener(java.lang.String subscriptionRef,
com.nortel.soa.oi.cct.types.SsoToken ssoToken)
Remove service provider status listener subscription |
java.lang.String |
subscribe(java.lang.String consumerEndpoint,
ListenersPolicyType listenerPolicy,
SsoToken ssoToken)
Subscribe for OpenQ service notifications |
boolean |
unsubscribe(java.lang.String subscriptionRef,
SsoToken ssoToken)
UnSubscribe from OpenQ service notifications |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String OI_OPENQ_PROVIDER_NAME
public static final java.lang.String OI_OPENQ_ROUTEPOINT
public static final java.lang.String OI_OPENQ_CONTACT_TYPE
public static final java.lang.String OI_OPENQ_DEFAULT_OUT_OF_PROVIDER
public static final java.lang.String PROVIDER_INTRINSIC_KEY_VALUE
public static final java.lang.String OI_OPENQ_PROVIDER_INTRINSIC_DEFAULT_VALUE
Constructor Detail |
---|
public OpenQImpl()
Method Detail |
---|
public SsoToken logIn(AuthenticationLevel authenticationLevel) throws LogInFailedFault
Operation Summary:
Log into OpenQ service with OpenQ user credentials and returns single sign on token allowing access to OpenQ services
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
{@link
- AuthenticationLevel} detailing user information
SsoToken
LogInFailedFault
public boolean logOff(SsoToken ssoToken) throws LogOffFailedFault
Operation Summary:
Log off OpenQ service
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
{@link
- SsoToken} detailing session information to log off.
LogOffFailedFault
public com.nortel.soa.oi.cct.types.Contact createContact(com.nortel.soa.oi.cct.types.Provider provider, java.lang.String externalContactId, Reason contactReasonCode, Address outOfProviderAddress, java.lang.String outOfProviderExternalId, Reason outOfProviderReasonCode, Address routePointAddress, java.lang.String routePointAddressExternalId, Reason routePointAddressReasonCode, ContactTypeArray contactTypes, IntrinsicArray intrinsics, SsoToken ssoToken) throws java.lang.Exception
java.lang.Exception
public com.nortel.soa.oi.cct.types.Contact createOQContact(java.lang.String externalContactId, java.lang.String outOfProviderAddressName, IntrinsicArray intrinsics, SsoToken ssoToken) throws CreateOQContactFailedFault
Operation Summary:
Create an OpenQ contact with contact Id and out of provider address as provided. In addition,
intrinsics in key value pairs can be provided to be associated with this contact
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
the
- String detailing the contacts external contact idthe
- String detailing the out of provider address associated with this contactan
- IntrinsicArray
detailing any key value pairs representing intrinsics associated with this contactan
- SsoToken
com.nortel.soa.oi.cct.types.Contact
representing the newly created OpenQ contact
CreateOQContactFailedFault
public boolean dropContact(com.nortel.soa.oi.cct.types.Contact contact, com.nortel.soa.oi.cct.types.SsoToken ssoToken) throws java.lang.Exception
java.lang.Exception
public boolean dropOQContact(java.lang.String externalContactId, com.nortel.soa.oi.cct.types.SsoToken ssoToken) throws DropOQContactFailedFault
Operation Summary:
Drops an OpenQ contact with contact Id equal to that of one provided
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
the
- String detailing the external contact id of the contact to dropan
- SsoToken
DropOQContactFailedFault
public com.nortel.soa.oi.cct.types.Contact getContact(com.nortel.soa.oi.cct.types.Provider provider, java.lang.String externalContactId, SsoToken ssoToken) throws java.lang.Exception
java.lang.Exception
public com.nortel.soa.oi.cct.types.Contact getOQContact(java.lang.String externalContactId, SsoToken ssoToken) throws GetOQContactFailedFault
Operation Summary:
Retreive an OpenQ contact with contact Id equal to that provided
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
the
- String detailing the contacts external contact idan
- SsoToken
com.nortel.soa.oi.cct.types.Contact
representing the OpenQ contact
GetOQContactFailedFault
public java.lang.String addServiceProviderStatusListener(java.lang.String consumerEndpoint, com.nortel.soa.oi.cct.types.SsoToken ssoToken) throws AddServiceProviderStatusListenerFailedFault
Operation Summary:
Subscribes for service provider status notifications
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
the
- String detailing the clients endpoint where the "notify" operation is hostedan
- SsoToken
AddServiceProviderStatusListenerFailedFault
public boolean removeServiceProviderStatusListener(java.lang.String subscriptionRef, com.nortel.soa.oi.cct.types.SsoToken ssoToken) throws RemoveServiceProviderStatusListenerFailedFault
Operation Summary:
Unsubscribes service provider status notifications
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
the
- String detailing the subscription to unsubscribe.an
- SsoToken
RemoveServiceProviderStatusListenerFailedFault
public java.lang.String addDefaultTreatmentListener(java.lang.String consumerEndpoint, com.nortel.soa.oi.cct.types.SsoToken ssoToken) throws AddDefaultTreatmentListenerFailedFault
Operation Summary:
Subscribes for default treatment notifications
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
the
- String detailing the clients endpoint where the "notify" operation is hostedan
- SsoToken
AddDefaultTreatmentListenerFailedFault
public boolean removeDefaultTreatmentListener(java.lang.String subscriptionRef, com.nortel.soa.oi.cct.types.SsoToken ssoToken) throws RemoveDefaultTreatmentListenerFailedFault
Operation Summary:
Unsubscribes default treatment notifications
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
the
- String detailing the subscription to unsubscribe.an
- SsoToken
RemoveDefaultTreatmentListenerFailedFault
public java.lang.String addForceDisconnectListener(java.lang.String consumerEndpoint, com.nortel.soa.oi.cct.types.SsoToken ssoToken) throws AddForceDisconnectListenerFailedFault
Operation Summary:
Subscribes for force disconnect notifications
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
the
- String detailing the clients endpoint where the "notify" operation is hostedan
- SsoToken
AddForceDisconnectListenerFailedFault
public boolean removeForceDisconnectListener(java.lang.String subscriptionRef, com.nortel.soa.oi.cct.types.SsoToken ssoToken) throws RemoveForceDisconnectListenerFailedFault
Operation Summary:
Unsubscribes force disconnect notifications
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
the
- String detailing the subscription to unsubscribe.an
- SsoToken
RemoveForceDisconnectListenerFailedFault
public java.lang.String subscribe(java.lang.String consumerEndpoint, ListenersPolicyType listenerPolicy, SsoToken ssoToken) throws SubscribeFailedFault
Operation Summary:
Subscribes for any combination for service provider status, default treatment and force disconnect notifications. This
operation offers same functionality of the other OpenQ service "Add" listener operations
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
the
- String detailing the clients endpoint where the "notify" operation is hostedan
- SsoToken
SubscribeFailedFault
addServiceProviderStatusListener
,
addDefaultTreatmentListener
,
addForceDisconnectListener
public boolean unsubscribe(java.lang.String subscriptionRef, SsoToken ssoToken) throws UnsubscribeFailedFault
Operation Summary:
Unsubscribes subscription so that notifications assocaited with that subscription are no longer received
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
the
- String detailing the subscription to unsubscribe associated notificationsan
- SsoToken
UnsubscribeFailedFault
removeServiceProviderStatusListener
,
removeDefaultTreatmentListener
,
removeForceDisconnectListener
public GetVersionResponse getVersion(GetVersionRequest parameters) throws GetVersionFault
GetVersionFault
public java.lang.String getVersion() throws GetVersionFault
GetVersionFault
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |