Platform SDK Java 8.5 API Reference

com.genesyslab.platform.commons.protocol
Interface ProtocolFactory

All Known Implementing Classes:
AbstractProtocolFactory, BasicChatInternalProtocolFactory, BasicChatProtocolFactory, CallbackInternalProtocolFactory, CallbackProtocolFactory, ChatServerDefaultProtocolFactory, ConfServerAbstractProtocolFactory, ConfServerInternalProtocolFactory, ConfServerProtocolFactory, ContactServerProtocolFactory, CustomServerInternalProtocolFactory, CustomServerProtocolFactory, EmailInternalProtocolFactory, EmailProtocolFactory, EspEmailProtocolFactory, ExternalServiceInternalProtocolFactory, ExternalServiceProtocolFactory, FlexChatInternalProtocolFactory, FlexChatProtocolFactory, InteractionServerInternalProtocolFactory, InteractionServerProtocolFactory, LocalControlAgentHeartbeatInternalProtocolFactory, LocalControlAgentHeartbeatProtocolFactory, LocalControlAgentInternalProtocolFactory, LocalControlAgentProtocolFactory, MessageServerCustomInternalProtocolFactory, MessageServerInternalProtocolFactory, MessageServerProtocolFactory, OutboundServerInternalProtocolFactory, OutboundServerProtocolFactory, RoutingServerInternalProtocolFactory, RoutingServerProtocolFactory, SolutionControlServerInternalProtocolFactory, SolutionControlServerProtocolFactory, StatServerInternalProtocolFactory, StatServerProtocolFactory, TServerInternalProtocolFactory, TServerProtocolFactory

public interface ProtocolFactory


Nested Class Summary
static class ProtocolFactory.MessageVerificationReason
          Describes possible reasons of verification.
static interface ProtocolFactory.MessageVerificationSupport
          Verifies message to use it.
 
Method Summary
 Message createMessage(int id)
          Creates Message by id.
 Message createMessage(int id, java.lang.String name)
          Creates Message by id.
 java.lang.String getMessageName(int id)
          Returns message name by its id.
 java.lang.Object getProtocolData()
          Gets some specific data related to given protocol (for internal use only).
 ProtocolDescription getProtocolDescription()
          Returns protocol description in format <Category>.<Name>
 java.lang.String getProtocolVersion()
          Returns protocol version.
 void setProtocolData(java.lang.Object value)
          Sets some specific data related to given protocol (for internal use only).
 

Method Detail

createMessage

Message createMessage(int id)
Creates Message by id.
NOTE: Classes that implement this interface are usually created automatically by generator. Do not implement this interface unless you know what you're doing.

Parameters:
id - id of the message
Returns:
Message subclass for the specified id.
Throws:
java.lang.IllegalArgumentException - if message with such id can't be created

createMessage

Message createMessage(int id,
                      java.lang.String name)
Creates Message by id.
NOTE: Classes that implement this interface are usually created automatically by generator. Do not implement this interface unless you know what you're doing.

Parameters:
id - id of the message
Returns:
Message subclass for the specified id.
Throws:
java.lang.IllegalArgumentException - if message with such id can't be created

getMessageName

java.lang.String getMessageName(int id)
Returns message name by its id.

Parameters:
id - message id
Returns:
message name

getProtocolDescription

ProtocolDescription getProtocolDescription()
Returns protocol description in format <Category>.<Name>

Returns:
protocol category and name

getProtocolVersion

java.lang.String getProtocolVersion()
Returns protocol version.

Returns:
protocol version

getProtocolData

java.lang.Object getProtocolData()
Gets some specific data related to given protocol (for internal use only).

Returns:
protocol data

setProtocolData

void setProtocolData(java.lang.Object value)
Sets some specific data related to given protocol (for internal use only).

Parameters:
value - protocol data

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.