Configuration Platform SDK 7.6 API Reference

com.genesyslab.platform.commons.protocol
Interface ProtocolFactory

All Known Implementing Classes:
AbstractProtocolFactory

public interface ProtocolFactory


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)
          Return message name by it's id.
 ProtocolDescription getProtocolDescription()
          Return protocol description in format .
 java.lang.String getProtocolVersion()
          Return protocol version.
 

Method Detail

createMessage

public 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

public 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

public java.lang.String getMessageName(int id)
Return message name by it's id.

Parameters:
id - message id
Returns:
message name

getProtocolDescription

public ProtocolDescription getProtocolDescription()
Return protocol description in format .

Returns:
protocol category and name

getProtocolVersion

public java.lang.String getProtocolVersion()
Return protocol version.

Returns:
protocol version

Configuration Platform SDK 7.6 API Reference

Send comments on this topic.
Copyright © 2006–2008 Genesys Telecommunication Laboratories, Inc. All rights reserved.